RELEASE_NOTES.txt0100664 0000000 0000000 00000466664 15064564356 012444 0ustar000000000 0000000 Release 5.5.1 ------------------ This is a maintenance release that fixes several defects in the connection management code and a regression in the DIGEST authentication reported since the previous release. It also upgrades HttpCore to version 5.3.6. Change Log ------------------- * HTTPCLIENT-2391: Improved GRACEGUL shutdown of ExecutorService used internally by async clients. Contributed by Oleg Kalnichevski * Bug fix: Use a 1 second timeout when closing out connections inside a connection pool lock. Contributed by Oleg Kalnichevski * Clarified the behavior of the protocol-level responseTimeout and the connection management level socketTimeout and their interrelation. Contributed by ChangYong * Bug fix: Connection managers to ensure open connections have a socket timeout set based on ConnectionConfig upon lease. Contributed by Oleg Kalnichevski * HTTPCLIENT-2393: Remove `rspauth` attribute from `Authorization` DIGEST header (#716) RFC 7616 compliance: rspauth is server-side (Authentication-Info 3.5) only. Contributed by Arturo Bernal * HTTPCLIENT-2386: Classic transport to use the connect timeout as a default if the TLS timeout has not been explicitly set. Contributed by Oleg Kalnichevski * HTTPCLIENT-2384: Socket options related to TcpKeepAlive are ignored. Contributed by Oleg Kalnichevski * HTTPCLIENT-2371: Logging of request re-execution at INFO priority. Contributed by Oleg Kalnichevski * HTTPCLIENT-2379: Fixed a defect in H2SharingConnPool causing an IllegalStateException when releasing the same connection from multiple threads. (#663) Contributed by Arturo Bernal * Fixed the behavior of the `validateAfterInactivity` connection setting by the async connection manager. Contributed by Ryan Schmitt * HTTPCLIENT-2376: Fixed the problem with ContentCompressionExec not taking `acceptEncoding` parameter into account. Contributed by Oleg Kalnichevski * HTTPCLIENT-2372: Normalize HttpHost port comparison to treat implicit default ports as equal (#643). Contributed by Arturo Bernal * Maven wrapper Contributed by Ryan Schmitt * Bump org.junit:junit-bom from 5.12.2 to 5.13.0 #639. Contributed by Gary Gregory * Bump testcontainers.version from 1.20.6 to 1.21.1 #638. Contributed by Gary Gregory Release 5.5 ------------------ This is the first GA release in the 5.5 release series. This release finalizes the 5.5 APIs and adds several experimental features and improvements, such as request multiplexing over a shared HTTP/2 connection and the Classic API facade acting as a compatibility bridge between classic I/O client services and the asynchronous message transport used internally. Notable changes and features included in the 5.5 series: * Improved conformance to RFC 7616 (HTTP Digest Access Authentication). * The connection pool implementation acts as a caching facade in front of a standard managed connection pool and shares already leased connections to multiplex message exchanges over active HTTP/2 connections. Experimental. * Extended Auth API and improved authentication protocol logic to support mutual authentication. * The Classic API facade now acts as a compatibility bridge between the classic I/O client services (based on the standard InputStream / OutputStream model) and the asynchronous message transport used internally. This is experimental. * HTTP/2 support for the Fluent Facade (via Classic API facade). This is experimental. Compatibility notes: * As of this release, HttpClient does not automatically execute redirects if the original request manually added headers that are considered sensitive. Change Log ------------------- * HTTPCLIENT-2367: Fixed NPE in InternalAbstractHttpAsyncClient by adding a null check for resolvedTarget (#634). Contributed by Arturo Bernal * Fixed case of Cookie#HTTP_ONLY_ATTR Contributed by Finn Petersen * Simplified ProtocolSwitchStrategy by leveraging ProtocolVersionParser (#627). Contributed by Arturo Bernal * HTTPCLIENT-2364: Fixed incorrect re-binding of the upgraded SSL socket to the HTTP connection by the #upgrade method of the DefaultHttpClientConnectionOperator. Contributed by Oleg Kalnichevski * HTTPCLIENT-2363: ensure requests have a scheme and an authority populated before they get committed to the execution pipeline. Contributed by Oleg Kalnichevski * Upgraded HttpCore to version 5.3.4 Contributed by Oleg Kalnichevski * Disallow automatic request redirection if the original request contains potentially sensitive headers. Contributed by Oleg Kalnichevski * HTTPCLIENT-2360: Enhance filename encoding in multipart/form-data per RFC 6266/5987 (#618). Contributed by Oleg Kalnichevski * Corrected APIs in ClientTlsStrategyBuilder to be compatible with Classic APIs. Contributed by Oleg Kalnichevski * Bump testcontainers.version from 1.20.4 to 1.20.6 #622. Contributed by Gary Gregory * Bump org.junit:junit-bom from 5.11.4 to 5.12.2 #623, #632. Contributed by Gary Gregory * Bump log4j.version from 2.23.1 to 2.24.3 #626. Contributed by Gary Gregory Release 5.5 ALPHA1 ------------------ This is the first ALPHA release in the 5.5 release series. It adds several experimental features and improvements such as request multiplexing over a shared HTTP/2 connection and the Classic API facade acting as a compatibility bridge between classic I/O client services and the asynchronous message transport used internally. Notable changes and features included in the 5.5 series: * Improved conformance to RFC 7616 (HTTP Digest Access Authentication). * The connection pool implementation acts as a caching facade in front of a standard managed connection pool and shares already leased connections to multiplex message exchanges over active HTTP/2 connections. Experimental. * Extended Auth API and improved authentication protocol logic to support mutual authentication. * The Classic API facade acting as a compatibility bridge between the classic I/O client services (based on the standard InputStream / OutputStream model) and the asynchronous message transport used internally. Experimental. * HTTP/2 support for the Fluent Facade (via Classic API facade). Experimental. Change Log ------------------- * Async transport can now be used internally by the Fluent Facade. Contributed by Oleg Kalnichevski * Classic over async bridge. Contributed by Oleg Kalnichevski * HTTPCLIENT-2356: Extended Auth APIs and authentication protocol logic to support mutual authentication. Contributed by Istvan Toth * Decode Subject Alternative Names for IP, DNS, and binary data (#610). Contributed by Arturo Bernal * Do not add `Upgrade` header if `Connection` header is already present (the caller manually manages connection state). Contributed by Oleg Kalnichevski * Avoid logging the HTTP message version where it can be a hint, not a protocol version. Contributed by Oleg Kalnichevski * Experimental connections pool implementation that acts as a caching facade in front of a standard ManagedConnPool and shares already leased connections to multiplex message exchanges over active HTTP/2 connections. Contributed by Oleg Kalnichevski * HTTPCLIENT-2350 - Refactored the connect method in DefaultHttpClientConnectionOperator to enhance flexibility in address resolution, specifically allowing for direct handling of unresolved addresses (#598). Contributed by Arturo Bernal * Enhanced DigestScheme for RFC 7616 Compliance and Expanded Hash Algorithm Support (#597). Contributed by Arturo Bernal * Added request interceptor to check the `Authentication-Info` header in HTTP Digest Access Authentication (#596). Contributed by Arturo Bernal * Added client-side `rspauth` value for Digest auth, verifying server knowledge of shared secret per RFC 7616. (#594). Contributed by Arturo Bernal * Corrected method chaining in ClientTlsStrategyBuilder. Contributed by Osip Fatkullin * HTTPCLIENT-2337: Sanitize X500Principal Logging in ClientTlsStrategy classes (#581). Contributed by Arturo Bernal Release 5.4 ------------------ This is the first GA release in the 5.4 release series. This release finalizes the 5.4 APIs, upgrades HttpCore to version 5.3 and improves the Public Suffix matching algorithm implementation. IMPORTANT! The new cache entry serialization format is incompatible with earlier versions of HttpClient Cache. Persistent caches (file system based, Memcached, EhCAche with object serialization) created with any earlier version MUST be flushed and re-populated or the cache backend MUST be configured to use the old, deprecated cache entry serializer. Notable changes and features included in the 5.4 series: * Improved conformance to RFC 9110 (HTTP Semantics), RFC 7616 (HTTP Digest Access Authentication), RFC 2617 (’Basic’ HTTP Authentication Scheme). * UTF-8 encoding is used by default for text where appropriate. * Compatibility with Java Virtual Threads and Java 21 Runtime. * Redesign and rewrite of the HTTP caching protocol layer for better efficiency and improved conformance to RFC 9111 (HTTP Caching). * Cache control and context APIs. * ETag APIs. * TLS SNI and endpoint identification improvements. * Support for RFC 2817 (Upgrading to TLS Within HTTP/1.1). * Auth cache no longer makes use of Java serialization. * Deprecation of ConnectionSocketFactory and LayeredConnectionSocketFactory. * HttpContext optimization and performance improvement. * Async cache is no longer considered experimental. Change Log ------------------- * HTTPCLIENT-2338: Put compress exec interceptor after retry exec interceptor. Contributed by Oleg Kalnichevski * Upgraded HttpCore to version 5.3. Contributed by Oleg Kalnichevski * Javadoc improvements. Contributed by Gary Gregory * DeflateInputStream extends FilterInputStream Contributed by Gary Gregory * HTTPCLIENT-2335: Added close() method with CloseMode parameter to CloseableHttpResponse. Contributed by Oleg Kalnichevski * HTTPCLIENT-2336: Corrected hostname identity verification logic. Contributed by Oleg Kalnichevski * HTTPCLIENT-2336: Updated PublicSuffixMatcher to use the 'formal algorithm' as specified https://github.com/publicsuffix/list/wiki/Format#formal-algorithm. Contributed by Adrian Woodhead * Input streams returned by DecompressingEntity#getContent to support mark(int) and reset() if the underlying stream does. Contributed by Gary Gregory * Improved FQDN matching. Contributed by Oleg Kalnichevski * Removed @Experimental from async cache classes. Contributed by Oleg Kalnichevski * HTTPCLIENT-2333: Update execution scope upon request redirect to avoid re-execution of the original request in case of an I/O error. Contributed by Oleg Kalnichevski * Re-introduced LaxRedirectStrategy from 4.x Contributed by Otavio Prado Release 5.4 BETA1 ------------------ This is the first BETA release in the 5.4 release series. It upgrades HttpCore to version 5.3-beta1 and adds a few minor improvements and fixes. Change Log ------------------- * HTTPCLIENT-2328: Blocking I/O connections to check if the opposite TLS endpoint has been closed by the opposite endpoint while writing out request body. Contributed by Oleg Kalnichevski * Redesign of test server APIs and integration test setup. Contributed by Oleg Kalnichevski * HTTPCLIENT-2331: Skip cookie header generation if a Cookie header is already present (#561). Contributed by Arturo Bernal * HTTPCLIENT-2326: Propagate original proxy response to the caller in case of HTTP CONNECT request failure. Contributed by Oleg Kalnichevski * HTTPCLIENT-2327: Propagate CancellationExceptions from MemcachedClient operations as ResourceIOExceptions (#559). Contributed by jattisha * Callbacks for Connection initialization. Contributed by Richard Tippl * HTTPCLIENT-2325 Avoid adding "; charset=" for multipart/form-data requests Contributed by Vladimir Sitnikov Release 5.4 ALPHA2 ------------------ This is the second and likely the last ALPHA release in the 5.3 release series. It finalizes the new Cache API introduced in the previous ALPHA release and also improves TLS customization for the classic transport, SNI and endpoint identification support, authentication data caching, and HTTP context performance. It also introduces support for optional TLS upgrades for HTTP/1.1 connections. Change Log ------------------- * HttpClientContext to use instance variables for standard attributes. Contributed by Oleg Kalnichevski * HTTPCLIENT-2151: Support for JSSE in-built endpoint identification. Contributed by Oleg Kalnichevski * Internal connection operators to make use of the target name from the request URI authority. Contributed by Oleg Kalnichevski * DefaultRoutePlanner to take the request authority into account when determining a route for HTTPS requests. Contributed by Oleg Kalnichevski * RouteInfo and HttpRoute to include the target name from the URI authority in case it differs from the target host (the host recognizes multiple authorities). Contributed by Oleg Kalnichevski * HTTPCLIENT-2316: BasicHttpClientConnectionManager incorrectly re-uses the released connection if it has been closed out by the protocol handler. Contributed by Oleg Kalnichevski * HTTPCLIENT-2070: Auth cache to no longer rely on Java serialization for auth state caching. Contributed by Oleg Kalnichevski * HTTPCLIENT-751: Support for RFC 2817 (Upgrading to TLS Within HTTP/1.1). Contributed by Oleg Kalnichevski * Connection endpoints to provide TLS details and protocol version. Contributed by Oleg Kalnichevski * Deprecated ConnectionSocketFactory, LayeredConnectionSocketFactory, and their plain and SSL implementations in favor of DefaultClientTlsStrategy. Contributed by Oleg Kalnichevski * Standard client TLS strategy implementations support the upgrading of blocking sockets. Contributed by Oleg Kalnichevski * FileResourceFactory to generate stable file names for the same request ID and entity tag. Contributed by Oleg Kalnichevski * Cache ResourceFactory to make use of strong eTags when available. Contributed by Oleg Kalnichevski * ETag APIs. Contributed by Oleg Kalnichevski * Fixed a design mistake of ConnectionEndpoint having a direct dependency on HttpRequestExecutor class. Contributed by Oleg Kalnichevski * Cache control and context APIs. Contributed by Oleg Kalnichevski * HTTPCLIENT-2315: Client builders fail to apply system properties to the default connection manager. Contributed by Oleg Kalnichevski * HTTPCLIENT-2314: Handle gracefully a failure of DnsResolver to return a list of resolved addresses (#533). Contributed by Philip Helger * HTTPCLIENT-2314: Throw ConnectionShutdownException in case of pooled connection having been closed or discarded instead of plain IllegalStateException. Contributed by Oleg Kalnichevski Release 5.4 ALPHA1 ------------------- This is the first ALPHA release in the 5.4 release series that improves HTTP protocol support by ensuring conformance to the latest HTTP specification (RFC 9110, RFC 9111, RFC 7616, RFC 7617), ensures compatibility with Java Virtual Threads by replacing 'synchronized' keywords in critical sections with Java lock primitives. The HTTP caching protocol layer has also been redesigned and overhauled to improve cache efficiency and optimize performance. Change Log ------------------- * `username*` validation and decoding in DigestScheme as per RFC (#511). Contributed by Arturo Bernal * Support for Userhash parameter in Digest authentication as per RFC 7616 (#509). Contributed by Arturo Bernal * Enforce UTF-8 encoding in Digest authentication according to RFC 7616 (#508). Contributed by Arturo Bernal * Enforce UTF-8 encoding in BasicSchemeFactory as per RFC 7617 (#506). Contributed by Arturo Bernal * Stricter password validation in BasicScheme (#505). Contributed by Arturo Bernal * Bug fix: When validating a cache entry the protocol handlers must use the current request message with additional headers generated by the previous request interceptors instead of the original request message. Contributed by Oleg Kalnichevski * Better debug logging in the caching protocol handlers. Contributed by Oleg Kalnichevski * Better HTTP execution context management by caching protocol handlers. Contributed by Oleg Kalnichevski * HTTPCLIENT-2301. Fixed a concurrency defect in the connection release code of BasicHttpClientConnectionManager. Contributed by Arturo Bernal * HttpCacheEntry to cache parsed DATE, EXPIRES, and LAST_MODIFIED values; avoid parsing DATE header of cache entries and HTTP messages multiple times. Contributed by Oleg Kalnichevski * HTTPCLIENT-2293: Via header protocol improvements and performance optimization. Contributed by Oleg Kalnichevski * HTTPCLIENT-2293: RFC-compliant TRACE request interceptor (#486). Contributed by Arturo Bernal * HTTPCLIENT-2293: 'If-Range' request validation as per RFC 9110 (#485). Contributed by Arturo Bernal * HTTPCLIENT-2293: Enforce port specification for CONNECT requests as per RFC 9110 (#482). Contributed by Arturo Bernal * HTTPCLIENT-2284: Internal cache storage improvements (#478). Contributed by Oleg Kalnichevski * Replace `synchronized` blocks with ReentrantLock to ensure compatibility with virtual threads (#476). Contributed by Arturo Bernal * HTTPCLIENT-2284: Cache entry representation improvements: (#477). Contributed by Oleg Kalnichevski * HTTPCLIENT-2277: Rewrite the caching protocol layer for improved efficiency and conformance to RFC 9111. Contributed by Arturo Bernal and Oleg Kalnichevski and * Request and response Cache-Control APIs Contributed by Arturo Bernal and Oleg Kalnichevski and * HttpByteArrayCacheEntrySerializer refactoring and performance improvements. Contributed by Arturo Bernal Release 5.3 ------------------- This is the first GA release in the 5.3 release series. This release finalizes the 5.3 APIs and also includes all bug fixes from the 5.2 release branch. The 5.3 release series introduces support for the Bearer authentication scheme (RFC 6750) and deprecates NTLM and GSS-based experimental authentication schemes in favor of Basic / Bearer authentication with TLS. Notable changes and features included in the 5.3 series: * Introduction of the Bearer authentication scheme. * Deprecation of the NTLM authentication scheme. * Deprecation of the GSS-based experimental authentication schemes. * Support for load distribution across multiple proxies. Change Log ------------------- * HTTPCLIENT-2310: Async Connect exec handler incorrectly pipes CONNECT requests through the main request protocol chain. Contributed by Oleg Kalnichevski * Upgraded HttpCore to version 5.2.4. Contributed by Oleg Kalnichevski * SEE OTHER redirect handling fix. Contributed by Oleg Kalnichevski * HTTPCLIENT-2305: SSLConnectionSocketFactory allows Socket.connect() to be decorated (#499). Contributed by Carter Kozak * Add security warning to TrustStrategy implementations documentation (#490). Contributed by Marcono1234 * More consistent handling of OperationTimeoutException in MemcachedHttpCacheStorage. Contributed by Oleg Kalnichevski * Document exec chain behavior when automatic retries are enabled. (#480). Contributed by cachescrubber * HTTPCLIENT-2291: Fixed inconsistency in behavior between the class and async implementation of the request re-execution. The async request retry exec will now restart request execution from itself instead of from the very beginning of the execution chain. Contributed by Oleg Kalnichevski Release 5.3 ALPHA1 ------------------ This is the first release in the 5.3 release series that introduces support for the Bearer authentication scheme (RFC 6750) and deprecates NTLM and GSS-based experimental authentication schemes in favor of Basic / Bearer authentication with TLS. Change Log ------------------- * GSS-based experimental authentication schemes deprecated and disabled by default. Contributed by Oleg Kalnichevski * NTLM scheme deprecated and disabled by default. Contributed by Oleg Kalnichevski * Added linear and exponential BackoffManager implementations. Contributed by Arturo Bernal * Improved AIMDBackoffManager. Contributed by Arturo Bernal * Added DistributedProxySelector with support for load distribution across multiple proxies. Contributed by Arturo Bernal * Support for preamble and epilogue in multipart entities. Contributed by Arturo Bernal * HttpResponseException to include response message content (up to 256 bytes). Contributed by Arturo Bernal * Workaround for URL quoting issue with LLv6 host literals. Contributed by Arturo Bernal * Bearer auth scheme support (RFC 6750) Contributed by Oleg Kalnichevski * Credentials interface should be able to represent different types of user credentials including token-based with no password. Contributed by Oleg Kalnichevski * Connection settings `timeToLive` and `validateAfterInactivity` set to zero to always close or validate connections being leased. Contributed by Christoph Kaser * Digest authentication scheme to omit the algorithm in the authentication response if it has not been explicitly set in the authentication challenge, as per RFC 7616. Contributed by John Vasileff * HTTPCLIENT-2271: Do not optimize the path component of the resolved URI by default. Contributed by Oleg Kalnichevski * Pass HttpContext to SSLConnectionSocketFactory#prepareSocket method (#404) Contributed by Alen Turkovic Release 5.2.1 ------------------ This is a maintenance release that fixes several regressions found in release 5.2. Change Log ------------------- * Regression: Async execution runtimes set the negotiated protocol version in the execution context at the wrong point of request execution. Contributed by Oleg Kalnichevski * Cancel connection request on exception. Contributed by Bryan Keller * Replace deprecated use of LangUtils#equals() with Objects.equals(). Contributed by Gary Gregory * Regression: Multipart body builder and multipart formatters fail to escape special characters such as backslash and quote mark. Contributed by Oleg Kalnichevski Release 5.2 ------------------ This is the first GA release in the 5.2 release series. This release finalizes the 5.2 APIs and corrects several defects discovered since the previous release. Please note that 5.2 upgrades the minimal JRE level to version 8 (8u251 is required). Please note this is likely to be the last release series with support for SPNEGO and NTLM authentication. As of version 5.3 GSS-API-based authentication schemes (Kerberos, SPNEGO) and NTLM authentication schemes are going to be deprecated and disabled by default. Notable changes and features included in the 5.2 series: * Upgrade to Java 8. * Improved support for TLS upgrade and HTTP protocol upgrade (async). * Support for H2 tunneling via HTTP/1.1 proxy. * Conformance to RFC 7617 (The 'Basic' HTTP Authentication Scheme). * Migration to Java 8 Time primitives in State Management and Cache APIs. * Connection and TLS configuration on a per-route basis. * Base64 codec based on Commons Codec replaced with JRE Base64 codec. Dependency on Commons Codec dropped. * Optional support for BR (Brotli) decompression. Change Log ------------------- * HTTPCLIENT-2242: RoutingSupport fails to copy InetAddress when normalizing HttpHost. Contributed by Oleg Kalnichevski * HTTPCLIENT-2240: Fixed incorrect CONNECT method initialization in ProxyClient. Contributed by Oleg Kalnichevski * HTTPCLIENT-2236: MultihomeIOSessionRequester fails to enhance the cause exception in case of connect failure if the remoteAddress argument has been given. Contributed by Oleg Kalnichevski * Use Objects.toString() instead of String type cast Contributed by Gary Gregory * HTTPCLIENT-2232: Last protocol interceptors moved at the end of the H2 protocol processing pipeline. Contributed by Oleg Kalnichevski * H2 async runtime to proactively set HTTP/2 protocol version in the execution context. Contributed by Oleg Kalnichevski * HTTPCLIENT-2231: Fixed a race condition in the main async executor when the request execution on an I/O thread is faster than execution pipeline management on the client thread. Contributed by Oleg Kalnichevski * Avoid duplicate redundant objects and use Singleton instead. Contributed by Arturo Bernal * HTTPCLIENT-2225: Connection route calculation does not take the default RequestConfig into account. Contributed by Oleg Kalnichevski * Avoid unnecessary use of Instant.toEpochMilli by using Instant#compareTo to compare Instants directly. Contributed by jkmcl * HTTPCLIENT-2221 Closing a classic response/entity allows connection reuse. Contributed by Carter Kozak Release 5.2 BETA1 ------------------ This is the first BETA release in the 5.2 release series that upgrades the minimal JRE level to version 8 (8u251 is required) and includes several protocol level and API improvements. It also includes all bug fixes from the 5.1 branch. Change Log ------------------- * Upgraded HttpCore to version 5.2-beta2. Contributed by Oleg Kalnichevski * HTTPCLIENT-2218: Use Java 8 Base64 utility (#370). Contributed by j3graham * Added support for BR (Brotli) decompression (#363). Contributed by 殷成涛 * HTTPCLIENT-2212: MinimalHttpAsyncClient fails to release client endpoints in case of a connect error (such as TLS handshake failure). Contributed by Oleg Kalnichevski * InternalAbstractHttpAsyncClient to create daemon threads. Contributed by Richard Hernandez * HTTPCLIENT-2080: Added #getRetryInterval method to HttpRequestRetryStrategy for use on retriable IOExceptions (#356). Contributed by Anthony Baldocchi <489445+ajbaldocchi at users.noreply.github.com> * Fixed infinite recursion in SSLConnectionSocketFactory. Contributed by Ryan Schmitt * HTTPCLIENT-2200: Protocol interceptors are executed before the connection route has been fully established. Contributed by Oleg Kalnichevski * HTTPCLIENT-2209: Pass HttpContext to AsyncClientConnectionOperator (#353). Contributed by Andriy Redko * HTTPCLIENT-2206: Corrected resource de-allocation by fluent response objects. Contributed by Oleg Kalnichevski * ExecSupport#getNextExchangeId() optimization (#352) Contributed by David Schlosnagle * HTTPCLIENT-2203: Corrected target host normalization by the request execution interceptors; added ContextBuilder with support for preemptive authentication initialization. Contributed by Oleg Kalnichevski * HTTPCLIENT-2202: MemcachedHttpCacheStorage to support MemcachedClientIF interface. Contributed by Oleg Kalnichevski * Bug fix: ByteArrayBuilder incorrectly handles empty strings. Contributed by Oleg Kalnichevski * HTTPCLIENT-2198: Fixed AbstractClientTlsStrategy to respect HttpVersionPolicy. Contributed by Andrei Vasilev <59628447+AndreiSVasilev at users.noreply.github.com> * Updated AbstractClientTlsStrategy to pass only the HttpVersionPolicy set by TlsConfig instead of the entire TlsConfig to H2TlsSupport#selectApplicationProtocols() method. Contributed by Andrei Vasilev <59628447+AndreiSVasilev at users.noreply.github.com> * HTTPCLIENT-2195, regression: Classic ConnectExec incorrectly discards the proxy response body even if the request cannot be executed and the response is final. Contributed by Oleg Kalnichevski * HTTPCLIENT-2194: Async retry request interceptor fails to correct include request body on retry (#343). Contributed by JasonMathison * Deprecated execute methods that return an open response object in favor of execute methods with a response handler and automatic resource deallocation. Contributed by Oleg Kalnichevski * HTTPCLIENT-2189: Cookie and Cache APIs to use Java time primitives. Contributed by Arturo Bernal * Apply English locale to all date header formatters. Contributed by Michael Osipov * HTTPCLIENT-2184: Fixed an issue in which connections were not returned to the pool when requests contained non-repeatable bodies AND responses were streamed. Contributed by Carter Kozak Release 5.2 ALPHA1 ------------------ This is the first ALPHA release in the 5.2 release series that upgrades minimal JRE level to version 1.8 (8u251 is required) and includes several protocol level and API improvements. It also includes all bug fixes from the 5.1 branch. Notable changes and features included in the 5.2 series: * Upgrade to Java 8. * Improved support for TLS upgrade and HTTP protocol upgrade (async). * Support for H2 tunneling via HTTP/1.1 proxy. * Conformance to RFC 7617 (The 'Basic' HTTP Authentication Scheme). Change Log ------------------- * Replaced SimpleDateFormat and Calendar with Java 8 Time APIs; removed thread-local from DateUtils. Contributed by Oleg Kalnichevski * Support for connection 'total time to live' setting on a per-route basis. Contributed by Oleg Kalnichevski * Configurable IOReactor IO session decorator configurable. Contributed by Arturo Bernal * HTTPCLIENT-2182: Access to SSLSession attributes via reflection is disallowed as of Java 16. Core TLS functions now use new Java 1.8 API introduced by 8u251 update. Contributed by Oleg Kalnichevski * HTTPCLIENT-2135: TLS configuration on a per-host basis. Contributed by Oleg Kalnichevski * RFC 7230: Treat presence of userinfo in authority component in request URI as an HTTP protocol violation. Contributed by Oleg Kalnichevski * AuthCache conformance to RFC 7617. Contributed by Oleg Kalnichevski * Added immutable CredentialsProvider implementations and a CredentialsProvider builder. Contributed by Oleg Kalnichevski * HTTPCLIENT-2045: BASIC auth scheme conformance to RFC 7617. Contributed by Oleg Kalnichevski * HTTPCLIENT-2120: support for H2 via HTTP/1.1 proxy. Contributed by Oleg Kalnichevski * Moved connection management-related settings from RequestConfig to new class ConnectionConfig. Contributed by Oleg Kalnichevski * HTTPCLIENT-2139: Cookie Header HttpOnly attribute. Contributed by Arturo Bernal Release 5.1.1 ----------- This release upgrades HttpCore to the latest 5.1 version and fixes a number of issues found since release 5.1. Change Log ------------------- * Don't initialize AtomicReference to its default value. Contributed by Gary Gregory * Corrected resolution of the target host in DefaultUserTokenHandler. Contributed by Oleg Kalnichevski * HTTPCLIENT-2177: automatically force HTTP/1.1 protocol policy when executing requests via a proxy tunnel. Contributed by Oleg Kalnichevski * HTTPCLIENT-2177: fixed incorrect route state tracking by the async connect executor when negotiating a tunnel via a proxy. Contributed by Oleg Kalnichevski * HTTPCLIENT-2177: keep successful tunnel connections alive regardless of `Connection: close`. Contributed by Oleg Kalnichevski * HTTPCLIENT-2173: async pooling connection manager to close half-open connection gracefully. Contributed by Oleg Kalnichevski * Don't retry a request for NoRouteToHostException. Contributed by Jaikiran Pai * HTTPCLIENT-2170: Classic protocol layer no longer releases the underlying connection back to the pool prematurely while the NTLM handshake is still ongoing. Contributed by Oleg Kalnichevski * Fixed connection lease request cancellation race in both classic and asyc pooling connection managers. Contributed by Oleg Kalnichevski Release 5.1 ----------- This is the first GA release in the 5.1 release series. Notable changes and features included in the 5.1 series: * Conditional conformance with RFC 3986 (Uniform Resource Identifier (URI): Generic Syntax). * Improved support for out of sequence response message handing by the the classic (blocking) HTTP transport. * Improved message builders. Please note that 5.1 is going to be the last release series compatible with Java 1.7. HttpClient will require Java 1.8 as of 5.2. Change Log ------------------- * HTTPCLIENT-2157: Response object generated by the classic caching backend is missing the original content encoding. Contributed by Oleg Kalnichevski * HTTPCLIENT-2152: Fixed handling of unexpected unchecked exception by the async request retry exec interceptor. Contributed by Oleg Kalnichevski * Async clients to support scheduled (delayed) re-execution of requests. Contributed by Oleg Kalnichevski * HTTPCLIENT-2148: fluent Executor volatile access thread safety (#301). Contributed by Carter Kozak * HTTPCLIENT-2149: When no dNSName, match against CN. Contributed by Peter Dettman * HTTPCLIENT-2147: fixed broken preemptive auth in HC Fluent. Contributed by Robert Rodewald * HTTPCORE-672: cleanup of H2 connection validation code. Contributed by Oleg Kalnichevski * HttpAsyncClientBuilder: Make IOReactor exception callback configurable Contributed by Ryan Schmitt * HTTPCLIENT-2141: HttpClient to not retry requests if the retry interval exceeds the response timeout. Contributed by Oleg Kalnichevski * Fixed NPE during dispose in Response if entity is null Contributed by Sandeep Kulkarni * Blocking connection managers to validate connections after inactivity of more than 2s by default. Contributed by Oleg Kalnichevski * Deprecated request factory classes in favor of request builders. Contributed by Oleg Kalnichevski * HTTPCLIENT-2140: Upgraded Commons Codec to version 1.15. Contributed by Oleg Kalnichevski * Deprecated message copiers in favor of generic message builders. Contributed by Oleg Kalnichevski * Kerberos/SPNego fixes Contributed by Carey Lin Release 5.1 BETA1 ------------------ This is the first BETA release in the 5.1 release series that includes a number of new features as well performance optimizations in the classic HTTP transport. Notable changes and features included in the 5.1 series: * Conditional conformance with RFC 3986 (Uniform Resource Identifier (URI): Generic Syntax). * Improved support for out of sequence response message handing by the the classic (blocking) HTTP transport. Changelog: ------------------- * RFC 3986 conformance: URIUtils to re-use URIBuilder functionality. Contributed by Oleg Kalnichevski * Improved I/O session and wire logging. Contributed by Oleg Kalnichevski * Add interceptors before MAIN_TRANSPORT so they won't be ignored (#272) Contributed by Rob Spoor * HTTPCLIENT-2104: ManagedHttpClientConnectionFactory to support ResponseOutOfOrderStrategy configuration. Contributed by Carter Kozak * Fixed NPE when H2/Async client interceptors are added using first/last (#268). Contributed by Koji Lin * HTTPCLIENT-2126: `InternalAbstractHttpAsyncClient` incorrectly handles response messages with no enclosed entity. Contributed by Oleg Kalnichevski * HTTPCLIENT-2124: Fixed NOE in MinimalHttpClient#doExecute (#261). Contributed by Gary Gregory * HTTPCLIENT-2122: async client to throw `HTTP/2 tunneling not supported` protocol exception in case of `force HTTP/2` version policy used along with request proxy routing. Contributed by Oleg Kalnichevski * HTTPCLIENT-2123: H2AsyncClientBuilder incorrectly adds last request interceptors to the head of the interceptor list. Contributed by Oleg Kalnichevski * Use decimal numbers for endpoint/execution IDs (#249). Contributed by Michael Osipov * HTTPCLIENT-2106: Added charset parameter for DigestScheme. Contributed by Oleg Kalnichevski * HTTPCLIENT-2103: ManagedHttpClientConnectionFactory provides a fluent builder Contributed by Carter Kozak Release 5.0.3 ----------------- This release upgrades HttpCore to the latest version, improves conformance to RFC 7235 (Hypertext Transfer Protocol (HTTP/1.1): Authentication) and addresses a number of issues found since 5.0.2 release. Changelog: ------------------- * PR #270: Master try w res and more. - Use try-with-resources. - Use Arrays.fill(). - Add missing @override. - Simplify if/else. - Remove redundant modifiers. … - Remove redundant returns. Contributed by Gary Gregory Release 5.0.2 ----------------- This release upgrades HttpCore to the latest version, improves conformance to RFC 7235 (Hypertext Transfer Protocol (HTTP/1.1): Authentication) and addresses a number of issues found since 5.0.1 release. Changelog: ------------------- * HTTPCLIENT-2116: Incorrect request message composition when routing requests via a proxy. Contributed by Oleg Kalnichevski * PoolingAsyncClientConnectionManager incorrectly emits Ping commands to HTTP/1.1 endpoints (#255). Contributed by 滕杰1 * HTTPCLIENT-2115: HttpAsyncClientBuilder and H2AsyncClientBuilder fail to take `replaceExecInterceptor()` into account. Contributed by Oleg Kalnichevski * HTTPCLIENT-2112: AbstractMultipartFormat respects ByteBuffer.arrayOffset (#253). Contributed by Carter Kozak * Avoid updating Content-Length header in a 304 response. Contributed by Dirk Henselin * HTTPCLIENT-2105: Async clients incorrectly handle redirects of requests with enclosed entity. Contributed by Oleg Kalnichevski * HTTPCLIENT-2100: Incorrect handling of EXTENDED mode by MultipartEntityBuilder Contributed by Oleg Kalnichevski * HTTPCLIENT-2099, HTTPCLIENT-2091: SSLConnectionSocketFactory connect timeout fix (#241). Contributed by Carter Kozak * Bug fix: BasicExpiresHandler is annotated as immutable but is not (#240). Contributed by Gary Gregory * HTTPCLIENT-2096: Migrate instance loggers to static fields Contributed by Carter Kozak * Added Automatic-Module-Name to the artefact manifests. Contributed by Niels Basjes * MultipartEntityBuilder#generateBoundary optimization (#233) Contributed by slisaasquatch * HTTPCLIENT-2094: ConnectionManager validateAfterInactivity zero duration agreement Contributed by Carter Kozak * RFC 7235 compliance, HTTPCLIENT-2086: Fixed parsing of token68 based (base64-encoded) auth schemes. Contributed by Oleg Kalnichevski * HTTPCLIENT-2091: Connect timeout is used instead of socket timeout after a tls upgrade Contributed by Oleg Kalnichevski * HTTPCLIENT-2084: Client builders incorrectly add message interceptors with LAST position to the head of the list. Contributed by Oleg Kalnichevski * HTTPCLIENT-2083: Fix NPE when classic client interceptors are added. Contributed by Carter Kozak Release 5.0.1 ----------------- This release upgrades HttpCore to the latest version and addresses a number of issues found since 5.0 release. Changelog: ------------------- * Bug fix: Classic connection managers fail to take #isConsistent() flag into account when re-using persistent connections. 7 Contributed by Oleg Kalnichevski * HTTPCLIENT-2077: Authentication failure due to incorrect NTLM auth value check. Contributed by vonahok <64310078+vonahok at users.noreply.github.com> * HTTPCLIENT-2051: Corrected handling of 303 redirects. Contributed by Oleg Kalnichevski * HTTPASYNC-160: HttpAsyncClient in INACTIVE or STOPPED state throws a IllegalStateException causing the current thread to terminate. Contributed by Oleg Kalnichevski * HTTPCLIENT-2076: Fixed NPE in LaxExpiresHandler. Contributed by heejeongkim * HTTPCLIENT-2074: Disallow direct execution of CONNECT methods by standard client implementations. Contributed by Oleg Kalnichevski * HTTPCLIENT-2075: New method Request.responseTimeout(Timeout) in Fluent HC. Contributed by Ralph * HTTPCLIENT-2073: (regression) WindowsNegotiateScheme incorrectly rejects empty NTLM challenge. Contributed by Oleg Kalnichevski * HTTPCLIENT-2069: RequestConfig#copy does not copy #responseTimeout. Contributed by Oleg Kalnichevski * HTTPCLIENT-2061: Corrected sequence of request execution interceptors in classic HttpClient. Contributed by Oleg Kalnichevski * Fixed NPE for null HttpContext in minimal async clients. Contributed by slisaasquatch Release 5.0 ----------------- This is the first stable (GA) release of HttpClient 5.0. Notable changes and features included in the 5.0 series are: * Support for the HTTP/2 protocol and conformance to requirements and recommendations of the latest HTTP/2 protocol specification documents (RFC 7540, RFC 7541.) Supported features: ** HPACK header compression ** Stream multiplexing (client and server) ** Flow control ** Response push ** Message trailers ** Expect-continue handshake ** Connection validation (ping) ** Application-layer protocol negotiation (ALPN) ** TLS 1.2 security features * Improved conformance to requirements and recommendations of the latest HTTP/1.1 protocol specification documents (RFC 7230, RFC 7231.) * New connection pool implementation with lax connection limit guarantees and better performance under higher concurrency due to absence of a global pool lock. * Support for Reactive Streams API [http://www.reactive-streams.org/] * Package name space changed to 'org.apache.hc.client5'. * Maven group id changed to 'org.apache.httpcomponents.client5'. HttpClient 5.0 releases can be co-located with earlier major versions on the same classpath due to the change in package names and Maven module coordinates. Changelog: ------------------- * Removed work-around for resumed TLS sessions given that JDK-8212885 fix has been ported to Java 11 and released in Oracle JDK 11.0.3. Contributed by Oleg Kalnichevski * Upgraded HttpCore dependency to version 5.0 Contributed by Oleg Kalnichevski * DefaultHttpRequestRetryStrategy: Allow zero retry interval Contributed by Ryan Schmitt * HTTPCLIENT-2047: fixed regression in DefaultHostnameVerifier causing rejection of certs with non-standard domains. Contributed by Oleg Kalnichevski * GitHub #204: Build requests from method names in ClassicHttpRequests: ClassicHttpRequests.create(String, String) ClassicHttpRequests.create(String, URI) Contributed by Gary Gregory * GitHub #205: Update request factory classes with matching APIs for Method and String method name inputs: BasicHttpRequests.create(String, URI) BasicHttpRequests.create(String, String) ClassicHttpRequests.create(Method, String) ClassicHttpRequests.create(Method, URI) SimpleHttpRequests.create(String, URI) SimpleHttpRequests.create(String, String) Contributed by Gary Gregory * GitHub #208: Do not use input type names in method names: SimpleHttpRequest: Delete setBodyBytes(byte[], ContentType) in favor of setBody(byte[], ContentType) SimpleHttpRequest: Delete setBodyText(String, ContentType) in favor of setBody(String, ContentType) SimpleHttpResponse: Delete setBodyBytes(byte[], ContentType) in favor of setBody(byte[], ContentType) SimpleHttpResponse: Delete setBodyText(String, ContentType) in favor of setBody(String, ContentType) Contributed by Gary Gregory Release 5.0-BETA7 ----------------- This BETA release upgrades HttpCore to the latest version and addresses a number of issues found since the previous BETA release. IMPORTANT: This release is expected to be the last BETA version. If no major design flaws are found the actual 5.0 API will be frozen and the next version will be promoted to GA. Changelog: ------------------- * Improved domain name normalization by DefaultHostnameVerifier. Contributed by Oleg Kalnichevski * DefaultHostnameVerifier: Match DNS and CN names against ICANN domains. Contributed by Ryan Schmitt * HTTPCORE-615: Implement HTTP-based cache serializer-deserializer. Contributed by Scott Gifford * HTTPCLIENT-2040: Copy headers from the original request to the redirect request. Contributed by Oleg Kalnichevski * Removed RFC 2965 specific requirements deprecated and superseded by RFC 6265. Contributed by Oleg Kalnichevski * HTTPCLIENT-2035: Remove HttpRequestRetryHandler in favor of HttpRequestRetryStrategy. Contributed by Michael Osipov * HTTPCLIENT-2019: Remove ServiceUnavailableRetryStrategy in favor of HttpRequestRetryStrategy. Contributed by Michael Osipov * HTTPCLIENT-2034: Introduce HttpRequestRetryStrategy. Contributed by Michael Osipov * CloseableHttpAsyncClient to support explicit HttpHost execution parameter. Contributed by Oleg Kalnichevski * HTTPCLIENT-2020: DefaultBackoffStrategy to support TOO_MANY_REQUESTS (429). Contributed by Michael Osipov * HTTPCLIENT-2030: Fixed PublicSuffixMatcher#getDomainRoot behavior with invalid hostnames. Contributed by Niels Basjes * HTTPCLIENT-2028: Connection managers to allow 0 for `validateAfterInactivity` time value. Contributed by Peter Frank * HTTPCLIENT-2023: Allow nested arrays and all primitive types in DefaultHttpCacheEntrySerializer. Contributed by Olof Larsson Release 5.0-BETA6 ------------------- This BETA release picks up the latest fixes and performance improvements from HttpCore and addresses a number of issues found since the previous BETA release. Changelog: ------------------- * Fixed fallback PublicSuffixMatcher. Contributed by Ryan Schmitt * Enforce h2 TLS rules after negotiating TLS, not before. Contributed by Ryan Schmitt * HTTPCLIENT-2013: Revised handling of connect exceptions; improved consistency in behavior of the classic and async clients; ConnectTimeoutException now extends SocketTimeoutException. Contributed by Oleg Kalnichevski * Improved handling of request cancellation (classic API). Contributed by Oleg Kalnichevski * Fixed concurrent use of threading unsafe ClassicHttpRequest messages. Contributed by Oleg Kalnichevski * Execute Socket#connect under doPrivileged. Contributed by Simon Willnauer * HTTPCLIENT-2009: Fixed StringIndexOutOfBoundsException in AuthSupport#extractFromAuthority. Contributed by itonyli <429284840 at qq.com> * Make Accept-Encoding header handling thread-safe. Contributed by Linton Miller Release 5.0-BETA5 ------------------- This BETA release picks up the latest fixes and performance improvements from HttpCore and addresses a number of issues found since the previous BETA release. IMPORTANT: This release is expected to be the last BETA version. If no major design flaws are found the actual 5.0 API will be frozen and the next version will be promoted to GA. Changelog: ------------------- * Information response (1xx) processing support. Contributed by Kirill Usov * HTTPCLIENT-1968: Preserve escaped PATHSAFE characters when normalizing URI path segments. Contributed by Oleg Kalnichevski * HTTPCLIENT-1992: Impossible to access trailer-headers available in chunked transfer-encoding with classic API. Contributed by Serkan Turgut * HTTPCLIENT-1991: incorrect handling of non-standard DNS entries by PublicSuffixMatcher. Contributed by Oleg Kalnichevski * Refactor to enable support for non-form based multipart requests Contributed by Adam Retter * HTTPCLIENT-1981: disallow TRACE requests with an enclosed entity Contributed by Jay Modi Release 5.0-BETA4 ------------------- This BETA release picks up the latest fixes and performance improvements from HttpCore and addresses a number of issues found since the previous BETA release. Notable features in this release: * Security improvements. * URI handling improvements. Changelog: ------------------- * HTTPCLIENT-1976: Unsafe deserialization in DefaultHttpCacheEntrySerializer. Contributed by Artem Smotrakov * HTTPCLIENT-1969: Filter out weak cipher suites. Contributed by Artem Smotrakov * HttpClient should not retry requests in case of ConnectionClosedException Contributed by Oleg Kalnichevski * Bug fix: Simple response consumer to discard stored content when releasing resources. Contributed by Oleg Kalnichevski * Bug fix: main async request execution handlers to release the associated response consumer upon exception. Contributed by Oleg Kalnichevski * Update Apache Commons Codec from 1.11 to 1.12. Contributed by Gary Gregory * Update RxJava from 2.2.2 to 2.2.7. Contributed by Gary Gregory * Update JNA from 5.0.0 to 5.2.0. Contributed by Gary Gregory * Some well known proxies respond with Content-Length=0, when returning 304. For robustness, always use the cached entity's content length, as modern browsers do. Contributed by Jayson Raymond * HTTPCLIENT-1960: URIBuilder incorrect handling of multiple leading slashes in path component. Contributed by Oleg Kalnichevski * HTTPCLIENT-1958: PoolingHttpClientConnectionManager to throw ExecutionException in case of a lease operation cancellation instead of InterruptedException. Contributed by Oleg Kalnichevski * Shutdown executorService on AbstractHttpAsyncClientBase shutdown. Contributed by 吴雪山 * [HTTPCLIENT-1952: Allow default User Agent to be disabled Contributed by Michael Osipov * Improve HttpResponseException#getMessage. Contributed by Michael Osipov * Better handling of http(s).proxyUser and http(s).proxyPassword Contributed by Jens Borgland * Wrong argument name in PoolingAsyncClientConnectionManagerBuilder#setConnPoolPolicy results with self assignment of variable. Contributed by Eryk Szymanski Release 5.0-BETA3 ------------------- This BETA release adds support for advanced TLS functions (such as ALPN protocol negotiation) on Java 1.7 and Java 1.8 through Conscrypt TLS library and picks up the latest fixes and performance improvements from HttpCore. Notable features in this release: * TLS ALPN protocol negotiation support on older JREs through Conscrypt TLS library. Changelog: ------------------- * Added optional dependency on conscrypt-openjdk-uber 1.4.1; support for advanced TLS functions (such as ALPN extension) on Java 1.7 and Java 1.8 through Conscrypt TLS library Contributed by Oleg Kalnichevski * Removed OSGi module Contributed by Oleg Kalnichevski * Removed experimental CredSsp auth scheme Contributed by Oleg Kalnichevski * HTTPCLIENT-1949: DigestScheme to use HttpRequest#getRequestUri instead of HttpRequest#getPath Contributed by Oleg Kalnichevski Release 5.0-BETA2 ------------------- This BETA release resolves compatibility issues with Java 11 new TLS engine as well as a number of defects found since the previous release. Notable new features in this release: * JDK 11 compatibility * Support for request specific push consumers * Support for Reactive Streams API [http://www.reactive-streams.org/] Changelog: ------------------- * Hack to make hostname verification work with TLSv1.3 resumed sessions. For details see https://markmail.org/message/mxf5v2d2gh6ws2j3 Contributed by Oleg Kalnichevski * Added builders for SSLConnectionSocketFactory and client TlsStrategy. Contributed by Oleg Kalnichevski * Added enum for supported TLS versions & TLS version parser. Contributed by Oleg Kalnichevski * HTTPCLIENT-1946: handling of 308 status as per RFC 7538. Contributed by Oleg Kalnichevski * Upgraded HttpCore to version 5.0-beta5. Contributed by Oleg Kalnichevski * Async clients to support request specific push consumers. Contributed by Oleg Kalnichevski * HTTPCLIENT-1944: Add hardCancellationEnabled option to RequestConfig. Contributed by Ryan Schmitt * Overload Request's execute method to allow custom CloseableHttpClient. Contributed by Nicolas Gomez * Fix HttpClient 4.5.4 regression in BasicCookieStore serialization. Contributed by Mark Mielke * HTTPCLIENT-1934: Default client TLS strategy passes wrong hostname to the hostname verifier. Contributed by Oleg Kalnichevski * HTTPCLIENT-1882: reset authentication state on I/O or runtime error for connection based authentication schemes (such as NTLM). Contributed by Oleg Kalnichevski * HTTPCLIENT-1924: HttpClient to shut down the connection manager if a fatal error occurs in the course of a request execution. Contributed by Oleg Kalnichevski * Pooling connection managers to implement graceful and immediate shut down. Contributed by Oleg Kalnichevski * HTTPCLIENT-1906: certificates containing alternative subject names other than DNS and IP (such as RFC822) get rejected as invalid. Contributed by Oleg Kalnichevski * HTTPCLIENT-1904: check cookie domain for null Contributed by Hans-Peter Keck * HTTPCLIENT-1900: proxy protocol processor in the CONNECT exec interceptor does not post-process CONNECT response messages. Contributed by Oleg Kalnichevski * HTTPCLIENT-1898: Incorrect comment in example class ClientMultiThreadedExecution.java Contributed by Ulrich Romahn * HTTPCLIENT-1931: Add factory enum org.apache.hc.client5.http.classic.methods.ClassicHttpRequests Contributed by Gary Gregory * HTTPCLIENT-1932: Add factory enum org.apache.hc.client5.http.async.methods.HttpRequests Contributed by Gary Gregory * HTTPCLIENT-1939: Update Apache Commons Codec from 1.10 to 1.11 Contributed by Gary Gregory * HTTPCLIENT-1947: Update JNA from 4.5.2 to 5.0.0 Contributed by Gary Gregory Release 5.0-BETA1 ------------------- This is the first BETA release of HttpClient 5.0. The 5.0 release serices introduces support for the HTTP/2 protocol and event driven messaging APIs consistent for all supported HTTP protocol versions. Changelog: ------------------- * DefaultHostnameVerifier to use a custom distinguished name (DN) parser instead of LdapName. Removed dependency on Java Naming extensions. Contributed by Oleg Kalnichevski * HTTP/2 client implementations to support cancellation of ongoing message exchanges without terminating the underlying connections. Contributed by Oleg Kalnichevski * HTTPCLIENT-1395: added config parameter to skip an extra cache entry freshness check upon cache update in case of a cache miss. Contributed by Oleg Kalnichevski * HTTPCLIENT-1824, HTTPCLIENT-1384: asynchronous HTTP cache invalidator. Contributed by Oleg Kalnichevski * Redesign of CacheKeyGenerator and HttpCacheInvalidator APIs. Contributed by Oleg Kalnichevski * New APIs for cache entry bulk retrieval; bulk retrieval support by Memcached storage implementation. Contributed by Oleg Kalnichevski * HTTPCLIENT-1824, HTTPCLIENT-1868: Asynchronous HTTP cache storage API. Memcached backend implementation of async HTTP cache storage. Contributed by Oleg Kalnichevski * HTTPCLIENT-1885: Content compression exec interceptor generates incorrect 'Accept-Encoding' header value. Contributed by Oleg Kalnichevski Release 5.0-ALPHA3 ------------------- This is a major release that introduces support for the HTTP/2 protocol and event driven messaging APIs consistent for all supported HTTP protocol versions. HttpClient ships with two client implementations: * HttpClient Classic is based on the classic (blocking) I/O model; largely compatible with the 4.x APIs; supports HTTP/1.1 only. * HttpClient Async is based on NIO model; new event driven APIs consistent for all supported HTTP protocol versions; supports both HTTP/1.1 and HTTP/2. Notable new features in this release: * Asynchronous HttpClient implementations optimized for HTTP/2 multiplexed request execution. * Full support for HTTP caching by asynchronous HttpClient implementations including streaming message exchanages. Notable changes and features included in the 5.0 series are: * Support for the HTTP/2 protocol and conformance to requirements and recommendations of the latest HTTP/2 protocol specification documents (RFC 7540, RFC 7541.) Supported features: ** HPACK header compression ** Stream multiplexing (client and server) ** Flow control ** Response push ** Message trailers ** Expect-continue handshake ** Connection validation (ping) ** Application-layer protocol negotiation (ALPN) on Java 9.0.1+ ** TLS 1.2 security features * Improved conformance to requirements and recommendations of the latest HTTP/1.1 protocol specification documents (RFC 7230, RFC 7231.) * Redesigned connection pool implementation with reduced pool lock contention. * Package name space changed to 'org.apache.hc.client5'. * Maven group id changed to 'org.apache.httpcomponents.client5'. * Apache Log4j2 logging APIs used for internal logging instead of Commons Logging APIs. HttpClient 5.0 releases can be co-located with earlier major versions on the same classpath due to the change in package names and Maven module coordinates. Please note that as of 5.0, HttpClient requires Java 1.7 or newer. Changelog: ------------------- * HttpAsyncClient implementations optimized for HTTP/2 multiplexed request execution. Contributed by Oleg Kalnichevski * Improved Ehcache and Memcached storage backends. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1827] Full support for HTTP caching by asynchronous HTTP clients. Contributed by Oleg Kalnichevski * Redesign of HTTP cache resource APIs. Contributed by Oleg Kalnichevski * Deprecated Content-Transfer-Encoding field in MIME body parts per RFC 7578, section 4.7. Contributed by Oleg Kalnichevski * [HTTPCLIENT-293] Implemented the percent encoding of the filename parameter of the Content-Disposition header. Contributed by Ioannis Sermetziadis * [HTTPCLIENT-1845]: Extract InputStreamFactory classes out of GzipDecompressingEntity and DeflateDecompressingEntity for reuse and to create less garbage. Contributed by Gary Gregory * [HTTPCLIENT-1858] Alleviate GC pressure due to wire logging. Contributed by Gary Gregory * Avoid fetching the cached entity twice on cache hit. Contributed by Leandro Nunes * [HTTPASYNC-124] Add doPrivileged blocks to async client and connection manager builders Contributed by Jay Modi Release 5.0-ALPHA2 ------------------- This is a major release that introduces support for the HTTP/2 protocol and event driven messaging APIs consistent for all supported HTTP protocol versions. HttpClient ships with two client implementations: * HttpClient Classic is based on the classic (blocking) I/O model; largely compatible with the 4.x APIs; supports HTTP/1.1 only. * HttpClient Async is based on NIO model; new event driven APIs consistent for all supported HTTP protocol versions; supports both HTTP/1.1 and HTTP/2. Notable changes and features included in the 5.0 series are: * Partial support for the HTTP/2 protocol and conformance to requirements and recommendations of the latest HTTP/2 protocol specification documents (RFC 7540, RFC 7541.) Supported features: ** HPACK header compression ** Stream multiplexing (client and server) ** Flow control ** Response push ** Message trailers ** Expect-continue handshake ** Connection validation (ping) ** Application-layer protocol negotiation (ALPN) on Java 1.9+ ** TLS 1.2 security features * Improved conformance to requirements and recommendations of the latest HTTP/1.1 protocol specification documents (RFC 7230, RFC 7231.) * Redesigned connection pool implementation with reduced pool lock contention. * Package name space changed to 'org.apache.hc.client5'. * Maven group id changed to 'org.apache.httpcomponents.client5'. * Apache Log4j2 logging APIs used for internal logging instead of Commons Logging APIs. Features that are presently NOT supported: * HTTP/2 transport (classic) * HTTP tunneling (async) * Automatic response content decompression (async) * Caching (async) HttpClient 5.0 releases can be co-located with earlier major versions on the same classpath due to the change in package names and Maven module coordinates. Please note that as of 5.0, HttpClient requires Java 1.7 or newer. Please note that at this point 5.0 APIs are considered experimental and unstable and are expected to change in the coming releases without providing a migration path. Changelog: ------------------- * [HTTPCLIENT-1714] Add HttpClientBuilder.setDnsResolver(DnsResolver). Contributed by Alexis Thaveau * [HTTPCLIENT-1715] NTLMEngineImpl.Type1Message not thread safe but declared as a constant. Contributed by Olivier Lafontaine , Gary Gregory * [HTTPCLIENT-1716] redirect handling of unsafe methods defined by RFC 7231. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1717] Make fluent API .Content.Content(byte[], ContentType) public. Contributed by Cash Costello * [HTTPCLIENT-1730] added #setValidateAfterInactivity to HttpClientBuilder. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1752] Allow to configure the OSGI clients with relaxed SSL checks. Contributed by Simone Tripodi * [HTTPCLIENT-1748] Improved compatibility with system authentication API in applets. Contributed by Sebastien Caille * [HTTPCLIENT-1786] Port from Apache Commons Logging to Apache Log4j 2. Contributed by Gary Gregory * [HTTPCLIENT-1817] Add a "Trust All" TrustStrategy implementation. Contributed by Gary Gregory * [HTTPCLIENT-1836] DefaultHostnameVerifier#getSubjectAltNames(X509Certificate) throws java.lang.ClassCastException. Contributed by Gary Gregory , Ilian Iliev * [HTTPCLIENT-1691] HttpClient instance used internally by HC Fluent to take system properties into account by default. Contributed by Oleg Kalnichevski Release 5.0-ALPHA1 ------------------- This major release renders HttpClient API incompatible with the stable 4.x branch and upgrades HTTP/1.1 protocol conformance to the requirements and recommendations of the latest protocol specification. This release lays the foundation for transition to HTTP/2 as the primary transport protocol in the future releases. Notable changes and features included in the 5.0 series are: * Improved conformance to requirements and recommendations of the latest HTTP/1.1 protocol specification (RFC 7230, RFC 7231, RFC 7235) * Package name space changed to 'org.apache.hc.client5' * Maven group id changed to 'org.apache.httpcomponents.client5' * By default the maximum connections per route limit is set to 5 * By default connection request timeout and connect timeout are set to 3 minutes. HttpClient 5.0 releases can be co-located with earlier versions, meaning you can have both 5.x and 4.x on the classpath without experiencing jar hell. Please note that as of 5.0 HttpClient requires Java 1.7 or newer. Please note that at this point we consider 5.0 APIs experimental and unstable and expect them to change in the coming releases without providing a migration path. Changelog: ------------------- * [HTTPCLIENT-1575] route target port must be non negative Contributed by Oleg Kalnichevski * [HTTPCLIENT-1106] Use character arrays for passwords in Credentials objects Contributed by Oleg Kalnichevski * RFC 7235: redesign of HTTP authenticator and related classes Contributed by Oleg Kalnichevski * RFC 7231: parse capable of parsing multiple auth challenges Contributed by Oleg Kalnichevski * RFC 7231: DefaultServiceUnavailableRetryStrategy to take Retry-After header value into account if specified Contributed by Oleg Kalnichevski * RFC 7231: removed restriction on the use of relative URIs in Location header Contributed by Oleg Kalnichevski * RFC 7231: revised redirect handling Contributed by Oleg Kalnichevski * RFC 7231: do not generate header fields in TRACE requests containing sensitive data such as cookie and user credentials Contributed by Oleg Kalnichevski * RFC 7231: automatic retrial of idempotent methods Contributed by Oleg Kalnichevski * RFC 7230: increased the default max number of concurrent connection for the same route from 2 to 5 Contributed by Oleg Kalnichevski * Cache request line in HttpRequestWrapper Contributed by Dmitry Potapov * [HTTPCLIENT-1651] Add ability to disable content compression on a request basis Contributed by Oleg Kalnichevski * [HTTPCLIENT-1696]: Add convenience methods to fluent API class Request. Contributed by Gary Gregory Release 4.5.1 ------------------- HttpClient 4.5.1 (GA) is a maintenance release that fixes a number of minor defects found since 4.5. Please note that as of 4.4 HttpClient requires Java 1.6 or newer. Changelog: ------------------- * [HTTPCLIENT-1680] redirect of a POST request causes ClientProtocolException. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1673] org.apache.http.entity.mime.content.* missing from OSGi exports. Contributed by Benson Margulies * [HTTPCLIENT-1668] Fluent request incorrectly handles connect timeout setting. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1667] RequestBuilder does not take charset into account when creating UrlEncodedFormEntity. Contributed by Sergey Smith * [HTTPCLIENT-1655] HttpClient sends RST instead of FIN ACK sequence when using non-persistant connections. Contributed by Oleg Kalnichevski Release 4.5 ------------------- HttpClient 4.5 (GA) is a minor feature release that includes several incremental enhancements to the exisitng functionality such as support for private domains in the Mozilla Public Suffix List. Changelog: ------------------- * Reduced default validate after inactivity setting from 5 sec to 2 sec. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1649] Fixed serialization of auth schemes. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1645]: Fluent requests to inherit config parameters of the executor. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1640]: RFC6265 lax cookie policy fails to parse 'max-age' attribute. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1633]: RFC6265CookieSpecProvider compatibility level setting has no effect. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1613]: Support for private domains in Mozilla Public Suffix List. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1651]: Add ability to disable content compression on a request basis. Contributed by Michael Osipov * [HTTPCLIENT-1654]: Deprecate/remove RequestConfig#decompressionEnabled in favor of #contentCompressionEnabled. Contributed by Michael Osipov Release 4.4.1 ------------------- HttpClient 4.4.1 (GA) is a maintenance release that fixes a number of defects in new functionality introduced in version 4.4. Users of HttpClient 4.4 are encouraged to upgrade. Please note that as of 4.4 HttpClient requires Java 1.6 or newer. Changelog: ------------------- * Marked RFC 2109, RFC 2965, Netscape draft cookie specs as obsolete. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1633] RFC6265CookieSpecProvider compatibility level setting has no effect. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1628]: Auth cache can fail when domain name contains uppercase characters. Contributed by Dennis Ju * [HTTPCLIENT-1609] Stale connection check in PoolingHttpClientConnectionManager has no effect. Internal connection pool does not correctly implement connection validation. Contributed by Charles Lip Release 4.4 Final ------------------- This is the first stable (GA) release of HttpClient 4.4. Notable features and enhancements included in 4.4 series are: * Support for the latest HTTP state management specification (RFC 6265). Please note that the old cookie policy is still used by default for compatibility reasons. RFC 6265 compliant cookie policies need to be explicitly configured by the user. Please also note that as of next feature release support for Netscape draft, RFC 2109 and RFC 2965 cookie policies will be deprecated and disabled by default. It is recommended to use RFC 6265 compliant policies for new applications unless compatibility with RFC 2109 and RFC 2965 is required and to migrate existing applications to the default cookie policy. * Enhanced, redesigned and rewritten default SSL hostname verifier with improved RFC 2818 compliance. * Default SSL hostname verifier and default cookie policy now validate certificate identity and cookie domain of origin against the public suffix list maintained by Mozilla.org * More efficient stale connection checking: indiscriminate connection checking which results in approximately 20 to 50 ms overhead per request has been deprecated in favor of conditional connection state validation (persistent connections are to be re-validated only if a specified period inactivity has elapsed.) * Authentication cache thread-safety: authentication cache used by HttpClient is now thread-safe and can be shared by multiple threads in order to re-use authentication state for subsequent requests. * Native Windows Negotiate and NTLM via SSPI through JNA: when running on Windows OS HttpClient configured to use native NTLM or SPNEGO authentication schemes can make use of platform specific functionality via JNA and current user credentials. This functionality is still considered experimental, known to have compatibility issues and subject to change without prior notice. Use at your discretion. This release also includes all fixes from the stable 4.3.x release branch. Please note that as of 4.4 HttpClient requires Java 1.6 or newer. Changelog: ------------------- * Support for the latest HTTP state management specification (RFC 6265). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1515] Caching of responses to HEAD requests Contributed by Tyrone Cutajar and Francois-Xavier Bonnet * [HTTPCLIENT-1560] Native Windows auth improvements. Contributed by Michael Osipov * Update Apache Commons Logging version from 1.1.3 to 1.2. Contributed by Gary Gregory * Update Apache Commons Codec version from 1.6 to 1.9. Contributed by Gary Gregory * Update Ehcache version from 2.2.0 to 2.6.9. Contributed by Gary Gregory * Update Ehcache version from 2.2.0 to 2.6.9. Contributed by Gary Gregory * Update Spymemcached version from 2.6 to 2.11.4. Contributed by Gary Gregory * Update SLF4J version from 1.5.11 to 1.7.7. Contributed by Gary Gregory Release 4.4 BETA1 ------------------- This is the first BETA release of HttpClient 4.4. Notable features and enhancements included in 4.4 series are: * Enhanced redesigned and rewritten default SSL hostname verifier with improved RFC 2818 compliance * Default SSL hostname verifier and default cookie policy now validate certificate identity and cookie domain of origin against the public suffix list maintained by Mozilla.org * Native windows Negotiate/NTLM via JNA: when running on Windows OS HttpClient configured to use native NTLM or SPNEGO authentication schemes can make use of platform specific functionality via JNA and current user system credentials * More efficient stale connection checking: indiscriminate connection checking which results in approximately 20 to 50 ms overhead per request has been deprecated in favor of conditional connection state validation (persistent connections are to be re-validated only if a specified period inactivity has elapsed) * Authentication cache thread-safety: authentication caches used by HttpClient is now thread-safe and can be shared by multiple threads in order to re-use authentication state for subsequent requests This release also includes all fixes from the stable 4.3.x release branch. Please note that as of 4.4 HttpClient requires Java 1.6 or newer. Changelog: ------------------- * [HTTPCLIENT-1547] HttpClient OSGi bundle doesn't import the package "javax.naming". Contributed by Willem Jiang * [HTTPCLIENT-1541] Use correct (HTTP/hostname) service principal name for Windows native Negotiate/NTLM auth schemes. Contributed by Ka-Lok Fung * Improved compliance with RFC 2818: default hostname verifier to ignore the common name of the certificate subject if alternative subject names (dNSName or iPAddress) are present. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1540] Support delegated credentials (ISC_REQ_DELEGATE) by Native windows native Negotiate/NTLM auth schemes. Contributed by Ka-Lok Fung Release 4.4 ALPHA1 ------------------- This is the first ALPHA release of HttpClient 4.4. Notable features and enhancements included in the 4.4 branch are: * More efficient stale connection checking: indiscriminate connection checking which results in approximately 20 to 50 ms overhead per request has been deprecated in favor of conditional connection state validation (persistent connections are to be re-validated only if a specified period inactivity has elapsed) * Native windows Negotiate/NTLM via JNA: when running on Windows OS HttpClient configured to use native NTLM or SPNEGO authentication schemes can make use of platform specific functionality via JNA and current user system credentials * Authentication cache thread-safety: authentication caches used by HttpClient is now thread-safe and can be shared by multiple threads in order to re-use authentication state for subsequent requests This release also includes all fixes from the stable 4.3.x release branch. Please note that as of 4.4 HttpClient requires Java 1.6 or newer. Please note that new features included in this release are still considered experimental and their API may change in the future 4.4 alpha and beta releases. Changelog: ------------------- * [HTTPCLIENT-1493] Indiscriminate connection checking has been deprecated in favor of conditional connection state validation. Persistent connections are to be re-validated only after a defined period inactivity prior to being leased to the consumer. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1519] Use the original HttpHost instance passed as a parameter to HttpClient#execute when generating 'Host' request header. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1491] Enable provision of Service Principal Name in Windows native auth scheme. Contributed by Malcolm Smith * [HTTPCLIENT-1403] Pluggable content decoders. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1466] FileBodyPart#generateContentType() ignores custom ContentType values. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1461] fixed performance degradation in gzip encoded content processing introduced by HTTPCLIENT-1432. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1457] Incorrect handling of Windows (NT) credentials by SystemDefaultCredentialsProvider. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1456] Request retrial after status 503 causes ClientProtocolException. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1454] Make connection operator APIs public. Contributed by Tamas Cservenak * Update JUnit to version 4.11 from 4.9 Contributed by Gary Gregory Release 4.3.4 ------------------- HttpClient 4.3.4 (GA) is a maintenance release that improves performance in high concurrency scenarios. This version replaces dynamic proxies with custom proxy classes and eliminates thread contention in java.reflect.Proxy.newInstance() when leasing connections from the connection pool and processing response messages. Changelog: ------------------- * Replaced dynamic proxies with custom proxy classes to reduce thread contention. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1484] GzipCompressingEntity should not close the underlying output stream if the entity has not been fully written out due to an exception. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1474] Fixed broken entity enclosing requests in HC Fluent. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1470] CachingExec(ClientExecChain, HttpCache, CacheConfig, AsynchronousValidator) throws NPE if config is null Release 4.3.3 ------------------- HttpClient 4.3.3 (GA) is a bug fix release that fixes a regression introduced by the previous release causing a significant performance degradation in compressed content processing. Users of HttpClient 4.3 are encouraged to upgrade. Changelog: ------------------- * [HTTPCLIENT-1466] FileBodyPart#generateContentType() ignores custom ContentType values. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1453] Thread safety regression in PoolingHttpClientConnectionManager #closeExpiredConnections that can lead to ConcurrentModificationException. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1461] fixed performance degradation in compressed content processing introduced by HTTPCLIENT-1432. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1457] Incorrect handling of Windows (NT) credentials by SystemDefaultCredentialsProvider. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1456] Request retrial after status 503 causes ClientProtocolException. Contributed by Oleg Kalnichevski Release 4.3.2 ------------------- HttpClient 4.3.2 (GA) is a maintenance release that delivers a number of improvements as well as bug fixes for issues reported since 4.3.1 release. SNI support for Oracle JRE 1.7+ is being among the most notable improvements. Users of HttpClient 4.3 are encouraged to upgrade. Changelog: ------------------- * [HTTPCLIENT-1447] Clients created with HttpClients.createMinimal do not work with absolute URIs Contributed by Joseph Walton * [HTTPCLIENT-1446] NTLM proxy + BASIC target auth fails with 'Unexpected state: MSG_TYPE3_GENERATED'. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1443] HttpCache uses the physical host instead of the virtual host as a cache key. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1442] Authentication header set by the user gets removed in case of proxy authentication (affects plan HTTP requests only). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1441] Caching AsynchronousValidationRequest leaks connections. Contributed by Dominic Tootell * [HTTPCLIENT-1440] 'file' scheme in redirect location URI causes NPE. Contributed by James Leigh * [HTTPCLIENT-1437] Made Executor#execute thread safe. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1119] SNI support (Oracle Java 1.7+ only). Contributed by Bruno Harbulot * [HTTPCLIENT-1435] Fluent Executor ignores custom request properties. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1432] Lazy decompressing of HttpEntity#getContent() to avoid EOFException in case of an empty response with 'Content-Encoding: gzip' header. Contributed by Yihua Huang * [HTTPCLIENT-1431] (Regression) deprecated connection manager cannot be used with a custom LayeredSchemeSocketFactory. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1425] Fixed socket closed exception thrown by caching HttpClient when the origin server sends a long chunked response. Contributed by James Leigh * [HTTPCLIENT-1417] Fixed NPE in BrowserCompatSpec#formatCookies caused by version 1 cookies with null cookie value. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1416] Fixed NPE in CachingHttpClientBuilder#build(). Contributed by Oleg Kalnichevski Release 4.3.1 ------------------- HttpClient 4.3.1 (GA) is a bug fix release that addresses a number of issues reported since release 4.3. Users of HttpClient 4.3 are strongly encouraged to upgrade. Changelog ------------------- * [HTTPCLIENT-1410] Browser compatible hostname verifier no longer rejects *.co., *.gov., *.info., etc as invalid. Contributed by Oleg Kalnichevski * Ensure X509HostnameVerifier is never null. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1405] CONNECT HTTP/1.1 requests lack mandatory 'Host' header. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1402] Cache default User-Agent value. Contributed by yuexiaojun * [HTTPCLIENT-1398] Fixed invalid OSGi metadata caused by corrupted Maven bundle plugin metadata. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1399] Fixed NPE in RequestBuilder. Contributed by Oleg Kalnichevski Release 4.3 Final ------------------- This is the first stable (GA) release of HttpClient 4.3. The most notable enhancements included in this release are: * Support for Java 7 try-with-resources for resource management (connection release.) * Added fluent Builder classes for HttpEntity, HttpRequest, HttpClient and SSLContext instances. * Deprecation of preference and configuration API based on HttpParams interface in favor of constructor injection and plain configuration objects. * Reliance on object immutability instead of access synchronization for thread safety. Several old classes whose instances can be shared by multiple request exchanges have been replaced by immutable equivalents. * DefaultHttpClient, DecompressingHttpClient, CachingHttpClient and similar classes are deprecated in favor of builder classes that produce immutable HttpClient instances. * HttpClient builders now dynamically construct a request execution pipeline tailored specifically to the user configuration by physically excluding unnecessary protocol components. * There is now an option to construct a minimal HttpClient implementation that can only execute basic HTTP message exchanges without redirects, authentication, state management or proxy support. This feature might be of particular use in web crawler development. * There is now option to avoid strict URI syntax for request URIs by executing HTTP requests with an explicitly specified target host. HttpClient will no longer attempt to parse the request URI if it does not need to extract the target host from it. This release also includes all fixes from the stable 4.2.x release branch. Changelog ------------------- * [HTTPCLIENT-1371] Weak ETag Validation is Useful On PUT With If-Match Contributed by James Leigh * [HTTPCLIENT-1394] Support for Native windows Negotiate/NTLM via JNA Contributed by Ryan McKinley * [HTTPCLIENT-1384] Expose CacheInvalidator interface. Contributed by Nicolas Richeton * [HTTPCLIENT-1385] Fixed path normalization in CacheKeyGenerator Contributed by James Leigh * [HTTPCLIENT-1370] Response to non-GET requests should never be cached with the default ResponseCachingPolicy Contributed by James Leigh * [HTTPCLIENT-1373] OPTIONS and TRACE should not invalidate cache Contributed by James Leigh * [HTTPCLIENT-1383] HttpClient enters an infinite loop during NTLM authentication if the opposite endpoint keeps responding with a type 2 NTLM response after type 3 MTLM message has already been sent by the client. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1372] Refactor HttpMultipart, and add RFC6532 mode, so that headers in post are no longer constrained to ASCII values. Contributed by Karl Wright * [HTTPCLIENT-1377] User principal for non-NTLM authentication is incorrectly generated when using user credentials are specified as NTCredentials Contributed by Gary Gregory Release 4.3 BETA2 ------------------- This is the second BETA release of HttpClient 4.3. The most notable features and improvements in the 4.3 branch are: Support for Java 7 try-with-resources for resource management (connection release); fluent Builder classes for HttpEntity, HttpRequest and HttpClient instances, deprecation of preference and configuration API based on HttpParams interface in favor of constructor injection and plain configuration objects, reliance on object immutability instead of access synchronization for thread safety. This release also includes all fixes from the stable 4.2.x release branch. Changelog ------------------- * [HTTPCLIENT-1366] org.apache.http.client.utils.URLEncodedUtils should parse the semicolon as a query parameter separator. Contributed by Gary Gregory * [HTTPCLIENT-1365] NPE when ManagedHttpClientConnectionFactory.create(ConnectionConfig) is called with null. Contributed by Gary Gregory * [HTTPCLIENT-1362] Better error messages for connect timed out and connection refused exceptions. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1360] separate out DeflateInputStream as an independent class, so it can be used by others. Contributed by Karl Wright * [HTTPCLIENT-1359] repeated requests using the same context fail if they redirect. Contributed by James Leigh * [HTTPCLIENT-1354] do not quote algorithm parameter in DIGEST auth response. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1351] Added utility method to resolve final location from original request, target host and a list of redirects. Contributed by James Leigh * [HTTPCLIENT-1344] Userinfo credentials in URI should not default to preemptive BASIC authentication. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1345] Useinfo credentials ignored in redirect location header. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1294] HttpClient to rewrite host name of the redirect location URI in order to avoid circular redirect exception due to host name case mismatch. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1264] Add support for multiple levels of browser compatibility to BrowserCompatSpec and BrowserCompatSpecFactory. Include constructor argument for IE medium-security compatibility. Contributed by Karl Wright (kwright at apache.org) * [HTTPCLIENT-1349] SSLSocketFactory incorrectly identifies key passed with keystore as the keystore password. Contributed by David Graff * [HTTPCLIENT-1346] Ensure propagation of SSL handshake exceptions. Contributed by Pasi Eronen * [HTTPCLIENT-1343] SSLSocketFactory optional parameters for supported SSL protocols and cipher suites. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1238] Contribute Bundle Activator And Central Proxy Configuration. Contributed by Simone Tripodi * [HTTPCLIENT-1299] (regression) cache incorrectly disposes of the underlying cache resource when storing variant entry. Contributed by James Leigh * [HTTPCLIENT-1342] Redirects with underscore character in the location hostname cause "java.lang.IllegalArgumentException: Host name may not be null". Contributed by Oleg Kalnichevski Release 4.3 BETA1 ------------------- This is the first BETA release of HttpClient 4.3. The 4.3 branch enhances HttpClient in several key areas and includes several notable features and improvements: Support for Java 7 try-with-resources for resource management (connection release); fluent Builder classes for HttpEntity, HttpRequest and HttpClient instances, deprecation of preference and configuration API based on HttpParams interface in favor of constructor injection and plain configuration objects, reliance on object immutability instead of access synchronization for thread safety. This release also includes all fixes from the stable 4.2.x release branch. Changelog ------------------- * [HTTPCLIENT-1317] InetAddressUtils should handle IPv6 Addresses with Embedded IPv4 Addresses Contributed Sebastian Bazley . * [HTTPCLIENT-1320] Leverage javax.net.ssl.SSLSocketFactory#getDefault() to initialize SSL context based on system defaults instead of using an internal custom routine. Contributed by Abe Backus and Oleg Kalnichevski * [HTTPCLIENT-1316] Certificate verification rejects IPv6 addresses which are not String-equal. Contributed Sebastian Bazley . * [HTTPCLIENT-1307] Future based asynchronous request execution. Contributed by Jilles van Gurp * [HTTPCLIENT-1313] Fixed IllegalStateException in deprecated ThreadSafeClientConnManager. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1298] Add AsynchronousValidator in HttpClientBuilder's list of closeable objects. Contributed by Martin Meinhold Release 4.3 ALPHA1 ------------------- This is the first ALPHA release of HttpClient 4.3. The 4.3 branch enhances HttpClient in several key areas and includes several notable features and improvements: Support for Java 7 try-with-resources for resource management (connection release); fluent Builder classes for HttpEntity, HttpRequest and HttpClient instances, deprecation of preference and configuration API based on HttpParams interface in favor of constructor injection and plain configuration objects, reliance on object immutability instead of access synchronization for thread safety. We are kindly asking all upstream projects to review API changes and help us improve the APIs by providing feedback and sharing ideas on dev@hc.apache.org. This release also includes all fixes from the stable 4.2.x release branch. Please note that new features included in this release are still considered experimental and their API may change in the future 4.3 alpha and beta releases. Changelog ------------------- * [HTTPCLIENT-1250] Allow query string to be ignored when determining cacheability for HTTP 1.0 responses. Contributed by Don Brown * [HTTPCLIENT-1261] Make SystemDefaultHttpClient honor http.agent system property. Contributed by Oleg Kalnichevski * [HTTPCLIENT-900] Don't enforce URI syntax for messages with an explicit target host. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1190] HttpClient cache does not support "Vary: Cookie" Contributed by Oleg Kalnichevski * [HTTPCLIENT-1259] Calling #abort() on requests executed with DecompressingHttpClient has no effect. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1253] URIBuilder setParameter() method could exceed the HTTP header size. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1216] Added method to force clean thread-local used by DateUtils. Contributed by Oleg Kalnichevski Release 4.2.3 ------------------- HttpClient 4.2.3 (GA) is a bug fix release that addresses a number of issues reported since release 4.2.2. This release also includes a thoroughly reworked NTLM authentication engine which should result in a better compatibility with the newest Microsoft products. Users of HttpClient 4.x are advised to upgrade. Changelog ------------------- * [HTTPCLIENT-1296] NPE gets thrown if you combine a default host with a virtual host that has a -1 value for the port. Contributed by Karl Wright * [HTTPCLIENT-1290] 304 cached response never reused with If-modified-since conditional requests. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1291] Absolute request URIs without an explicitly specified path are rewritten to have "/" path). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1286] Request URI rewriting is inconsistent - URI fragments are not removed from absolute request URIs. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1284] HttpClient incorrectly generates Host header when physical connection route differs from the host name specified in the request URI. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1293] Kerberos and SPNego auth schemes use incorrect authorization header name when authenticating with a proxy. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1283] NTLM needs to use Locale-independent form of toUpperCase(). Contributed by Karl Wright * [HTTPCLIENT-1279] Target host responding with status 407 (proxy authentication required) causes an NPE. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1281] GzipDecompressingEntity does not release InputStream when an IOException occurs while reading the Gzip header Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1277] Caching client sends a 304 to an unconditional request. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1278] Update NTLM documentation. Contributed by Karl Wright * SystemDefaultHttpClient misinterprets 'http.keepAlive' default value and disables connection persistence if the system property is not set. This causes connection based authentication schemes such as NTLM to fail. * [HTTPCLIENT-1276] cache update on a 304 response causes NPE. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1273] DecompressingHttpClient does not automatically consume response content in case of an i/o, HTTP or runtime exception thrown by the decompressing protocol interceptor leading to a potential connection leak. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1268] NTLM engine refactor fix, to correct a buffer overrun, and get NTLMv2 flags right. Contributed by Karl Wright * [HTTPCLIENT-1266] NTLM engine refactoring and compatibility improvements. Contributed by Karl Wright * [HTTPCLIENT-1263] BrowserCompatSpec: attribute values containing spaces or special characters should be enclosed with quotes marks for version 1 cookies. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1263] CachingHttpClient fails to release connections back to the connection manager for some type of HTTP response messages when used together with DecompressingHttpClient. Contributed by Francois-Xavier Bonnet * [HTTPCLIENT-1258] Fixed NullPointerException in NTLMEngineImpl caused by null NT domain attribute. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1254] Redirect with underscore in hostname causes ProtocolException. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1255] AbstractVerifier incorrectly parses certificate CN containing wildcard. Contributed by Oleg Kalnichevski Release 4.2.2 ------------------- HttpClient 4.2.2 (GA) is a bug fix release that addresses a number of issues reported since release 4.2.1. Users of HttpClient 4.2 are advised to upgrade. Changelog ------------------- * [HTTPCLIENT-1248] Default and lax redirect strategies should not convert requests redirected with 307 status to GET method. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1215] BasicAuthCache does not take default ports into consideration when looking up cached authentication details by HttpHost key. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1241] (regression) Preemptive BASIC authentication failure should be considered final and no further attempts to re-authenticate using the same credentials should be made. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1229] Fixed NPE in BasicClientConnectionManager that can be triggered by releasing connection after the connection manager has already been shut down. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1227] Date parsing in DateUtils made more efficient. Contributed by Patrick Linskey * [HTTPCLIENT-1224] (regression) NTLM auth not retried after a redirect over a non-persistent connection. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1223] Cache could be more aggressive on cache invalidations from Content-Location. Contributed by Jon Moore . Contributed by Jon Moore * [HTTPCLIENT-1217] AutoRetryHttpClient does not release connection used by the previous response when request is retried Contributed by Oleg Kalnichevski Release 4.2.1 ------------------- HttpClient 4.2.1 (GA) is a bug fix release that addresses a number of issues reported since release 4.2. Users of HttpClient 4.2 are advised to upgrade. Changelog ------------------- * [HTTPCLIENT-1209] Redirect URIs are now normalized. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1202] ResponseCachingPolicy should honor explicit cache-control directives for other status codes Contributed by Jon Moore * [HTTPCLIENT-1199] DecompressingHttpClient strips content from entity enclosing requests Contributed by Oleg Kalnichevski * [HTTPCLIENT-1198] HttpHost is not set in HttpContext in CachingHttpClient. Contributed by Jon Moore * [HTTPCLIENT-1200] DecompressingHttpClient fails to generate correct HttpHost context attribute. Contributed by Guillaume Castagnino * [HTTPCLIENT-1192] URIBuilder encodes query parameters twice. Contributed by Oleg Kalnichevski and Sebastian Bazley . * [HTTPCLIENT-1196] Fixed NPE in UrlEncodedFormEntity constructor thrown if charset is null. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1193] Fixed regression in the route tracking logic of the default connection manager causing cross-site redirect failures. Contributed by Oleg Kalnichevski Release 4.2 ------------------- This is the first stable (GA) release of HttpClient 4.2. The most notable enhancements included in this release are: * New facade API for HttpClient based on the concept of a fluent interface. The fluent API exposes only the most fundamental functions of HttpClient and is intended for relatively simple use cases that do not require the full flexibility of HttpClient. However, the fluent API almost fully relieves the users from having to deal with connection management and resource deallocation. * Redesigned and rewritten connection management code. * Enhanced HTTP authentication API that enables HttpClient to handle more complex authentication scenarios. HttpClient 4.2 is now capable of making use of multiple authentication challenges and retry authentication with a fall-back scheme in case the primary one fails. This can be important for compatibility with Microsoft products that are often configured to use SPNEGO/Kerberos as the preferred authentication scheme. Changelog ------------------- * [HTTPCLIENT-1187] If a revalidation response is deemed too old CachingHttpClient fails to consume its content resulting in a connection leak. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1186] State of newly created connections in the connection pool is not always correctly updated potentially allowing those connections to be leased to users with a different security context. Contributed by Ralf Poehlmann * [HTTPCLIENT-1179] Upgraded Commons Codec dependency to version 1.6 Contributed by Oleg Kalnichevski * [HTTPCLIENT-1177] always remove fragments from request URIs Contributed by Oleg Kalnichevski Incompatible changes -------------------- [Compared to release version 4.1.3] The following fields have been deprecated for some time now and have been deleted: org.apache.http.client.params.ClientPNames#CONNECTION_MANAGER_FACTORY org.apache.http.impl.cookie.BrowserCompatSpec#DATE_PATTERNS The following methods have been deprecated for some time now and have been deleted: org.apache.http.client.params.ClientParamBean#setConnectionManagerFactory(org.apache.http.conn.ClientConnectionManagerFactory) org.apache.http.client.protocol.ClientContextConfigurer#setAuthSchemePref(java.util.List) org.apache.http.entity.mime.content.FileBody#writeTo(java.io.OutputStream, int) org.apache.http.entity.mime.content.InputStreamBody#writeTo(java.io.OutputStream, int) org.apache.http.entity.mime.content.StringBody#writeTo(java.io.OutputStream, int) The following classes have been deprecated for some while now and have been deleted: org.apache.http.impl.conn.tsccm.RefQueueHandler org.apache.http.impl.conn.tsccm.AbstractConnPool no longer implements interface org.apache.http.impl.conn.tsccm.RefQueueHandler org.apache.http.impl.conn.tsccm.ConnPoolByRoute no longer implements interface org.apache.http.impl.conn.tsccm.RefQueueHandler org.apache.http.impl.conn.tsccm.RefQueueWorker Release 4.2 BETA1 ------------------- This is the first BETA release of HttpClient 4.2. This release completes development of several notable enhancements in HttpClient: * New facade API for HttpClient based on the concept of a fluent interface. The fluent API exposes only the most fundamental functions of HttpClient and is intended for relatively simple use cases that do not require the full flexibility of HttpClient. However, the fluent API almost fully relieves the users from having to deal with connection management and resource deallocation. * Redesigned and rewritten connection management code. As of release 4.2 HttpClient will be using pooling connection manager per default. * Enhanced HTTP authentication API that enables HttpClient to handle more complex authentication scenarios. HttpClient 4.2 is now capable of making use of multiple authentication challenges and retry authentication with a fall-back scheme in case the primary one fails. This can be important for compatibility with Microsoft products that are often configured to use SPNEGO/Kerberos as the preferred authentication scheme. Changelog ------------------- * [HTTPCLIENT-1164] Compressed entities are not being cached properly. Contributed by Jon Moore . * [HTTPCLIENT-1154] MemcachedHttpCacheStorage should allow client to specify custom prefix string for keys. Contributed by Jon Moore . * [HTTPCLIENT-1153] MemcachedHttpCacheStorage uses URL as cache key; shouldn't due to fixed maximum-length memcached keys. Contributed by Jon Moore . * [HTTPCLIENT-1157] MemcachedHttpCacheStroage should throw IOExceptions instead of RuntimeExceptions. Contributed by James Miller . * [HTTPCLIENT-1152] MemcachedHttpCacheStorage should verify class of returned object before casting. Contributed by Rajika Kumarasiri . * [HTTPCLIENT-1155] CachingHttpClient fails to ensure that the response content gets fully consumed when using a ResponseHandler, which can potentially lead to connection leaks. Contributed by James Miller * [HTTPCLIENT-1147] When HttpClient-Cache cannot open cache file, should act like miss. Contributed by Joe Campbell * [HTTPCLIENT-1137] Values for the Via header are cached and reused by httpclient-cache. Contributed by Alin Vasile * [HTTPCLIENT-1142] Infinite loop on NTLM authentication failure. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1143] CachingHttpClient leaks connections with stale-if-error. Contributed by James Miller Release 4.2 ALPHA1 ------------------- This is the first ALPHA release of HttpClient 4.2. The 4.2 branch enhances HttpClient in several key areas and includes several notable features and improvements: * New facade API for HttpClient based on the concept of a fluent interface. The fluent API exposes only the most fundamental functions of HttpClient and is intended for relatively simple use cases that do not require the full flexibility of HttpClient. However, the fluent API almost fully relieves the users from having to deal with connection management and resource deallocation. * Redesigned and rewritten connection management code. As of release 4.2 HttpClient will be using pooling connection manager per default. * Enhanced HTTP authentication API that enables HttpClient to handle more complex authentication scenarios. HttpClient 4.2 is now capable of making use of multiple authentication challenges and retry authentication with a fall-back scheme in case the primary one fails. This can be important for compatibility with Microsoft products that are often configured to use SPNEGO/Kerberos as the preferred authentication scheme. Please note that new features included in this release are still considered experimental and their API may change in the future ALPHA releases. Changelog ------------------- * [HTTPCLIENT-1128] SystemDefaultHttpClient (HttpClient implementation initialized using system properties). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1135] RandomAccessFile mode 'w' used by HttpClientCache is not valid. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1131] HttpClient to authenticate preemptively using BASIC scheme if a userinfo attribute is specified in the request URI. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1134] make BasicResponseHandler consume response content in case of an unsuccessful result (status code >= 300). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1132] ProxyClient implementation. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1127] fixed dead-lock between SingleClientConnManager and AbstractPooledConnAdapter. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1107] Auth framework redesign. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1116] ResponseCachingPolicy uses integers for sizes Contributed by Greg Bowyer * [HTTPCLIENT-1123] Support for pluggable DNS resolvers. Contributed by Alin Vasile * [HTTPCLIENT-1120] DefaultHttpRequestRetryHandler#retryRequest should not retry aborted requests. Contributed by Alin Vasile * Support for auth-int qop (quality of protection) option in Digest auth scheme. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1076] Fluent facade API (Google summer of code 2011 project). Contributed by Xu Lilu * UriBuilder implementation. Contributed by Xu Lilu * Redesign of connection management classes based on new pooling components from HttpCore. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1111] Added #prepareSocket method to SSLSocketFactory. Contributed by Pasi Eronen * Added #reset() and #releaseConnection() methods to HttpRequestBase. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1105] AutoRetryHttpClient: built-in way to do auto-retry for certain status codes. Contributed by Dan Checkoway * [HTTPCLIENT-1094] Digest auth scheme refactoring. Contributed by Oleg Kalnichevski * Lax implementation of RedirectStrategy. Contributed by Bartosz Firyn * [HTTPCLIENT-1044] HttpRequestRetryHandler implementation compliant with the definition of idempotent methods given in the RFC 2616. Contributed by Oleg Kalnichevski Release 4.1.2 ------------------- The HttpClient 4.1.2 is a bug fix release that addresses a number of non-critical issues reported since release 4.1.1. * [HTTPCLIENT-1100] Missing Content-Length header makes cached entry invalid Contributed by Bart Robeyns * [HTTPCLIENT-1098] Avoid expensive reverse DNS lookup on connect timeout exception. Contributed by Thomas Boettcher * [HTTPCLIENT-1097] BrowserCompatHostnameVerifier and StrictHostnameVerifier should handle wildcards in SSL certificates better. Contributed by Sebastian Bazley * [HTTPCLIENT-1092] If ClientPNames.VIRTUAL_HOST does not provide the port, derive it from the current request. Contributed by Sebastian Bazley * [HTTPCLIENT-1087] NTLM proxy authentication fails on retry if the underlying connection is closed as a result of a target authentication failure. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1079] Fixed Kerberos cross-realm support Contributed by Michael Osipov <1983-01-06 at gmx.net> * [HTTPCLIENT-1078] Decompressing entities (DeflateDecompressingEntity, GzipDecompressingEntity) do not close content stream in #writeTo() method. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1075] Decompressing entities (DeflateDecompressingEntity, GzipDecompressingEntity) do not correctly handle content streaming. Contributed by James Abley * [HTTPCLIENT-1051] Avoid reverse DNS lookups when opening SSL connections by IP address. Contributed by Oleg Kalnichevski Release 4.1.1 ------------------- HttpClient v4.1.1 is a bug fix release that addresses a number of issues reported since release 4.1, including one critical security issue (HTTPCLIENT-1061). All users of HttpClient 4.0.x and 4.1 are strongly encouraged to upgrade. * [HTTPCLIENT-1069] HttpHostConnectException not correctly retried for direct and non-tunnelled proxy connections. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1066] Changed the way URIUtils#rewriteURI handles multiple consecutive slashes in the URI path component: multiple leading slashes will be replaced by one slash in order to avoid confusion with the authority component. The remaining content of the path will not be modified. (also see HTTPCLIENT-929). Contributed by Oleg Kalnichevski * [HTTPCLIENT-1061] Fixed critical bug causing Proxy-Authorization header to be sent to the target host when tunneling requests through a proxy server that requires authentication. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1056] Fixed bug causing the RequestAuthCache protocol interceptor to generate an invalid AuthScope instance when looking up user credentials for preemptive authentication. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1053] Fixed the way DigestScheme generates nonce-count values. Contributed by Oleg Kalnichevski Release 4.1 ------------------- The HttpClient 4.1 release builds upon the stable foundation laid by HttpClient 4.0 and adds several functional improvements and popular features. * Response caching conditionally compliant with HTTP/1.1 specification (full compliance with MUST requirements, partial compliance with SHOULD requirements) * Full support for NTLMv1, NTLMv2, and NTLM2 Session authentication. The NTLM protocol code was kindly contributed by the Lucene Connector Framework project. * Support for SPNEGO/Kerberos authentication. * Persistence of authentication data between request executions within the same execution context. * Support for preemptive authentication for BASIC and DIGEST schemes. * Support for transparent content encoding. Please note transparent content encoding is not enabled per default in order to avoid conflicts with already existing custom content encoding solutions. * Mechanism to bypass the standard certificate trust verification (useful when dealing with self-signed certificates). * Simplified configuration for connection managers. * Transparent support for host multihoming. IMPORTANT: please note that the HttpClient 3.x branch is now officially END OF LIFE and is no longer maintained and supported by the Apache HttpComponents project. Changelog ------------------- * The public API for the caching module had a minor change between 4.1-beta and 4.1-GA to the HttpCacheEntry class - the deprecated public Set getVariantURIs() method and constructor public HttpCacheEntry(Date requestDate, Date responseDate, StatusLine statusLine, Header[] responseHeaders, Resource resource, Set variants) were both removed. This will not affect you unless you are implementing new storage backends that use the deprecated code and/or are implementing custom serializers for cache entries. * Changed Browser-Compatibility and Best-Match cookie policies to emulate the behaviour of FireFox more closely when parsing Netscape style cookies. Comma will no longer be treated as a header element separator if Set-Cookie does not contain a Version attribute mandated by the RFC2109 / RFC 2965 cookie specifications. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1036] StringBody has incorrect default for characterset. (Default changed to US-ASCII) Contributed by Sebastian Bazley * [HTTPCLIENT-975] Support stale-if-error and stale-while-revalidate extension directive (RFC5861). Contributed by Mohammed Azeem Uddin , Michajlo Matijkiw , and Matthew Hawthorne . * [HTTPCLIENT-1033] HttpRoute.equals(Object o) is quite inefficient, as it does not take full advantage of shortcut logic. Contributed by Sebastian Bazley * [HTTPCLIENT-1030] Implement "ignoreCookies" CookieSpec Contributed by Sebastian Bazley Release 4.1 BETA1 ------------------- HttpClient 4.1 BETA1 finalizes the 4.1 API and brings a number of major improvements to the HTTP caching module. This release also adds full support for NTLMv1, NTLMv2, and NTLM2 Session authentication. The NTLM protocol code was kindly contributed by the Lucene Connector Framework project. Changelog ------------------- * [HTTPCLIENT-1015] Support only-if-cached directive. Contributed by Michajlo Matijkiw * [HTTPCLIENT-990] Allow heuristic freshness caching. Contributed by Michajlo Matijkiw * [HTTPCLIENT-919] Support for NTLMv1, NTLMv2, and NTLM2 Session authentication. Contributed by Karl Wright * [HTTPCLIENT-1008] Send all variants' ETags on "variant miss". Contributed by Michajlo Matijkiw and Mohammed Azeem Uddin * [HTTPCLIENT-1011] Handling of IOExceptions thrown by cache components. Contributed by Jonathan Moore * [HTTPCLIENT-1003] Handle conditional requests in cache. Contributed by Michajlo Matijkiw and Mohammed Azeem Uddin * [HTTPCLIENT-1002] Stale connection check fails if wire logging is on. Contributed by Oleg Kalnichevski * [HTTPCLIENT-1000] Maximum connection lifetimes settings for ThreadSafeClientConnManager. Contributed by Michajlo Matijkiw * [HTTPCLIENT-960] HttpMultipart doesn't generate Content-Type header for binary parts in BROWSER_COMPATIBLE mode. Contributed by Oleg Kalnichevski * [HTTPCLIENT-998] Cache should use both Last-Modified and ETag for validations when available. Contributed by Jonathan Moore * [HTTPCLIENT-997] Cache module should handle out-of-order validations properly and unconditionally refresh. Contributed by Jonathan Moore * [HTTPCLIENT-994] Cache does not allow client to override origin-specified freshness using max-stale. Contributed by Jonathan Moore * [HTTPCLIENT-995] Cache returns cached responses even if validators not consistent with all conditional headers. Contributed by Jonathan Moore * [HTTPCLIENT-977] Memcached implementation for HttpCache. Contributed by Mohammed Azeem Uddin * [HTTPCLIENT-992] cache should not generate stale responses to requests explicitly requesting first-hand or fresh ones. Contributed by Jonathan Moore * [HTTPCLIENT-991] cache module produces improperly formatted Warning header when revalidation fails. Contributed by Jonathan Moore * [HTTPCLIENT-989] DefaultHttpRequestRetryHandler no longer retries non-idempotent http methods if NoHttpResponseException is thrown. Contributed by Oleg Kalnichevski * [HTTPCLIENT-988] Cache module should strip 'Content-Encoding: identity' from responses Contributed by Jonathan Moore * [HTTPCLIENT-987] cache module does not recognize equivalent URIs. Contributed by Jonathan Moore * [HTTPCLIENT-986] cache module does not completely handle upstream Warning headers correctly Contributed by Jonathan Moore * [HTTPCLIENT-985] cache module should populate Via header to capture upstream and downstream protocols Contributed by Jonathan Moore * [HTTPCLIENT-984] Additional conditional compliance tests for the caching module for Content-Encoding, Content-Location, Date, Expires, Server, Transfer-Encoding, and Vary headers. Contributed by Jonathan Moore * [HTTPCLIENT-978] HTTP cache update exception handling Contributed by Michajlo Matijkiw * [HTTPCLIENT-981] CachingHttpClient returns a 411 respones when executing a POST (HttpPost) request. Contributed by Joe Campbell * [HTTPCLIENT-980] CachingHttpClient returns a 503 response when the backend HttpClient produces an IOException. Contributed by Jonathan Moore * [HTTPCLIENT-978] Ehcache based HTTP cache implementation Contributed by Michajlo Matijkiw * [HTTPCLIENT-967] support for non-shared (private) caches Contributed by Jonathan Moore * [HTTPCLIENT-969] BasicCookieStore#getCookies() to return a copy of Cookie list Contributed by David Smiley * [HTTPCLIENT-965] Fixed problem with cache not honoring must-revalidate or proxy-revalidate Cache-Control directives. Contributed by Jonathan Moore * [HTTPCLIENT-964] 'no-cache' directives with field names are no longer transmitted downstream. Contributed by Jonathan Moore * [HTTPCLIENT-963] Fixed handling of 'Cache-Control: no-store' on requests. Contributed by Jonathan Moore * [HTTPCLIENT-962] Fixed handling of Authorization headers in shared cache mode. Contributed by Jonathan Moore * [HTTPCLIENT-961] Not all applicable URIs are invalidated on PUT/POST/DELETEs that pass through client cache. Contributed by Jonathan Moore * [HTTPCLIENT-958] Client cache no longer allows incomplete responses to be passed on to the client. Contributed by Jonathan Moore * [HTTPCLIENT-951] Non-repeatable entity enclosing requests are not correctly retried when 'expect-continue' handshake is active. Contributed by Oleg Kalnichevski * [HTTPCLIENT-948] In rare circumstances the idle connection handling code can leave closed connections in a inconsistent state. Contributed by Oleg Kalnichevski * [HTTPCLIENT-953] IllegalStateException thrown by RouteSpecificPool. Contributed by Guillaume * [HTTPCLIENT-952] Trust store parameter is ignored by SSLSocketFactory (affects version 4.1-alpha2 only) Contributed by Oleg Kalnichevski * [HTTPCLIENT-937] CacheEntry made immutable; now uses immutable HttpEntity to store cached content. Contributed by David Mays and Oleg Kalnichevski Release 4.1 ALPHA2 ------------------- HttpClient 4.1 ALPHA2 fixes a number of non-severe bugs discovered since the last release and introduces support for two frequently requested features: * HTTP/1.1 response caching * transparent support for host multihoming * a mechanism to bypass the standard certificate trust verification (useful when dealing with self-signed certificates) Compatibility notes ------------------- (1) Please note the HTTP caching module is still considered experimental and its API may change significantly in the future releases. (2) This release eliminates Mime4J as a dependency for the HttpMime module. HttpMime is no longer binary compatible with the previous releases. Full API and binary compatibility between minor versions of HttpMime will be maintained as of 4.1 GA release. Changelog ------------------- * [HTTPCLIENT-936] Fixed bug causing NPE or an infinite loop in the authentication code in case of a SPNEGO authentication failure. Contributed by Oleg Kalnichevski * [HTTPCLIENT-427] HTTP caching support Contributed by Joe Campbell, David Cleaver, David Mays, Jon Moore, Brad Spenla * Dropped dependency on Mime4j for HttpMime. Contributed by Oleg Kalnichevski * Extended SSLSocketFactory with a mechanism to bypass the standard certificate trust verification (primarily to simplify dealing with self-signed certificates) Contributed by Oleg Kalnichevski * [HTTPCLIENT-898] Improved support for host multihoming Contributed by Oleg Kalnichevski * [HTTPCLIENT-916] UsernamePasswordCredentials, NTUserPrincipal, BasicClientCookie, BasicClientCookie2 and BasicCookieStore made Serializable. Contributed by Oleg Kalnichevski * [HTTPCLIENT-914] Upgraded Commons Codec dependency to version 1.4 Contributed by Oleg Kalnichevski * [HTTPCLIENT-903] Use ConcurrentHashMap instead of [Linked]HashMap for thread-safety. Improve performance of AuthSchemeRegistry, CookieSpecRegistry and SchemeRegistry classes. Contributed by Sebastian Bazley * [HTTPCLIENT-902] HttpRequestRetryHandler not called on I/O exceptions thrown when opening a new connection. Contributed by Olivier Lamy and Oleg Kalnichevski Release 4.1 ALPHA1 ------------------- HttpClient 4.1 ALPHA1 builds on the stable 4.0 release and adds several functionality improvements and new features. * Simplified configuration of connection managers. * Persistence of authentication data between request executions within the same execution context. * Support for SPNEGO/Kerberos authentication scheme * Support for transparent content encoding. Please note transparent content encoding is not enabled per default in order to avoid conflicts with already existing custom content encoding solutions. * 5 to 10% performance increase due to elimination of unnecessary Log object lookups by short-lived components. Please note all methods and classes added in this release and marked as 4.1 are API unstable and can change in the future 4.1 ALPHA releases. Changelog ------------------- * [HTTPCLIENT-889] 'expect: continue' handshake disabled per default. Contributed by Oleg Kalnichevski * [HTTPCLIENT-862] Extended client's redirect handling interface to allow control of the content of the redirect. Contributed by Oleg Kalnichevski * [HTTPCLIENT-872] HttpClient can now persist authentication data between request executions as long as they share the same execution context. It has also become much easier to make HttpClient authenticate preemptively by pre-populating authentication data cache. Contributed by Oleg Kalnichevski * [HTTPCLIENT-883] SO_TIMEOUT is not reset on persistent (re-used) connections. Contributed by Oleg Kalnichevski * [HTTPCLIENT-832] Distinguish cookie format errors from violations of restrictions imposed by a cookie specification. In the latter case CookieRestrictionViolationException will be thrown. Contributed by Oleg Kalnichevski * [HTTPCLIENT-523] Support for SPNEGO authentication scheme. Contributed by Matthew Stevenson * Simplified configuration of connection managers. Total connection maximum and maximum connection per route limits can be set using methods of the class instead of HTTP parameters. Contributed by Oleg Kalnichevski * Added parameters to define the order of preference for supported auth schemes for target host and proxy authentication. Contributed by Oleg Kalnichevski * [HTTPCLIENT-875] DefaultClientConnectionOperator#openConnection doesn't update the connection state if the connection socket changed after the call to SocketFactory#connectSocket(). Contributed by Oleg Kalnichevski * [HTTPCLIENT-834] Transparent content encoding support. Contributed by James Abley Release 4.0.1 ------------------- This is a bug fix release that addresses a number of issues discovered since the previous stable release. None of the fixed bugs is considered critical. Most notably this release eliminates eliminates dependency on JCIP annotations. This release is also expected to improve performance by 5 to 10% due to elimination of unnecessary Log object lookups by short-lived components. Changelog ------------------- * [HTTPCLIENT-895] Eliminated Log lookups in short lived objects impairing performance. Contributed by Oleg Kalnichevski * [HTTPCLIENT-885] URLEncodedUtils now correctly parses form-url-encoded entities that specify a charset. Contributed by Oleg Kalnichevski * [HTTPCLIENT-884] UrlEncodedFormEntity now sets charset on the Content-Type header. Contributed by Jared Jacobs * [HTTPCLIENT-883] SO_TIMEOUT is not reset on persistent (re-used) connections. Contributed by Oleg Kalnichevski * [HTTPCLIENT-882] Auth state is now correctly updated if a successful NTLM authentication results in a redirect. This is a minor bug as HttpClient manages to recover from the problem automatically. Contributed by Oleg Kalnichevski * [HTTPCLIENT-881] Fixed race condition in AbstractClientConnAdapter that makes it possible for an aborted connection to be returned to the pool. Contributed by Tim Boemker and Oleg Kalnichevski * [HTTPCLIENT-866] Removed dependency on jcip-annotations.jar. Contributed by Oleg Kalnichevski and Sebastian Bazley Release 4.0 ------------------- HttpClient 4.0 represents a complete, ground-up redesign and almost a complete rewrite of the HttpClient 3.x codeline. This release finally addresses several design flaws that existed since the 1.0 release and could not be fixed without a major code overhaul and breaking API compatibility. Architectural changes --------------------- * Redesign of the HttpClient internals addressing all known major architectural shortcomings of the 3.x codeline. * Cleaner, more flexible and expressive API. * More modular structure. * Better performance and smaller memory footprint due to a more efficient HTTP transport based on HttpCore. * Implementation of cross-cutting HTTP protocol aspects through protocol interceptors. * Improved connection management, better handling of persistent connections, support for stateful connections * Pluggable redirect and authentication handlers. * Improved support for sending requests via a proxy or a chain of proxies * More flexible SSL context customization * Reduced intermediate garbage in the process of generating HTTP requests and parsing HTTP responses Important notes ------------------- * Future releases of HttpMime module may be binary incompatible with this release due to possible API changes in Apache Mime4J. Apache Mime4J is still being actively developed and its API is considered unstable. * HttpClient 4.0 is not fully binary compatible with 4.0 BETA1 release. Some protected variables in connection management class have been made final in order to help ensure their thread safety: org.apache.http.conn.BasicEofSensorWatcher#attemptReuse org.apache.http.conn.BasicEofSensorWatcher#managedConn org.apache.http.impl.conn.DefaultClientConnectionOperator#schemeRegistry org.apache.http.impl.conn.DefaultHttpRoutePlanner#schemeRegistry org.apache.http.impl.conn.ProxySelectorRoutePlanner#schemeRegistry org.apache.http.impl.conn.SingleClientConnManager#alwaysShutDown org.apache.http.impl.conn.SingleClientConnManager#connOperator org.apache.http.impl.conn.SingleClientConnManager#schemeRegistry org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager#connOperator org.apache.http.impl.conn.tsccm.ThreadSafeClientConnManager#schemeRegistry Bug fixes since 4.0 BETA2 release ------------------- * [HTTPCLIENT-861] URIUtils#resolve is now compatible with all examples given in RFC 3986. Contributed by Johannes Koch * [HTTPCLIENT-860] HttpClient no longer converts redirects of PUT/POST to GET for status codes 301, 302, 307, as required by the HTTP spec. Contributed by Oleg Kalnichevski * [HTTPCLIENT-859] CookieIdentityComparator now takes path attribute into consideration when comparing cookies. Contributed by Oleg Kalnichevski * HttpClient will no longer send expired cookies back to the origin server. Contributed by Oleg Kalnichevski * [HTTPCLIENT-856] Proxy NTLM authentication no longer fails on a redirect to a different host. Contributed by Oleg Kalnichevski * [HTTPCLIENT-841] Removed automatic connection release using garbage collection due to a memory leak. Contributed by Oleg Kalnichevski * [HTTPCLIENT-853] Fixed bug causing invalid cookie origin port to be selected when the target is accessed on the default port and the connection is established via a proxy. Contributed by Oleg Kalnichevski * [HTTPCLIENT-852] Fixed bug causing automatically retried redirects fail with CircularRedirectException. Contributed by Oleg Kalnichevski * Fixed problem with the default HTTP response parser failing to handle garbage preceding a valid HTTP response. Contributed by Oleg Kalnichevski * NonRepeatableRequestExceptions now include the cause that the original request failed. Contributed by Sam Berlin * [HTTPCLIENT-837] Fixed problem with the wire log skipping zero byte values if read one byte at a time. Contributed by Kirill Safonov * [HTTPCLIENT-823] 'http.conn-manager.max-total' parameter can be adjusted dynamically. However, the size of existing connection pools per route, once allocated, will not be adjusted. Contributed by Oleg Kalnichevski * [HTTPCLIENT-822] Default socket factories to rethrow SocketTimeoutException as ConnectTimeoutException in case of connect failure due to a time out. Contributed by Oleg Kalnichevski * [HTTPCLIENT-813] Fixed default port resolution. Invalid ports no longer get replaced with the default port value. Contributed by Oleg Kalnichevski Release 4.0 beta 2 ------------------- BETA2 is a maintenance release, which addresses a number of issues discovered since the previous release. The only significant new feature is an addition of an OSGi compliant bundle combining HttpClient and HttpMime jars. All upstream projects are strongly encouraged to upgrade. * Fixed NPE in DefaultRequestDirector thrown when retrying a failed request over a proxied connection. Contributed by Oleg Kalnichevski * [HTTPCLIENT-803] Fixed bug in SSL host verifier implementations causing the SSL certificate to be rejected as invalid if the connection is established using an IP address. Contributed by Oleg Kalnichevski * [HTTPCLIENT-806] DefaultHttpMethodRetryHandler will no longer retry on ConnectExceptions. Contributed by Oleg Kalnichevski * DigestScheme can use an arbitrary digest algorithm requested by the target server (such as SHA) as long as this algorithm is supported by the Java runtime. Contributed by Oleg Kalnichevski * Fixed parsing and validation of RFC2109 compliant Set-Cookie headers by the Best-Match cookie spec. Contributed by Oleg Kalnichevski * Fixed bug that can cause a managed connection to be returned from the pool in an inconsistent state. Contributed by Oleg Kalnichevski 4.0 Beta 1 ------------------- BETA1 release brings yet another round of API enhancements and improvements in the area of connection management. Among the most notable ones is the capability to handle stateful connections such as persistent NTLM connections and private key authenticated SSL connections. This is the first API stable release of HttpClient 4.0. All further releases in the 4.0 code line will maintain API compatibility with this release. There has been a number of important bug fixes since ALPHA4. All upstream projects are encouraged to upgrade to the latest release. Please note HttpClient currently provides only limited support for NTLM authentication. For details please see NTLM_SUPPORT.txt. ------------------- Changelog: ------------------- * [HTTPCLIENT-790] Protocol interceptors are now correctly invoked when executing CONNECT methods. Contributed by Oleg Kalnichevski * [HTTPCLIENT-668] Do not use static loggers. Contributed by Oleg Kalnichevski * [HTTPCLIENT-781] Respect Keep-Alive header's timeout value. Contributed by Sam Berlin * [HTTPCLIENT-779] Top-level classes (HttpClient, and HttpGet, HttpPut and similar HttpMethods) throw fewer checked exceptions. Contributed by Sam Berlin * HttpClient will throw an exception if an attempt is made to retry a request with a non-repeatable request entity. Contributed by Oleg Kalnichevski * Fixed request re-generation logic when retrying a failed request. Auto-generated headers will no accumulate. Contributed by Oleg Kalnichevski * [HTTPCLIENT-424] Preemptive authentication no longer limited to BASIC scheme only. HttpClient can be customized to authenticate preemptively with DIGEST scheme. Contributed by Oleg Kalnichevski * [HTTPCLIENT-670] Pluggable hostname resolver. Contributed by Oleg Kalnichevski * [HTTPCLIENT-719] Clone support for HTTP request and cookie objects. Contributed by Oleg Kalnichevski * [HTTPCLIENT-776] Fixed concurrency issues with AbstractPoolEntry. Contributed by Sam Berlin * Resolved a long standing problem with HttpClient not taking into account the user context when pooling / re-using connections. HttpClient now correctly handles stateful / user specific connections such as persistent NTLM connections and SSL connections with client side authentication. Contributed by Oleg Kalnichevski * [HTTPCLIENT-773] Improved handling of the 'expires' attribute by the 'Best Match' cookie spec. Contributed by Oleg Kalnichevski * Partial NTLM support (requires an external NTLM engine). For details see NTLM_SUPPORT.txt Contributed by Oleg Kalnichevski * Redesigned local execution context management. Contributed by Oleg Kalnichevski -------------------------------------- Release 4.0 Alpha 4 ------------------- ALPHA4 marks the completion of the overhaul of the connection management code in HttpClient. All known shortcomings of the old HttpClient 3.x connection management API have been addressed. NTLM authentication remains the only missing major feature in the new codeline that prevents us from moving awards the API freeze. There has been a number of important bug fixes since ALPHA3. All upstream projects are encouraged to upgrade to the latest release. ------------------- HttpClient 3.x features that have NOT yet been ported: ------------------- * NTLM authentication scheme ------------------- Changelog: ------------------- * [HTTPCLIENT-765] String.toLowerCase() / toUpperCase() should specify Locale.ENGLISH Contributed by Sebastian Bazley * [HTTPCLIENT-769] Do not pool connection marked non-reusable. Contributed by Oleg Kalnichevski * [HTTPCLIENT-763] Fixed problem with AbstractClientConnAdapter#abortConnection() not releasing the connection if called from the main execution thread while there is no blocking I/O operation. Contributed by Oleg Kalnichevski * [HTTPCLIENT-652] Added optional state attribute to managed client connections. This enables connection managers to correctly handle stateful connections. Contributed by Oleg Kalnichevski * [HTTPCLIENT-673] Revised max connections per route configuration Contributed by Oleg Kalnichevski * [HTTPCLIENT-753] Class Scheme and related classes moved to a separate package Contributed by Oleg Kalnichevski * [HTTPCLIENT-757] Improved request wrapping in the DefaultClientRequestDirector. This also fixed the problem with the default proxy set at the client level having no effect. Contributed by Oleg Kalnichevski * [HTTPCLIENT-734] Request abort will unblock the thread waiting for a connection Contributed by Sam Berlin * [HTTPCLIENT-759] Ensure release of connections back to the connection manager on exceptions. Contributed by Sam Berlin * [HTTPCLIENT-758] Fixed the use of generics in AbstractHttpClient #removeRequestInterceptorByClass and #removeResponseInterceptorByClass Contributed by Johannes Koch * [HTTPCLIENT-749] HttpParams beans Contributed by Stojce Dimski * [HTTPCLIENT-755] Workaround for known bugs in java.net.URI.resolve() Bug ID: 4708535 Contributed by Johannes Koch -------------------------------------- Release 4.0 Alpha 3 ------------------- ALPHA3 release brings another round of API refinements and improvements in functionality. As of this release HttpClient requires Java 5 compatible runtime environment and takes full advantage of generics and new concurrency primitives. This release also introduces new default cookie policy that selects a cookie specification depending on the format of cookies sent by the target host. It is no longer necessary to know beforehand what kind of HTTP cookie support the target host provides. HttpClient is now able to pick up either a lenient or a strict cookie policy depending on the compliance level of the target host. Another notable improvement is a completely reworked support for multipart entities based on Apache mime4j library. ------------------- HttpClient 3.x features that have NOT yet been ported: ------------------- * NTLM authentication scheme ------------------- Changelog: ------------------- * [HTTPCLIENT-742] common interface for HttpRoute and RouteTracker Contributed by Roland Weber * [HTTPCLIENT-741] Fixed concurrency issues in AbstractClientConnAdapter. Contributed by Oleg Kalnichevski * [HTTPCLIENT-726] testcase for spurious wakeups in ThreadSafeClientConnManager Contributed by Roland Weber * [HTTPCLIENT-643] Automatic connect fail-over for multi-home remote servers. Contributed by Oleg Kalnichevski * [HTTPCLIENT-735] unsetting of DEFAULT_PROXY and FORCED_ROUTE in hierarchies Contributed by Roland Weber * [HTTPCLIENT-723] route planner based on java.net.ProxySelector Contributed by Roland Weber * [HTTPCLIENT-740] don't start connection GC thread in pool constructor Contributed by Roland Weber * [HTTPCLIENT-736] route planners use SchemeRegistry instead of ConnManager Contributed by Roland Weber * [HTTPCLIENT-730] Fixed rewriting of URIs containing escaped characters Contributed by Sam Berlin and Oleg Kalnichevski * [HTTPCLIENT-667] Added 'Meta' cookie policy that selects a cookie specification depending on the format of the cookie(s). Contributed by Oleg Kalnichevski * [HTTPCLIENT-729] Move HttpRoute and related classes to routing package. Contributed by Roland Weber * [HTTPCLIENT-725] Use TimeUnit arguments for timeouts in connection manager. Contributed by Roland Weber * [HTTPCLIENT-677] Connection manager no longer uses Thread.interrupt(). Contributed by Roland Weber * [HTTPCLIENT-716] Allow application-defined routes. Contributed by Roland Weber * [HTTPCLIENT-712] Improve HttpRoute API Contributed by Roland Weber * [HTTPCLIENT-711] Bad route computed for redirected requests Contributed by Oleg Kalnichevski * [HTTPCLIENT-715] Remove RoutedRequest from API Contributed by Roland Weber * [HTTPCLIENT-705] Fixed incorrect handling of URIs with null path component. Contributed by Oleg Kalnichevski * [HTTPCLIENT-688] HttpOptions#getAllowedMethods can now handle multiple Allow headers. Contributed by Andrea Selva -------------------------------------- Release 4.0 Alpha 2 ------------------- ALPHA2 release is another milestone in the redesign of HttpClient. It includes a number of improvements since ALPHA1, among which are improved connection pooling, support for proxy chains, redesigned HTTP state and authentication credentials management API, improved RFC 2965 cookie specification. ------------------- HttpClient 3.x features that have NOT yet been ported ------------------- * NTLM authentication scheme * Support for multipart MIME coded entities ------------------- Changelog ------------------- * [HTTPCLIENT-698] Resolve non-absolute redirect URIs relative to the request URI Contributed by Johannes Koch * [HTTPCLIENT-697] Throw a more intelligible exception when connection to a remote host cannot be established. Contributed by Oleg Kalnichevski * [HTTPCLIENT-689] Caching of SimpleDateFormat in DateUtils Contributed by Daniel Müller * [HTTPCLIENT-689] stackable parameters in AbstractHttpClient Contributed by Roland Weber * [HTTPCLIENT-477] Use distinct instances of the authentication handler interface for authentication with target and proxy hosts Contributed by Oleg Kalnichevski * [HTTPCLIENT-690] ManagedClientConnection provides access to SSLSession Contributed by Roland Weber * [HTTPCLIENT-692] ClientConnectionManager throws InterruptedException Contributed by Roland Weber * [HTTPCORE-116] moved parameter names to interfaces Contributed by Roland Weber * [HTTPCLIENT-649] support for proxy chains in HttpConn Contributed by Roland Weber * [HTTPCLIENT-636] refactor ThreadSafeClientConnManager in separate package Contributed by Roland Weber * [HTTPCLIENT-669] new HttpRoutePlanner interface and implementation Contributed by Andrea Selva * [HTTPCLIENT-653] detached connection wrapper no longer prevents garbage collection of ThreadSafeClientConnManager Contributed by Roland Weber * [HTTPCLIENT-674] use org.apache.http.util.VersionInfo instead of a local one Contributed by Roland Weber * [HTTPCLIENT-666] Replaced HttpState with CredentialsProvier and CookieStore interfaces Contributed by Oleg Kalnichevski * [HTTPCORE-100] revised HttpContext hierarchy Contributed by Roland Weber * [HTTPCLIENT-618] eliminate class HostConfiguration Contributed by Roland Weber * [HTTPCLIENT-672] re-sync with API changes in core alpha6-SNAPSHOT Contributed by Roland Weber -------------------------------------- Release 4.0 Alpha 1 ------------------- HttpClient 4.0 represents a complete, ground-up redesign and almost a complete rewrite of the HttpClient 3.x codeline. This release finally addresses several design flaws that existed since the 1.0 release and could not be fixed without a major code overhaul and breaking API compatibility. The HttpClient 4.0 API is still very experimental and is bound to change during the course of the ALPHA development phase. Several important features have not yet been ported to the new API. Architectural changes --------------------- * Redesign of the HttpClient internals addressing all known major architectural shortcomings of the 3.x codeline * Cleaner, more flexible and expressive API * Better performance and smaller memory footprint due to a more efficient HTTP transport based on HttpCore. HttpClient 4.0 is expected to be 10% to 25% faster than HttpClient 3.x codeline * More modular structure * Pluggable redirect and authentication handlers * Support for protocol incerceptors * Improved connection management * Improved support for sending requests via a proxy or a chain of proxies * Improved handling redirects of entity enclosing requests * More flexible SSL context customization * Reduced intermediate garbage in the process of generating HTTP requests and parsing HTTP responses ------------------- HttpClient 3.x features that have NOT yet been ported ------------------- * NTLM authentication scheme * RFC2965 cookie policy (Cookie2) * Support for multipart MIME coded entities ------------------- Changelog ------------------- The following is a list of contributions tracked in JIRA. Note that this is not a complete list of contributions or changes. Since the API was redesigned completely, tracking everything outside of the source code repository would have been too burdensome. * [HTTPCLIENT-655] User-Agent string no longer violates RFC Contributed by Oleg Kalnichevski * [HTTPCLIENT-541] Virtual host API redesign Contributed by Oleg Kalnichevski * [HTTPCLIENT-614] Allow for different strategies when checking CN of x509 certificates Contributed by Julius Davies * [HTTPCLIENT-136] Fixed inadequate proxy support Long standing architectural problem. Issue opened on 19/Dec/2002. Contributed by Oleg Kalnichevski * [HTTPCLIENT-63] Support for pluggable redirect and authentication handlers Long standing architectural problem. Issue opened on 15/Jul/2002. Contributed by Oleg Kalnichevski * [HTTPCLIENT-245] Fixed redirect handling. HttpClient can now automatically handle redirects of entity enclosing requests. Long standing architectural problem. Issue opened on 14/Jul/2003. Contributed by Oleg Kalnichevski * [HTTPCLIENT-613] HTTPS connections now verify CN of x509 certificates Contributed by Julius Davies * [HTTPCLIENT-497] Wire/header logger names consistent with class loggers Contributed by Oleg Kalnichevski * [HTTPCLIENT-484] AuthSSLProtocolSocketFactory in the main distribution Contributed by Oleg Kalnichevski * [HTTPCLIENT-589] Do not consume the remaining response content if the connection is to be closed Contributed by Roland Weber * [HTTPCLIENT-475] Support for unconnected sockets. HTTP requests can now be aborted while network socket is still being connected. Contributed by Roland Weber test-CA/0040775 0000000 0000000 00000000000 15005672016 011054 5ustar000000000 0000000 test-CA/README.txt0100664 0000000 0000000 00000000456 14666635064 012572 0ustar000000000 0000000 This directory contains CA key and certificate for unit and integration tests --- Use this command to check the private key Passphrase: nopassword --- openssl rsa -in ca-key.pem -check -text -noout --- Use this command to print CA certificate details --- openssl x509 -in ca-cert.pem -text -noout ---test-CA/ca-key.pem0100664 0000000 0000000 00000003452 14666635064 012747 0ustar000000000 0000000 -----BEGIN ENCRYPTED PRIVATE KEY----- MIIFDjBABgkqhkiG9w0BBQ0wMzAbBgkqhkiG9w0BBQwwDgQIq0bLh96mWv4CAggA MBQGCCqGSIb3DQMHBAimZqUiELx13QSCBMgaLWrGFqveIzwQUsebS6FBdVq0lodz Vlekje8ycFDYSd21V9jPMwrSupZceeBQjCrpyLZ3oPkR+MvObmznev8XYcJzVCkF E9ApAaHZe248wWcu1/D7auHNG3GyZfvYS0c//Rs2OzMZfsUvX93RVullCRREvCYS qXhaO3ywFocndKRpSnkOBs2SRa0yc9POl4n4dwyKhsJUaMSmhPbJr9UBvCbXHZIA gLcSWzVon3EtZCSubMp9eo90G5MzIXEyPBTcIHwpyqRWTkaTUTq4R0c4/RTX+l7K OZuRIEeBEW6z009fSagymN/KEH3gUkg5pG6i1YWF63OVKTMGn+yQGWwYXwTyEGi5 HZpD98wh3ycucmL93XLk+yYXQcTp1i+u4GaXNWGREQvNW6onCGeg6WWj1PrIsqoi TZ2pgQUJWPR1K3037hY0o9sakAkyYSyTPVvHOUcbf3+GhqGS1FsSNOxKRNpYm/3v Gf0SUN8BavPliK9NSU5JAbprr/hoL5o72dCX9DiOgwfW3HyD/gLh7sVyVBdAzTnE XFaYFnrb5QnqHbgWvaLbJUT5K7MW3OFLVConydYtYdaUl5z49OflhgnvYOPgTSUr k9c7exQjedAduPd8dXODh9l2g+QEXJoT+YYFEYHkQlsZgH1hCLXD1TmAeI4LMklb vPaGE8Ouj1pfbejdTNsqLfW0IiR/jZzEjRgqrueMf2VUjtqTZyPayc2rU4kOoKhv JzQ0wOFhgRztWJy2voRe+iYss3ToqZ7qLpjBfCTsxCJqbuaGeJWWSnOlDpSysgr+ q4BvCzDcvf/0mKD2cQuJx/kynQMCcWB/VegRsQ24Y+3T7IU1w8ccmRfSZ93AwkAh MKJzKaVhD/gn9vUG/we18p7RMIc9pk1o2Z2Ru3mKjkO3QYRP6Y7yk0ah2JKrHIPf LWfPuHmtzHQXkY3RbVvxvwD/+qHm8ogXq52w8cpGhY5UwAEHrLLwypdBHccrAJjo bE13M/MrtTry/k8OMRqhhRzHUXBq6mLaWffCaP2SAVfJEez2iASvGJFvgy3bSkWY rwWMSfZKDkauwDMW5gpFrpeuqgD64LO72sN01riVDpaEyNODRCEEBGce+O+91R9K TLVgRYFsxClyZy1nynD66gkTepEm1yOgcdqV3651Os+TGm39jGYHy1k9mPz8ypqf 8n8uw4nV3SbIwfpy4Z8onHixfc/Fugm7yQHW4dSuCpahyIJHom6Cq7SZfPuo9e3t 8tqaxvK4U/dAXoimvN1eakH2FoVFIj3mk7OAKBgmDINH9GlzXPwRsTfiJSP4Xaod ouWIQLLeXQuuOc5VJd1Xex75o8ciSOomAS0uR4Fvk/2NkAm0EMddjZnuWLQaXPry JiUIgSx3w3yRq9RSQOxDRQpp2nP2roX7cyeGPzTmeujikExGTa3YBxuAShDLx5pt fpi0ol8H8ohDU4eV9pv96KRBG9e8sQf1zpGjeYLTFiN35IQxYJx3HTXp9/oFWkmA OdCEwggIKJ/RtgkWOWogTilQVA41p4XZr661fxoSE86sHXkZKn8IGnAKLFT46nWM IYVDalYUiSNZr+KbzmLIV3LmYE3mlqGI4vDvQtd9zQk/uatYBc2DetuTWPZHCEKS 3Nk= -----END ENCRYPTED PRIVATE KEY----- test-CA/ca-cert.pem0100664 0000000 0000000 00000002537 14666635064 013117 0ustar000000000 0000000 -----BEGIN CERTIFICATE----- MIIDyTCCArGgAwIBAgIJAO3mCIu9mboMMA0GCSqGSIb3DQEBCwUAMHoxIzAhBgNV BAoMGkFwYWNoZSBTb2Z0d2FyZSBGb3VuZGF0aW9uMR8wHQYDVQQLDBZIdHRwQ29t cG9uZW50cyBQcm9qZWN0MRAwDgYDVQQDDAdUZXN0IENBMSAwHgYJKoZIhvcNAQkB FhFkZXZAaGMuYXBhY2hlLm9yZzAgFw0xNDEwMTMxNTAxMjBaGA8yMjg4MDcyODE1 MDEyMFowejEjMCEGA1UECgwaQXBhY2hlIFNvZnR3YXJlIEZvdW5kYXRpb24xHzAd BgNVBAsMFkh0dHBDb21wb25lbnRzIFByb2plY3QxEDAOBgNVBAMMB1Rlc3QgQ0Ex IDAeBgkqhkiG9w0BCQEWEWRldkBoYy5hcGFjaGUub3JnMIIBIjANBgkqhkiG9w0B AQEFAAOCAQ8AMIIBCgKCAQEApXhHtKRvAxbLI+f21zNe68dkVXAhSMIfHQJGb2en S1H8yE4HPIb4vPQ0U7fQCb7RXplm6cHExpof4cO3DmyqD5KeQk0TdM8XrhviDgwj Y0KQ/lgwGHR5CpYoZ6LYWaLSE/wt9dVu80UcK8a3hW9G0X/4b79fMO6HYDix+CI4 b17sqZ4K0tWKA10Xe+2RJU8Y01pPBaPR/UsAn+a1pZ6f8BhL879oWHfLWKcgZOYP U4sYED0S8gs4/ED1zRj2/uHb313sHTl+OU4X5v+OvwBvbNBrl5qfMTZnRNxlOfRq UTJdcopsp2aNeqHiorSDOrHwMIJpxQ2XqHT2l9s8msXf4wIDAQABo1AwTjAdBgNV HQ4EFgQUA+Tn2g9k2xMevYWrdrwpyi+nx0swHwYDVR0jBBgwFoAUA+Tn2g9k2xMe vYWrdrwpyi+nx0swDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAFVEp 8Nv6JoFY7oGgu6068fH/kq7A3SllqMpbv7dddI9fgwy352cBtg6PkYkGtEE037xs FQSYV1NiAkNWTJER+Q+kVbQrhuPNKZqh1g0sUKwv3X20BmgJ9hbU9klWZjdjujyd h9Ybjuntkn5XPp1zN6zHD0sQReEJnRlD6FT1axrQWpICzE4qoo8k64G+6/rqFywc oMc/Of3KCAHjtbWklEu97hjBvGC/nEP4/VhRrjWWSeGHv88LCyO/Yg6v3zrZHFLW +KhsDCPyLxSSISFskLQfukiqf2lr87kQq/oF27sAr3sR3Jqh4qzflM2XLgjmZuRE OrHT6lvUemRyksA5qg== -----END CERTIFICATE----- test-CA/openssl.cnf0100664 0000000 0000000 00000026065 15005672016 013235 0ustar000000000 0000000 # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # # This definition stops the following lines choking if HOME isn't # defined. HOME = . RANDFILE = $ENV::HOME/.rnd # Extra OBJECT IDENTIFIER info: #oid_file = $ENV::HOME/.oid oid_section = new_oids # To use this configuration file with the "-extfile" option of the # "openssl x509" utility, name here the section containing the # X.509v3 extensions to use: # extensions = # (Alternatively, use a configuration file that has only # X.509v3 extensions in its main [= default] section.) [ new_oids ] # We can add new OIDs in here for use by 'ca', 'req' and 'ts'. # Add a simple OID like this: # testoid1=1.2.3.4 # Or use config file substitution like this: # testoid2=${testoid1}.5.6 # Policies used by the TSA examples. tsa_policy1 = 1.2.3.4.1 tsa_policy2 = 1.2.3.4.5.6 tsa_policy3 = 1.2.3.4.5.7 #################################################################### [ ca ] default_ca = CA_default # The default ca section #################################################################### [ CA_default ] dir = ./test-CA # Where everything is kept certs = $dir/certs # Where the issued certs are kept crl_dir = $dir/crl # Where the issued crl are kept database = $dir/index.txt # database index file. #unique_subject = no # Set to 'no' to allow creation of # several ctificates with same subject. new_certs_dir = $dir/newcerts # default place for new certs. certificate = $dir/ca-cert.pem # The CA certificate serial = $dir/serial.txt # The current serial number crlnumber = $dir/crlnumber # the current crl number # must be commented out to leave a V1 CRL crl = $dir/crl.pem # The current CRL private_key = $dir/ca-key.pem# The private key RANDFILE = $dir/.rand # private random number file x509_extensions = usr_cert # The extentions to add to the cert # Comment out the following two lines for the "traditional" # (and highly broken) format. name_opt = ca_default # Subject Name options cert_opt = ca_default # Certificate field options # Extension copying option: use with caution. copy_extensions = copy # Extensions to add to a CRL. Note: Netscape communicator chokes on V2 CRLs # so this is commented out by default to leave a V1 CRL. # crlnumber must also be commented out to leave a V1 CRL. # crl_extensions = crl_ext default_days = 365 # how long to certify for default_crl_days= 30 # how long before next CRL default_md = default # use public key default MD preserve = no # keep passed DN ordering # A few difference way of specifying how similar the request should look # For type CA, the listed attributes must be the same, and the optional # and supplied fields are just that :-) policy = policy_match # For the CA policy [ policy_match ] countryName = optional stateOrProvinceName = optional organizationName = match organizationalUnitName = optional commonName = supplied emailAddress = optional # For the 'anything' policy # At this point in time, you must list all acceptable 'object' # types. [ policy_anything ] countryName = optional stateOrProvinceName = optional localityName = optional organizationName = optional organizationalUnitName = optional commonName = supplied emailAddress = optional #################################################################### [ req ] default_bits = 2048 default_keyfile = privkey.pem distinguished_name = req_distinguished_name attributes = req_attributes x509_extensions = v3_ca # The extentions to add to the self signed cert # Passwords for private keys if not present they will be prompted for # input_password = secret # output_password = secret # This sets a mask for permitted string types. There are several options. # default: PrintableString, T61String, BMPString. # pkix : PrintableString, BMPString (PKIX recommendation before 2004) # utf8only: only UTF8Strings (PKIX recommendation after 2004). # nombstr : PrintableString, T61String (no BMPStrings or UTF8Strings). # MASK:XXXX a literal mask value. # WARNING: ancient versions of Netscape crash on BMPStrings or UTF8Strings. string_mask = utf8only # req_extensions = v3_req # The extensions to add to a certificate request [ req_distinguished_name ] countryName = Country Name (2 letter code) countryName_default = stateOrProvinceName = State or Province Name (full name) stateOrProvinceName_default = Some-State localityName = Locality Name (eg, city) 0.organizationName = Organization Name (eg, company) 0.organizationName_default = Apache Software Foundation organizationalUnitName = Organizational Unit Name (eg, section) organizationalUnitName_default = HttpComponents Project commonName = Common Name (e.g. server FQDN or YOUR name) commonName_max = 64 emailAddress = Email Address emailAddress_max = 64 # SET-ex3 = SET extension number 3 [ req_attributes ] challengePassword = A challenge password challengePassword_min = 4 challengePassword_max = 20 unstructuredName = An optional company name [ usr_cert ] # These extensions are added when 'ca' signs a request. # This goes against PKIX guidelines but some CAs do it and some software # requires this to avoid interpreting an end user certificate as a CA. basicConstraints=CA:FALSE # Here are some examples of the usage of nsCertType. If it is omitted # the certificate can be used for anything *except* object signing. # This is OK for an SSL server. # nsCertType = server # For an object signing certificate this would be used. # nsCertType = objsign # For normal client use this is typical # nsCertType = client, email # and for everything including object signing: # nsCertType = client, email, objsign # This is typical in keyUsage for a client certificate. # keyUsage = nonRepudiation, digitalSignature, keyEncipherment # This will be displayed in Netscape's comment listbox. nsComment = "OpenSSL Generated Certificate" # PKIX recommendations harmless if included in all certificates. subjectKeyIdentifier=hash authorityKeyIdentifier=keyid,issuer # This stuff is for subjectAltName and issuerAltname. # Import the email address. # subjectAltName=email:copy # An alternative to produce certificates that aren't # deprecated according to PKIX. # subjectAltName=email:move # Copy subject details # issuerAltName=issuer:copy #nsCaRevocationUrl = http://www.domain.dom/ca-crl.pem #nsBaseUrl #nsRevocationUrl #nsRenewalUrl #nsCaPolicyUrl #nsSslServerName # This is required for TSA certificates. # extendedKeyUsage = critical,timeStamping [ v3_req ] # Extensions to add to a certificate request basicConstraints = CA:FALSE keyUsage = nonRepudiation, digitalSignature, keyEncipherment [ v3_ca ] # Extensions for a typical CA # PKIX recommendation. subjectKeyIdentifier=hash authorityKeyIdentifier=keyid:always,issuer # This is what PKIX recommends but some broken software chokes on critical # extensions. #basicConstraints = critical,CA:true # So we do this instead. basicConstraints = CA:true # Key usage: this is typical for a CA certificate. However since it will # prevent it being used as an test self-signed certificate it is best # left out by default. # keyUsage = cRLSign, keyCertSign # Some might want this also # nsCertType = sslCA, emailCA # Include email address in subject alt name: another PKIX recommendation # subjectAltName=email:copy # Copy issuer details # issuerAltName=issuer:copy # DER hex encoding of an extension: beware experts only! # obj=DER:02:03 # Where 'obj' is a standard or added object # You can even override a supported extension: # basicConstraints= critical, DER:30:03:01:01:FF [ crl_ext ] # CRL extensions. # Only issuerAltName and authorityKeyIdentifier make any sense in a CRL. # issuerAltName=issuer:copy authorityKeyIdentifier=keyid:always [ proxy_cert_ext ] # These extensions should be added when creating a proxy certificate # This goes against PKIX guidelines but some CAs do it and some software # requires this to avoid interpreting an end user certificate as a CA. basicConstraints=CA:FALSE # Here are some examples of the usage of nsCertType. If it is omitted # the certificate can be used for anything *except* object signing. # This is OK for an SSL server. # nsCertType = server # For an object signing certificate this would be used. # nsCertType = objsign # For normal client use this is typical # nsCertType = client, email # and for everything including object signing: # nsCertType = client, email, objsign # This is typical in keyUsage for a client certificate. # keyUsage = nonRepudiation, digitalSignature, keyEncipherment # This will be displayed in Netscape's comment listbox. nsComment = "OpenSSL Generated Certificate" # PKIX recommendations harmless if included in all certificates. subjectKeyIdentifier=hash authorityKeyIdentifier=keyid,issuer # This stuff is for subjectAltName and issuerAltname. # Import the email address. # subjectAltName=email:copy # An alternative to produce certificates that aren't # deprecated according to PKIX. # subjectAltName=email:move # Copy subject details # issuerAltName=issuer:copy #nsCaRevocationUrl = http://www.domain.dom/ca-crl.pem #nsBaseUrl #nsRevocationUrl #nsRenewalUrl #nsCaPolicyUrl #nsSslServerName # This really needs to be in place for it to be a proxy certificate. proxyCertInfo=critical,language:id-ppl-anyLanguage,pathlen:3,policy:foo #################################################################### [ tsa ] default_tsa = tsa_config1 # the default TSA section [ tsa_config1 ] # These are used by the TSA reply generation only. dir = ./demoCA # TSA root directory serial = $dir/tsaserial # The current serial number (mandatory) crypto_device = builtin # OpenSSL engine to use for signing signer_cert = $dir/tsacert.pem # The TSA signing certificate # (optional) certs = $dir/cacert.pem # Certificate chain to include in reply # (optional) signer_key = $dir/private/tsakey.pem # The TSA private key (optional) default_policy = tsa_policy1 # Policy if request did not specify it # (optional) other_policies = tsa_policy2, tsa_policy3 # acceptable policies (optional) digests = md5, sha1 # Acceptable message digests (mandatory) accuracy = secs:1, millisecs:500, microsecs:100 # (optional) clock_precision_digits = 0 # number of digits after dot. (optional) ordering = yes # Is ordering defined for timestamps? # (optional, default: no) tsa_name = yes # Must the TSA name be included in the reply? # (optional, default: no) ess_cert_id_chain = no # Must the ESS cert id chain be included? # (optional, default: no) CODE_OF_CONDUCT.md0100664 0000000 0000000 00000001641 14666635064 012430 0ustar000000000 0000000 The Apache code of conduct page is [https://www.apache.org/foundation/policies/conduct.html](https://www.apache.org/foundation/policies/conduct.html). httpclient5-testing/0040775 0000000 0000000 00000000000 15063503632 013533 5ustar000000000 0000000 httpclient5-testing/src/0040775 0000000 0000000 00000000000 14666635064 014337 5ustar000000000 0000000 httpclient5-testing/src/main/0040775 0000000 0000000 00000000000 14666635064 015263 5ustar000000000 0000000 httpclient5-testing/src/main/java/0040775 0000000 0000000 00000000000 14666635064 016204 5ustar000000000 0000000 httpclient5-testing/src/main/java/org/0040775 0000000 0000000 00000000000 14666635064 016773 5ustar000000000 0000000 httpclient5-testing/src/main/java/org/apache/0040775 0000000 0000000 00000000000 14666635064 020214 5ustar000000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/0040775 0000000 0000000 00000000000 14666635064 020606 5ustar000000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/0040775 0000000 0000000 00000000000 14666635064 022151 5ustar000000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/0040775 0000000 0000000 00000000000 14666635064 023626 5ustar000000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/auth/0040775 0000000 0000000 00000000000 14704162040 024545 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000146 14666635064 011654 Lustar 0000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/auth/BearerAuthenticationHandler.javahttpclient5-testing/src/main/java/org/apache/hc/client5/testing/auth/BearerAuthenticationHandler.jav0100664 0000000 0000000 00000003036 14666635064 032666 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.auth; import org.apache.hc.client5.http.auth.StandardAuthScheme; public class BearerAuthenticationHandler extends AbstractAuthenticationHandler { @Override String getSchemeName() { return StandardAuthScheme.BEARER; } @Override String decodeChallenge(final String challenge) { return challenge; } } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/auth/AuthResult.java0100664 0000000 0000000 00000005360 14666635064 027533 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.auth; import java.util.Arrays; import java.util.Collections; import java.util.List; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.util.LangUtils; public final class AuthResult { private final boolean success; private final List params; public AuthResult(final boolean success, final List params) { this.success = success; this.params = params != null ? Collections.unmodifiableList(params) : Collections.emptyList(); } public AuthResult(final boolean success, final NameValuePair... params) { this(success, Arrays.asList(params)); } public boolean isSuccess() { return success; } public boolean hasParams() { return !params.isEmpty(); } public List getParams() { return params; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.success); return hash; } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof AuthResult) { final AuthResult that = (AuthResult) o; return this.success == that.success; } return false; } @Override public String toString() { final StringBuilder buf = new StringBuilder(); buf.append(success); if (!params.isEmpty()) { buf.append(" ").append(params); } return buf.toString(); } } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/auth/AuthenticationHandler.java0100664 0000000 0000000 00000003005 14666635064 031702 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.auth; import java.util.List; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.NameValuePair; /** * @since 5.3 */ public interface AuthenticationHandler { String challenge(List params); T extractAuthToken(String challengeResponse) throws HttpException; } ././@LongLink0100644 0000000 0000000 00000000145 14704162040 011631 Lustar 0000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/auth/BasicAuthenticationHandler.javahttpclient5-testing/src/main/java/org/apache/hc/client5/testing/auth/BasicAuthenticationHandler.java0100664 0000000 0000000 00000005342 14704162040 032630 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.auth; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.utils.Base64; public class BasicAuthenticationHandler extends AbstractAuthenticationHandler { private final Charset charset; /** * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used. * @since 5.3 * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding * in compliance with RFC 7617 for HTTP Basic Authentication. Use the default constructor {@link #BasicAuthenticationHandler()} instead. */ @Deprecated public BasicAuthenticationHandler(final Charset charset) { this.charset = StandardCharsets.UTF_8; // Always use UTF-8 } /** * Constructs a new BasicAuthenticationHandler with UTF-8 as the charset. * This default setting aligns with standard practices for encoding credentials in Basic Authentication. * */ public BasicAuthenticationHandler() { this.charset = StandardCharsets.UTF_8; } @Override String getSchemeName() { return StandardAuthScheme.BASIC; } @Override String decodeChallenge(final String challenge) throws IllegalArgumentException { final byte[] bytes = challenge.getBytes(StandardCharsets.US_ASCII); final Base64 codec = new Base64(); return new String(codec.decode(bytes), charset); } } ././@LongLink0100644 0000000 0000000 00000000150 14704162040 011625 Lustar 0000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/auth/AbstractAuthenticationHandler.javahttpclient5-testing/src/main/java/org/apache/hc/client5/testing/auth/AbstractAuthenticationHandler.j0100664 0000000 0000000 00000005653 14704162040 032667 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.auth; import java.util.List; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.ProtocolException; abstract class AbstractAuthenticationHandler implements AuthenticationHandler { abstract String getSchemeName(); @Override public final String challenge(final List params) { final StringBuilder buf = new StringBuilder(); buf.append(getSchemeName()); if (params != null && params.size() > 0) { buf.append(" "); for (int i = 0; i < params.size(); i++) { if (i > 0) { buf.append(", "); } final NameValuePair param = params.get(i); buf.append(param.getName()).append("=\"").append(param.getValue()).append("\""); } } return buf.toString(); } abstract String decodeChallenge(String challenge); public final String extractAuthToken(final String challengeResponse) throws HttpException { final int i = challengeResponse.indexOf(' '); if (i == -1) { throw new ProtocolException("Invalid " + getSchemeName() + " challenge response"); } final String schemeName = challengeResponse.substring(0, i); if (schemeName.equalsIgnoreCase(getSchemeName())) { final String s = challengeResponse.substring(i + 1).trim(); try { return decodeChallenge(s); } catch (final IllegalArgumentException ex) { throw new ProtocolException("Malformed " + getSchemeName() + " credentials"); } } throw new ProtocolException("Unexpected challenge type"); } } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/auth/Authenticator.java0100664 0000000 0000000 00000003225 14666635064 030243 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.auth; import org.apache.hc.core5.net.URIAuthority; public interface Authenticator { /** * @since 5.3 */ default AuthResult perform(URIAuthority authority, String requestUri, String credentials) { return new AuthResult(authenticate(authority, requestUri, credentials)); } boolean authenticate(URIAuthority authority, String requestUri, String credentials); String getRealm(URIAuthority authority, String requestUri); } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/auth/BasicAuthTokenExtractor.java0100664 0000000 0000000 00000005046 14666635064 032174 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.auth; import java.nio.charset.StandardCharsets; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.utils.Base64; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.ProtocolException; /** * @deprecated Use {@link BasicAuthenticationHandler}. */ @Deprecated public class BasicAuthTokenExtractor { public String extract(final String challengeResponse) throws HttpException { if (challengeResponse != null) { final int i = challengeResponse.indexOf(' '); if (i == -1) { throw new ProtocolException("Invalid challenge response: " + challengeResponse); } final String schemeName = challengeResponse.substring(0, i); if (schemeName.equalsIgnoreCase(StandardAuthScheme.BASIC)) { final String s = challengeResponse.substring(i + 1).trim(); try { final byte[] credsRaw = s.getBytes(StandardCharsets.US_ASCII); final Base64 codec = new Base64(); return new String(codec.decode(credsRaw), StandardCharsets.US_ASCII); } catch (final IllegalArgumentException ex) { throw new ProtocolException("Malformed Basic credentials"); } } } return null; } } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/classic/0040775 0000000 0000000 00000000000 15063503632 025232 5ustar000000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/classic/RandomHandler.java0100664 0000000 0000000 00000016534 15063503632 030621 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.classic; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.net.URI; import java.net.URISyntaxException; import java.nio.charset.StandardCharsets; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.MethodNotSupportedException; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.io.HttpRequestHandler; import org.apache.hc.core5.http.io.entity.AbstractHttpEntity; import org.apache.hc.core5.http.protocol.HttpContext; /** * A handler that generates random data. */ public class RandomHandler implements HttpRequestHandler { /** * Handles a request by generating random data. * The length of the response can be specified in the request URI * as a number after the last /. For example /random/whatever/20 * will generate 20 random bytes in the printable ASCII range. * If the request URI ends with /, a random number of random bytes * is generated, but at least one. * * @param request the request * @param response the response * @param context the context * * @throws HttpException in case of a problem * @throws IOException in case of an IO problem */ @Override public void handle(final ClassicHttpRequest request, final ClassicHttpResponse response, final HttpContext context) throws HttpException, IOException { final String method = request.getMethod(); if (!"GET".equalsIgnoreCase(method) && !"HEAD".equalsIgnoreCase(method) && !"POST".equalsIgnoreCase(method) && !"PUT".equalsIgnoreCase(method)) { throw new MethodNotSupportedException(method + " not supported by " + getClass().getName()); } final URI uri; try { uri = request.getUri(); } catch (final URISyntaxException ex) { throw new ProtocolException(ex.getMessage(), ex); } final String path = uri.getPath(); final int slash = path.lastIndexOf('/'); if (slash != -1) { final String payload = path.substring(slash + 1); final long n; if (!payload.isEmpty()) { try { n = Long.parseLong(payload); } catch (final NumberFormatException ex) { throw new ProtocolException("Invalid request path: " + path); } } else { // random length, but make sure at least something is sent n = 1 + (int)(Math.random() * 79.0); } response.setCode(HttpStatus.SC_OK); response.setEntity(new RandomEntity(n)); } else { throw new ProtocolException("Invalid request path: " + path); } } /** * An entity that generates random data. * This is an outgoing entity, it supports {@link #writeTo writeTo} * but not {@link #getContent getContent}. */ public static class RandomEntity extends AbstractHttpEntity { /** The range from which to generate random data. */ private final static byte[] RANGE = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" .getBytes(StandardCharsets.US_ASCII); /** The length of the random data to generate. */ protected final long length; /** * Creates a new entity generating the given amount of data. * * @param len the number of random bytes to generate, * 0 to maxint */ public RandomEntity(final long len) { super((ContentType) null, null); length = len; } /** * Tells that this entity is not streaming. * * @return false */ @Override public final boolean isStreaming() { return false; } /** * Tells that this entity is repeatable, in a way. * Repetitions will generate different random data, * unless perchance the same random data is generated twice. * * @return {@code true} */ @Override public boolean isRepeatable() { return true; } /** * Obtains the size of the random data. * * @return the number of random bytes to generate */ @Override public long getContentLength() { return length; } /** * Not supported. * This method throws an exception. * * @return never anything */ @Override public InputStream getContent() { throw new UnsupportedOperationException(); } /** * Generates the random content. * * @param out where to write the content to */ @Override public void writeTo(final OutputStream out) throws IOException { final int blocksize = 2048; int remaining = (int) length; // range checked in constructor final byte[] data = new byte[Math.min(remaining, blocksize)]; while (remaining > 0) { final int end = Math.min(remaining, data.length); double value = 0.0; for (int i = 0; i < end; i++) { // we get 5 random characters out of one random value if (i % 5 == 0) { value = Math.random(); } value = value * RANGE.length; final int d = (int) value; value = value - d; data[i] = RANGE[d]; } out.write(data, 0, end); out.flush(); remaining = remaining - end; } out.close(); } @Override public void close() throws IOException { } } } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/classic/EchoHandler.java0100664 0000000 0000000 00000007130 14666635064 030264 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.classic; import java.io.IOException; import java.util.Locale; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.MethodNotSupportedException; import org.apache.hc.core5.http.io.HttpRequestHandler; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.protocol.HttpContext; /** * A handler that echos the incoming request entity. */ public class EchoHandler implements HttpRequestHandler { /** * Handles a request by echoing the incoming request entity. * If there is no request entity, an empty document is returned. * * @param request the request * @param response the response * @param context the context * * @throws HttpException in case of a problem * @throws IOException in case of an IO problem */ @Override public void handle(final ClassicHttpRequest request, final ClassicHttpResponse response, final HttpContext context) throws HttpException, IOException { final String method = request.getMethod().toUpperCase(Locale.ROOT); if (!"GET".equals(method) && !"HEAD".equals(method) && !"POST".equals(method) && !"PUT".equals(method)) { throw new MethodNotSupportedException(method + " not supported by " + getClass().getName()); } HttpEntity entity = request.getEntity(); // For some reason, just putting the incoming entity into // the response will not work. We have to buffer the message. final byte[] data; final ContentType contentType; if (entity == null) { data = new byte [0]; contentType = null; } else { data = EntityUtils.toByteArray(entity); final String contentTypeStr = entity.getContentType(); contentType = contentTypeStr == null ? null : ContentType.parse(contentTypeStr); } entity = new ByteArrayEntity(data, contentType); response.setCode(HttpStatus.SC_OK); response.setEntity(entity); } } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/classic/RedirectingDecorator.java0100664 0000000 0000000 00000007425 14666635064 032221 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.classic; import java.io.IOException; import java.net.URI; import java.net.URISyntaxException; import org.apache.hc.client5.testing.redirect.Redirect; import org.apache.hc.client5.testing.redirect.RedirectResolver; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.io.HttpServerRequestHandler; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; public class RedirectingDecorator implements HttpServerRequestHandler { private final HttpServerRequestHandler requestHandler; private final RedirectResolver redirectResolver; public RedirectingDecorator(final HttpServerRequestHandler requestHandler, final RedirectResolver redirectResolver) { this.requestHandler = Args.notNull(requestHandler, "Request handler"); this.redirectResolver = redirectResolver; } @Override public void handle(final ClassicHttpRequest request, final ResponseTrigger responseTrigger, final HttpContext context) throws HttpException, IOException { try { final URI requestURI = request.getUri(); final Redirect redirect = redirectResolver != null ? redirectResolver.resolve(requestURI) : null; if (redirect != null) { final ClassicHttpResponse response = new BasicClassicHttpResponse(redirect.status); if (redirect.location != null) { response.addHeader(new BasicHeader(HttpHeaders.LOCATION, redirect.location)); } switch (redirect.connControl) { case KEEP_ALIVE: response.addHeader(new BasicHeader(HttpHeaders.CONNECTION, HeaderElements.KEEP_ALIVE)); break; case CLOSE: response.addHeader(new BasicHeader(HttpHeaders.CONNECTION, HeaderElements.CLOSE)); } responseTrigger.submitResponse(response); } else { requestHandler.handle(request, responseTrigger, context); } } catch (final URISyntaxException ex) { throw new ProtocolException(ex.getMessage(), ex); } } } ././@LongLink0100644 0000000 0000000 00000000151 15034167313 011633 Lustar 0000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/classic/ServiceUnavailableDecorator.javahttpclient5-testing/src/main/java/org/apache/hc/client5/testing/classic/ServiceUnavailableDecorator.0100664 0000000 0000000 00000007236 15034167313 032647 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.classic; import java.io.IOException; import java.util.concurrent.atomic.AtomicBoolean; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.io.HttpServerRequestHandler; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; public class ServiceUnavailableDecorator implements HttpServerRequestHandler { private final HttpServerRequestHandler requestHandler; private final Resolver serviceAvailabilityResolver; private final AtomicBoolean serviceUnavailable; public ServiceUnavailableDecorator(final HttpServerRequestHandler requestHandler, final Resolver serviceAvailabilityResolver) { this.requestHandler = Args.notNull(requestHandler, "Request handler"); this.serviceAvailabilityResolver = Args.notNull(serviceAvailabilityResolver, "Service availability resolver"); this.serviceUnavailable = new AtomicBoolean(); } @Override public void handle(final ClassicHttpRequest request, final ResponseTrigger responseTrigger, final HttpContext context) throws HttpException, IOException { final TimeValue retryAfter = serviceAvailabilityResolver.resolve(request); serviceUnavailable.set(TimeValue.isPositive(retryAfter)); if (serviceUnavailable.get()) { final ClassicHttpResponse response = new BasicClassicHttpResponse(HttpStatus.SC_SERVICE_UNAVAILABLE); response.addHeader(HttpHeaders.RETRY_AFTER, Long.toString(retryAfter.toSeconds())); final ProtocolVersion version = request.getVersion(); if (version != null && version.compareToVersion(HttpVersion.HTTP_2) < 0) { response.addHeader(HttpHeaders.CONNECTION, "Close"); } responseTrigger.submitResponse(response); } else { requestHandler.handle(request, responseTrigger, context); } } } ././@LongLink0100644 0000000 0000000 00000000145 14704162040 011631 Lustar 0000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/classic/AuthenticatingDecorator.javahttpclient5-testing/src/main/java/org/apache/hc/client5/testing/classic/AuthenticatingDecorator.java0100664 0000000 0000000 00000013463 14704162040 032706 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.classic; import java.io.IOException; import java.util.ArrayList; import java.util.List; import org.apache.hc.client5.testing.auth.AuthResult; import org.apache.hc.client5.testing.auth.AuthenticationHandler; import org.apache.hc.client5.testing.auth.Authenticator; import org.apache.hc.client5.testing.auth.BasicAuthenticationHandler; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.io.HttpServerRequestHandler; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; public class AuthenticatingDecorator implements HttpServerRequestHandler { private final HttpServerRequestHandler requestHandler; private final AuthenticationHandler authenticationHandler; private final Authenticator authenticator; /** * @since 5.3 */ public AuthenticatingDecorator(final HttpServerRequestHandler requestHandler, final AuthenticationHandler authenticationHandler, final Authenticator authenticator) { this.requestHandler = Args.notNull(requestHandler, "Request handler"); this.authenticationHandler = Args.notNull(authenticationHandler, "Authentication handler"); this.authenticator = Args.notNull(authenticator, "Authenticator"); } public AuthenticatingDecorator(final HttpServerRequestHandler requestHandler, final Authenticator authenticator) { this(requestHandler, new BasicAuthenticationHandler(), authenticator); } protected void customizeUnauthorizedResponse(final ClassicHttpResponse unauthorized) { } @Override public void handle( final ClassicHttpRequest request, final ResponseTrigger responseTrigger, final HttpContext context) throws HttpException, IOException { final Header h = request.getFirstHeader(HttpHeaders.AUTHORIZATION); final String challengeResponse = h != null ? authenticationHandler.extractAuthToken(h.getValue()) : null; final URIAuthority authority = request.getAuthority(); final String requestUri = request.getRequestUri(); final AuthResult authResult = authenticator.perform(authority, requestUri, challengeResponse); final Header expect = request.getFirstHeader(HttpHeaders.EXPECT); final boolean expectContinue = expect != null && "100-continue".equalsIgnoreCase(expect.getValue()); if (authResult.isSuccess()) { if (expectContinue) { responseTrigger.sendInformation(new BasicClassicHttpResponse(HttpStatus.SC_CONTINUE)); } requestHandler.handle(request, responseTrigger, context); } else { final ClassicHttpResponse unauthorized = new BasicClassicHttpResponse(HttpStatus.SC_UNAUTHORIZED); final List challengeParams = new ArrayList<>(); final String realm = authenticator.getRealm(authority, requestUri); if (realm != null) { challengeParams.add(new BasicNameValuePair("realm", realm)); } if (authResult.hasParams()) { challengeParams.addAll(authResult.getParams()); } final String challenge = authenticationHandler.challenge(challengeParams); unauthorized.addHeader(HttpHeaders.WWW_AUTHENTICATE, challenge); customizeUnauthorizedResponse(unauthorized); if (unauthorized.getEntity() == null) { unauthorized.setEntity(new StringEntity("Unauthorized")); } if (expectContinue || request.getEntity() == null) { // Respond immediately responseTrigger.submitResponse(unauthorized); // Consume request body later EntityUtils.consume(request.getEntity()); } else { // Consume request body first EntityUtils.consume(request.getEntity()); // Respond later responseTrigger.submitResponse(unauthorized); } } } } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/async/0040775 0000000 0000000 00000000000 15063503632 024726 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000145 14704162040 011631 Lustar 0000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/async/RedirectingAsyncDecorator.javahttpclient5-testing/src/main/java/org/apache/hc/client5/testing/async/RedirectingAsyncDecorator.java0100664 0000000 0000000 00000013351 14704162040 032664 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.io.IOException; import java.net.URI; import java.net.URISyntaxException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicBoolean; import org.apache.hc.client5.testing.redirect.Redirect; import org.apache.hc.client5.testing.redirect.RedirectResolver; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.nio.AsyncServerExchangeHandler; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.ResponseChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; public class RedirectingAsyncDecorator implements AsyncServerExchangeHandler { private final AsyncServerExchangeHandler exchangeHandler; private final RedirectResolver redirectResolver; private final AtomicBoolean redirecting; public RedirectingAsyncDecorator(final AsyncServerExchangeHandler exchangeHandler, final RedirectResolver redirectResolver) { this.exchangeHandler = Args.notNull(exchangeHandler, "Exchange handler"); this.redirectResolver = redirectResolver; this.redirecting = new AtomicBoolean(); } private Redirect resolveRedirect(final HttpRequest request) throws HttpException { try { final URI requestURI = request.getUri(); return redirectResolver != null ? redirectResolver.resolve(requestURI) : null; } catch (final URISyntaxException ex) { throw new ProtocolException(ex.getMessage(), ex); } } private HttpResponse createRedirectResponse(final Redirect redirect) { final HttpResponse response = new BasicHttpResponse(redirect.status); if (redirect.location != null) { response.addHeader(new BasicHeader(HttpHeaders.LOCATION, redirect.location)); } switch (redirect.connControl) { case KEEP_ALIVE: response.addHeader(new BasicHeader(HttpHeaders.CONNECTION, HeaderElements.KEEP_ALIVE)); break; case CLOSE: response.addHeader(new BasicHeader(HttpHeaders.CONNECTION, HeaderElements.CLOSE)); } return response; } @Override public void handleRequest(final HttpRequest request, final EntityDetails entityDetails, final ResponseChannel responseChannel, final HttpContext context) throws HttpException, IOException { final Redirect redirect = resolveRedirect(request); if (redirect != null) { responseChannel.sendResponse(createRedirectResponse(redirect), null, context); redirecting.set(true); } else { exchangeHandler.handleRequest(request, entityDetails, responseChannel, context); } } @Override public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException { if (!redirecting.get()) { exchangeHandler.updateCapacity(capacityChannel); } else { capacityChannel.update(Integer.MAX_VALUE); } } @Override public final void consume(final ByteBuffer src) throws IOException { if (!redirecting.get()) { exchangeHandler.consume(src); } } @Override public final void streamEnd(final List trailers) throws HttpException, IOException { if (!redirecting.get()) { exchangeHandler.streamEnd(trailers); } } @Override public int available() { return redirecting.get() ? 0 : exchangeHandler.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { if (!redirecting.get()) { exchangeHandler.produce(channel); } } @Override public void failed(final Exception cause) { if (!redirecting.get()) { exchangeHandler.failed(cause); } } @Override public void releaseResources() { exchangeHandler.releaseResources(); } } ././@LongLink0100644 0000000 0000000 00000000150 14704162040 011625 Lustar 0000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/async/AuthenticatingAsyncDecorator.javahttpclient5-testing/src/main/java/org/apache/hc/client5/testing/async/AuthenticatingAsyncDecorator.j0100664 0000000 0000000 00000020551 14704162040 032704 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.io.IOException; import java.nio.ByteBuffer; import java.util.ArrayList; import java.util.List; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.testing.auth.AuthResult; import org.apache.hc.client5.testing.auth.AuthenticationHandler; import org.apache.hc.client5.testing.auth.Authenticator; import org.apache.hc.client5.testing.auth.BasicAuthenticationHandler; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.http.nio.AsyncResponseProducer; import org.apache.hc.core5.http.nio.AsyncServerExchangeHandler; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.ResponseChannel; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityProducer; import org.apache.hc.core5.http.nio.support.BasicResponseProducer; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; public class AuthenticatingAsyncDecorator implements AsyncServerExchangeHandler { private final AsyncServerExchangeHandler exchangeHandler; private final AuthenticationHandler authenticationHandler; private final Authenticator authenticator; private final AtomicReference responseProducerRef; /** * @since 5.3 */ public AuthenticatingAsyncDecorator(final AsyncServerExchangeHandler exchangeHandler, final AuthenticationHandler authenticationHandler, final Authenticator authenticator) { this.exchangeHandler = Args.notNull(exchangeHandler, "Request handler"); this.authenticationHandler = Args.notNull(authenticationHandler, "Authentication handler"); this.authenticator = Args.notNull(authenticator, "Authenticator"); this.responseProducerRef = new AtomicReference<>(); } public AuthenticatingAsyncDecorator(final AsyncServerExchangeHandler exchangeHandler, final Authenticator authenticator) { this(exchangeHandler, new BasicAuthenticationHandler(), authenticator); } protected void customizeUnauthorizedResponse(final HttpResponse unauthorized) { } @Override public void handleRequest( final HttpRequest request, final EntityDetails entityDetails, final ResponseChannel responseChannel, final HttpContext context) throws HttpException, IOException { final Header h = request.getFirstHeader(HttpHeaders.AUTHORIZATION); final String challengeResponse = h != null ? authenticationHandler.extractAuthToken(h.getValue()) : null; final URIAuthority authority = request.getAuthority(); final String requestUri = request.getRequestUri(); final AuthResult authResult = authenticator.perform(authority, requestUri, challengeResponse); final Header expect = request.getFirstHeader(HttpHeaders.EXPECT); final boolean expectContinue = expect != null && "100-continue".equalsIgnoreCase(expect.getValue()); if (authResult.isSuccess()) { if (expectContinue) { responseChannel.sendInformation(new BasicClassicHttpResponse(HttpStatus.SC_CONTINUE), context); } exchangeHandler.handleRequest(request, entityDetails, responseChannel, context); } else { final HttpResponse unauthorized = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED); final List challengeParams = new ArrayList<>(); final String realm = authenticator.getRealm(authority, requestUri); if (realm != null) { challengeParams.add(new BasicNameValuePair("realm", realm)); } if (authResult.hasParams()) { challengeParams.addAll(authResult.getParams()); } final String challenge = authenticationHandler.challenge(challengeParams); unauthorized.addHeader(HttpHeaders.WWW_AUTHENTICATE, challenge); customizeUnauthorizedResponse(unauthorized); final AsyncResponseProducer responseProducer = new BasicResponseProducer( unauthorized, new BasicAsyncEntityProducer("Unauthorized", ContentType.TEXT_PLAIN)); responseProducerRef.set(responseProducer); responseProducer.sendResponse(responseChannel, context); } } @Override public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException { final AsyncResponseProducer responseProducer = responseProducerRef.get(); if (responseProducer == null) { exchangeHandler.updateCapacity(capacityChannel); } else { capacityChannel.update(Integer.MAX_VALUE); } } @Override public final void consume(final ByteBuffer src) throws IOException { final AsyncResponseProducer responseProducer = responseProducerRef.get(); if (responseProducer == null) { exchangeHandler.consume(src); } } @Override public final void streamEnd(final List trailers) throws HttpException, IOException { final AsyncResponseProducer responseProducer = responseProducerRef.get(); if (responseProducer == null) { exchangeHandler.streamEnd(trailers); } } @Override public final int available() { final AsyncResponseProducer responseProducer = responseProducerRef.get(); if (responseProducer == null) { return exchangeHandler.available(); } return responseProducer.available(); } @Override public final void produce(final DataStreamChannel channel) throws IOException { final AsyncResponseProducer responseProducer = responseProducerRef.get(); if (responseProducer == null) { exchangeHandler.produce(channel); } else { responseProducer.produce(channel); } } @Override public final void failed(final Exception cause) { try { exchangeHandler.failed(cause); final AsyncResponseProducer dataProducer = responseProducerRef.getAndSet(null); if (dataProducer != null) { dataProducer.failed(cause); } } finally { releaseResources(); } } @Override public final void releaseResources() { exchangeHandler.releaseResources(); final AsyncResponseProducer dataProducer = responseProducerRef.getAndSet(null); if (dataProducer != null) { dataProducer.releaseResources(); } } } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/async/AsyncRandomHandler.java0100664 0000000 0000000 00000017020 15063503632 031302 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.io.IOException; import java.net.URI; import java.net.URISyntaxException; import java.nio.ByteBuffer; import java.nio.charset.StandardCharsets; import java.util.List; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.MethodNotSupportedException; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.AsyncServerExchangeHandler; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.ResponseChannel; import org.apache.hc.core5.http.nio.StreamChannel; import org.apache.hc.core5.http.nio.entity.AbstractBinAsyncEntityProducer; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Asserts; /** * A handler that generates random data. */ public class AsyncRandomHandler implements AsyncServerExchangeHandler { private final AtomicReference entityProducerRef; public AsyncRandomHandler() { this.entityProducerRef = new AtomicReference<>(); } @Override public void releaseResources() { final AsyncEntityProducer producer = entityProducerRef.getAndSet(null); if (producer != null) { producer.releaseResources(); } } @Override public void handleRequest( final HttpRequest request, final EntityDetails entityDetails, final ResponseChannel responseChannel, final HttpContext context) throws HttpException, IOException { final String method = request.getMethod(); if (!"GET".equalsIgnoreCase(method) && !"HEAD".equalsIgnoreCase(method) && !"POST".equalsIgnoreCase(method) && !"PUT".equalsIgnoreCase(method)) { throw new MethodNotSupportedException(method + " not supported by " + getClass().getName()); } final URI uri; try { uri = request.getUri(); } catch (final URISyntaxException ex) { throw new ProtocolException(ex.getMessage(), ex); } final String path = uri.getPath(); final int slash = path.lastIndexOf('/'); if (slash != -1) { final String payload = path.substring(slash + 1); final long n; if (!payload.isEmpty()) { try { n = Long.parseLong(payload); } catch (final NumberFormatException ex) { throw new ProtocolException("Invalid request path: " + path); } } else { // random length, but make sure at least something is sent n = 1 + (int)(Math.random() * 79.0); } final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_OK); final AsyncEntityProducer entityProducer = new RandomBinAsyncEntityProducer(n); entityProducerRef.set(entityProducer); responseChannel.sendResponse(response, entityProducer, context); } else { throw new ProtocolException("Invalid request path: " + path); } } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { capacityChannel.update(Integer.MAX_VALUE); } @Override public void consume(final ByteBuffer src) throws IOException { } @Override public void streamEnd(final List trailers) throws HttpException, IOException { } @Override public int available() { final AsyncEntityProducer producer = entityProducerRef.get(); Asserts.notNull(producer, "Entity producer"); return producer.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { final AsyncEntityProducer producer = entityProducerRef.get(); Asserts.notNull(producer, "Entity producer"); producer.produce(channel); } @Override public void failed(final Exception cause) { releaseResources(); } /** * An entity that generates random data. */ public static class RandomBinAsyncEntityProducer extends AbstractBinAsyncEntityProducer { /** The range from which to generate random data. */ private final static byte[] RANGE = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" .getBytes(StandardCharsets.US_ASCII); /** The length of the random data to generate. */ private final long length; private long remaining; private final ByteBuffer buffer; public RandomBinAsyncEntityProducer(final long len) { super(512, ContentType.DEFAULT_TEXT); length = len; remaining = len; buffer = ByteBuffer.allocate(1024); } @Override public void releaseResources() { remaining = length; } @Override public boolean isRepeatable() { return true; } @Override public long getContentLength() { return length; } @Override public int availableData() { return Integer.MAX_VALUE; } @Override protected void produceData(final StreamChannel channel) throws IOException { final int chunk = Math.min((int) (remaining < Integer.MAX_VALUE ? remaining : Integer.MAX_VALUE), buffer.remaining()); for (int i = 0; i < chunk; i++) { final byte b = RANGE[(int) (Math.random() * RANGE.length)]; buffer.put(b); } remaining -= chunk; buffer.flip(); channel.write(buffer); buffer.compact(); if (remaining <= 0 && buffer.position() == 0) { channel.endStream(); } } @Override public void failed(final Exception cause) { } } } ././@LongLink0100644 0000000 0000000 00000000154 14704162040 011631 Lustar 0000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/async/ServiceUnavailableAsyncDecorator.javahttpclient5-testing/src/main/java/org/apache/hc/client5/testing/async/ServiceUnavailableAsyncDecorat0100664 0000000 0000000 00000012436 14704162040 032713 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.nio.AsyncServerExchangeHandler; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.ResponseChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicBoolean; public class ServiceUnavailableAsyncDecorator implements AsyncServerExchangeHandler { private final AsyncServerExchangeHandler exchangeHandler; private final Resolver serviceAvailabilityResolver; private final AtomicBoolean serviceUnavailable; public ServiceUnavailableAsyncDecorator(final AsyncServerExchangeHandler exchangeHandler, final Resolver serviceAvailabilityResolver) { this.exchangeHandler = Args.notNull(exchangeHandler, "Exchange handler"); this.serviceAvailabilityResolver = Args.notNull(serviceAvailabilityResolver, "Service availability resolver"); this.serviceUnavailable = new AtomicBoolean(); } @Override public void handleRequest(final HttpRequest request, final EntityDetails entityDetails, final ResponseChannel responseChannel, final HttpContext context) throws HttpException, IOException { final TimeValue retryAfter = serviceAvailabilityResolver.resolve(request); serviceUnavailable.set(TimeValue.isPositive(retryAfter)); if (serviceUnavailable.get()) { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SERVICE_UNAVAILABLE); response.addHeader(HttpHeaders.RETRY_AFTER, Long.toString(retryAfter.toSeconds())); final ProtocolVersion version = request.getVersion(); if (version != null && version.compareToVersion(HttpVersion.HTTP_2) < 0) { response.addHeader(HttpHeaders.CONNECTION, "Close"); } responseChannel.sendResponse(response, null, context); } else { exchangeHandler.handleRequest(request, entityDetails, responseChannel, context); } } @Override public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException { if (!serviceUnavailable.get()) { exchangeHandler.updateCapacity(capacityChannel); } else { capacityChannel.update(Integer.MAX_VALUE); } } @Override public final void consume(final ByteBuffer src) throws IOException { if (!serviceUnavailable.get()) { exchangeHandler.consume(src); } } @Override public final void streamEnd(final List trailers) throws HttpException, IOException { if (!serviceUnavailable.get()) { exchangeHandler.streamEnd(trailers); } } @Override public int available() { return serviceUnavailable.get() ? 0 : exchangeHandler.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { if (!serviceUnavailable.get()) { exchangeHandler.produce(channel); } } @Override public void failed(final Exception cause) { if (!serviceUnavailable.get()) { exchangeHandler.failed(cause); } } @Override public void releaseResources() { exchangeHandler.releaseResources(); } } ././@LongLink0100644 0000000 0000000 00000000157 14704162040 011634 Lustar 0000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/async/AbstractSimpleServerExchangeHandler.javahttpclient5-testing/src/main/java/org/apache/hc/client5/testing/async/AbstractSimpleServerExchangeHa0100664 0000000 0000000 00000010511 14704162040 032657 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.io.IOException; import org.apache.hc.client5.http.async.methods.SimpleBody; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.AsyncRequestConsumer; import org.apache.hc.core5.http.nio.AsyncServerRequestHandler; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityConsumer; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityProducer; import org.apache.hc.core5.http.nio.entity.StringAsyncEntityProducer; import org.apache.hc.core5.http.nio.support.AbstractAsyncRequesterConsumer; import org.apache.hc.core5.http.nio.support.AbstractServerExchangeHandler; import org.apache.hc.core5.http.nio.support.BasicResponseProducer; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpCoreContext; public abstract class AbstractSimpleServerExchangeHandler extends AbstractServerExchangeHandler { protected abstract SimpleHttpResponse handle(SimpleHttpRequest request, HttpCoreContext context) throws HttpException; @Override protected final AsyncRequestConsumer supplyConsumer( final HttpRequest request, final EntityDetails entityDetails, final HttpContext context) throws HttpException { return new AbstractAsyncRequesterConsumer(new BasicAsyncEntityConsumer()) { @Override protected SimpleHttpRequest buildResult( final HttpRequest request, final byte[] body, final ContentType contentType) { final SimpleRequestBuilder builder = SimpleRequestBuilder.copy(request); if (body != null) { builder.setBody(body, contentType); } return builder.build(); } }; } @Override protected final void handle( final SimpleHttpRequest request, final AsyncServerRequestHandler.ResponseTrigger responseTrigger, final HttpContext context) throws HttpException, IOException { final SimpleHttpResponse response = handle(request, HttpCoreContext.cast(context)); final SimpleBody body = response.getBody(); final AsyncEntityProducer entityProducer; if (body != null) { if (body.isText()) { entityProducer = new StringAsyncEntityProducer(body.getBodyText(), body.getContentType()); } else { entityProducer = new BasicAsyncEntityProducer(body.getBodyBytes(), body.getContentType()); } } else { entityProducer = null; } responseTrigger.submitResponse(new BasicResponseProducer(response, entityProducer), context); } } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/async/AsyncEchoHandler.java0100664 0000000 0000000 00000013427 14666635064 030764 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.MethodNotSupportedException; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.AsyncServerExchangeHandler; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.ResponseChannel; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityConsumer; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityProducer; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Asserts; /** * A handler that echos the incoming request entity. */ public class AsyncEchoHandler implements AsyncServerExchangeHandler { private final BasicAsyncEntityConsumer entityConsumer; private final AtomicReference entityProducerRef; public AsyncEchoHandler() { this.entityConsumer = new BasicAsyncEntityConsumer(); this.entityProducerRef = new AtomicReference<>(); } @Override public void releaseResources() { entityConsumer.releaseResources(); final AsyncEntityProducer producer = entityProducerRef.getAndSet(null); if (producer != null) { producer.releaseResources(); } } @Override public void handleRequest( final HttpRequest request, final EntityDetails entityDetails, final ResponseChannel responseChannel, final HttpContext context) throws HttpException, IOException { final String method = request.getMethod(); if (!"GET".equalsIgnoreCase(method) && !"HEAD".equalsIgnoreCase(method) && !"POST".equalsIgnoreCase(method) && !"PUT".equalsIgnoreCase(method)) { throw new MethodNotSupportedException(method + " not supported by " + getClass().getName()); } if (entityDetails != null) { final ContentType contentType = ContentType.parseLenient(entityDetails.getContentType()); entityConsumer.streamStart(entityDetails, new FutureCallback() { @Override public void completed(final byte[] content) { final BasicAsyncEntityProducer entityProducer = new BasicAsyncEntityProducer(content, contentType); entityProducerRef.set(entityProducer); try { responseChannel.sendResponse(new BasicHttpResponse(HttpStatus.SC_OK), entityProducer, context); } catch (final IOException | HttpException ex) { failed(ex); } } @Override public void failed(final Exception ex) { releaseResources(); } @Override public void cancelled() { releaseResources(); } }); } else { responseChannel.sendResponse(new BasicHttpResponse(HttpStatus.SC_OK), null, context); entityConsumer.releaseResources(); } } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { entityConsumer.updateCapacity(capacityChannel); } @Override public void consume(final ByteBuffer src) throws IOException { entityConsumer.consume(src); } @Override public void streamEnd(final List trailers) throws HttpException, IOException { entityConsumer.streamEnd(trailers); } @Override public int available() { final AsyncEntityProducer producer = entityProducerRef.get(); Asserts.notNull(producer, "Entity producer"); return producer.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { final AsyncEntityProducer producer = entityProducerRef.get(); Asserts.notNull(producer, "Entity producer"); producer.produce(channel); } @Override public void failed(final Exception cause) { releaseResources(); } } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/redirect/0040775 0000000 0000000 00000000000 14666635064 025427 5ustar000000000 0000000 httpclient5-testing/src/main/java/org/apache/hc/client5/testing/redirect/RedirectResolver.java0100664 0000000 0000000 00000002564 14666635064 031561 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.redirect; import java.net.URI; import java.net.URISyntaxException; public interface RedirectResolver { Redirect resolve(URI requestUri) throws URISyntaxException; } httpclient5-testing/src/main/java/org/apache/hc/client5/testing/redirect/Redirect.java0100664 0000000 0000000 00000003356 14666635064 030037 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.redirect; public class Redirect { public enum ConnControl { PROTOCOL_DEFAULT, KEEP_ALIVE, CLOSE } public final int status; public final String location; public final ConnControl connControl; public Redirect(final int status, final String location, final ConnControl connControl) { this.status = status; this.location = location; this.connControl = connControl; } public Redirect(final int status, final String location) { this(status , location, ConnControl.PROTOCOL_DEFAULT); } } httpclient5-testing/src/test/0040775 0000000 0000000 00000000000 14666635064 015316 5ustar000000000 0000000 httpclient5-testing/src/test/resources/0040775 0000000 0000000 00000000000 15061513641 017312 5ustar000000000 0000000 httpclient5-testing/src/test/resources/log4j2-debug.xml.template0100664 0000000 0000000 00000003006 14666635064 024045 0ustar000000000 0000000 httpclient5-testing/src/test/resources/test.keystore0100664 0000000 0000000 00000004303 14666635064 022073 0ustar000000000 0000000 simple-http-serverfL00 +*.UŻb 6>XpFef7K݀9gE7,\?5ؗwnsu,r /P5MY%ppϢ%^U Hvˣv۱};TDA,Q2fmd!D@wF:z>+bc=$gŔ]/Dw!3̐lI`۱:%BeՎ{x8wNT=x2&R)ul[v AA߲4W 5. #ގ@sp!p}E]z3,;ldTVBzZEp:>$s/6-RBrۍ$OBi622]KDbWcVsFpݫn}T~,~16tM'F^cj<'8i,ڔ}8!TaÍGCG © ڎM؏<ϟzP\HW[´H#l֗7Bo`CN4U~9;#l S肽$g7Y A:*B{=Wgh}mӳZР6j P^&:mpF#g}(ǷnĠAD"1f=hh9CʔgSƞ)l_G6~ڃ4t^gFPUr{}dfD(;TZ2= ``{lMG홰J4۩bNI&"1}܉6|IT]pi2&fx#h{M Y8Њ y SGTf<kgk.YpJ!-eЯן~M?wZFQ0!ꀚEpDr#EސɶN dj: ߍO![!c.mħ(>ΩM(L.רUYp"pA{ n 7OA'QZգHS@-9w9P0 !#y#07~LላfUDTX.509m0i0QAv0  *H  0Y1#0!U Apache Software Foundation10U Apache HttpComponents10U localhost0  181019104659Z22920803104659Z0Y1#0!U Apache Software Foundation10U Apache HttpComponents10U localhost0"0  *H 0 * 䌌جG'1!1cƻt!FСS`Rp&OuD BўU=hOzgƁ_IF:,[MLݽ Feo!jbs}?sCw"cB-tJqn K"i~h:u۶yYLz-hi1Cf-̯[V㌢c,OTHBCoׯ)d\#t έ >6ה:š0H XO+I7050U 0 localhost0UJK`+XҬ$N0  *H  %GyӐs5&|AHk-*ugB>t u'e!.\9SϘAX%7S|9bТhp:v_f9`[r Pb~tyٜ쐛}h=4!UbSbc˶UP/qkR!/PdO]M{#kXۢT y~PL/ httpclient5-testing/src/test/resources/test-ssl.txt0100664 0000000 0000000 00000003465 14666635064 021654 0ustar000000000 0000000 # ==================================================================== # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # ==================================================================== # # This software consists of voluntary contributions made by many # individuals on behalf of the Apache Software Foundation. For more # information on the Apache Software Foundation, please see # . == generate test key store with a self signed key --- keytool -genkey \ -keystore test.keystore -storepass nopassword \ -keyalg RSA -keysize 2048 \ -alias simple-http-server \ -validity 100000 \ -dname "CN=localhost, OU=Apache HttpComponents, O=Apache Software Foundation" \ -ext SAN="DNS:localhost" --- == generate test key store with a self signed key protected with a key password --- keytool -genkey \ -keystore test-keypasswd.keystore -storepass nopassword \ -keyalg RSA -keysize 2048 -keypass password \ -alias simple-http-server \ -validity 100000 \ -dname "CN=localhost, OU=Apache HttpComponents, O=Apache Software Foundation" \ -ext SAN="DNS:localhost" --- httpclient5-testing/src/test/resources/test-ca.keystore0100664 0000000 0000000 00000002013 14666635064 022450 0ustar000000000 0000000 mykeyY[X.50900  0  *H  0z1#0!U Apache Software Foundation10U HttpComponents Project10U Test CA1 0 *H  dev@hc.apache.org0  141013150120Z22880728150120Z0z1#0!U Apache Software Foundation10U HttpComponents Project10U Test CA1 0 *H  dev@hc.apache.org0"0  *H 0 xGo#3^dUp!HFogKQN<4S ^fƚ÷lBMt #cBX0ty (gY-nE+ƷoFo_0`8"8o^쩞 Պ]{%OZOK浥KhXwX dS= 8@]9~9Nolk16gDe9jQ2]rlfz⢴:0i t<P0N0Udv)/K0U#0dv)/K0 U00  *H  Q)&X:)e[]t_ gA4߼lWSbCVLU+) ,P/}h IVf7c<~W>s7KE CTkZN*$끾,?9㵵K`CXQ5Iᇿ #b:Rl #/!!lHikۻ{ܚߔ͗.fD:[zdr9eָj)`hhttpclient5-testing/src/test/resources/docker/0040775 0000000 0000000 00000000000 15005672016 020561 5ustar000000000 0000000 httpclient5-testing/src/test/resources/docker/squid/0040775 0000000 0000000 00000000000 15005672016 021706 5ustar000000000 0000000 httpclient5-testing/src/test/resources/docker/squid/squid.conf0100664 0000000 0000000 00000005514 15005672016 023704 0ustar000000000 0000000 # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # ========================================================================== http_port 8888 http_port 8889 coredump_dir /var/spool/squid auth_param basic program /usr/lib/squid/basic_ncsa_auth /etc/squid/htpasswd auth_param basic children 5 auth_param basic realm test-proxy acl localnet src 0.0.0.1-0.255.255.255 # RFC 1122 "this" network (LAN) acl localnet src 10.0.0.0/8 # RFC 1918 local private network (LAN) acl localnet src 100.64.0.0/10 # RFC 6598 shared address space (CGN) acl localnet src 169.254.0.0/16 # RFC 3927 link-local (directly plugged) machines acl localnet src 172.16.0.0/12 # RFC 1918 local private network (LAN) acl localnet src 192.168.0.0/16 # RFC 1918 local private network (LAN) acl localnet src fc00::/7 # RFC 4193 local private network range acl localnet src fe80::/10 # RFC 4291 link-local (directly plugged) machines acl secure_port myport 8888 acl insecure_port myport 8889 acl SSL_ports port 443 acl SSL_ports port 8443 acl Safe_ports port 80 # http acl Safe_ports port 21 # ftp acl Safe_ports port 443 # https acl Safe_ports port 70 # gopher acl Safe_ports port 210 # wais acl Safe_ports port 1025-65535 # unregistered ports acl Safe_ports port 280 # http-mgmt acl Safe_ports port 488 # gss-http acl Safe_ports port 591 # filemaker acl Safe_ports port 777 # multiling http acl CONNECT method CONNECT acl authenticated proxy_auth REQUIRED http_access deny !Safe_ports http_access deny CONNECT !SSL_ports http_access allow localhost manager http_access deny manager http_access allow secure_port localnet http_access allow secure_port localhost http_access allow insecure_port authenticated include /etc/squid/conf.d/*.conf http_access deny all refresh_pattern ^ftp: 1440 20% 10080 refresh_pattern ^gopher: 1440 0% 1440 refresh_pattern -i (/cgi-bin/|\?) 0 0% 0 refresh_pattern \/(Packages|Sources)(|\.bz2|\.gz|\.xz)$ 0 0% 0 refresh-ims refresh_pattern \/Release(|\.gpg)$ 0 0% 0 refresh-ims refresh_pattern \/InRelease$ 0 0% 0 refresh-ims refresh_pattern \/(Translation-.*)(|\.bz2|\.gz|\.xz)$ 0 0% 0 refresh-ims refresh_pattern . 0 20% 4320httpclient5-testing/src/test/resources/docker/server-cert.pem0100664 0000000 0000000 00000011231 15005672016 023520 0ustar000000000 0000000 Certificate: Data: Version: 3 (0x2) Serial Number: 0 (0x0) Signature Algorithm: sha256WithRSAEncryption Issuer: O=Apache Software Foundation, OU=HttpComponents Project, CN=Test CA/emailAddress=dev@hc.apache.org Validity Not Before: Oct 20 19:14:02 2024 GMT Not After : Sep 26 19:14:02 2124 GMT Subject: O=Apache Software Foundation, OU=HttpComponents Project, CN=localhost/emailAddress=dev@hc.apache.org Subject Public Key Info: Public Key Algorithm: rsaEncryption Public-Key: (2048 bit) Modulus: 00:9d:12:0f:d0:8a:7e:0a:e4:76:b8:08:af:3f:5f: 0f:b4:4c:70:24:22:4e:8f:8f:55:ec:ae:31:6c:e2: 05:68:df:c5:c0:4d:e9:a5:ed:d9:4e:71:ed:e7:3c: 51:ac:0a:fe:21:96:7c:0c:7b:2f:fa:6f:4f:73:69: 38:a0:25:a7:4c:d0:69:fc:a2:8d:94:cb:4f:9e:c7: 1f:a3:b2:5b:94:5f:20:3c:61:4d:73:a6:9c:a4:7c: 72:25:26:ee:a6:d0:d8:f0:49:e7:b3:e0:f5:4d:de: 6e:54:80:b9:54:8c:37:9d:d2:c0:ac:8b:43:03:8d: 9c:c9:ac:91:f9:31:4f:6d:e9:2d:d5:de:b9:c4:34: de:67:3d:1a:4e:25:43:5e:ee:8e:01:67:d6:b2:4a: 49:53:f9:d3:0c:93:5d:a9:1f:52:f7:23:93:1d:73: 3a:d4:e1:dd:2b:a2:d1:65:b1:ef:69:12:1a:fc:6b: 24:7c:96:6b:d2:27:21:4e:38:04:af:e4:d1:f6:4e: b2:8a:a4:59:b6:c8:c5:21:d5:c0:d6:d8:7e:58:b2: 4e:3a:9e:6f:81:8a:1a:0e:0e:61:69:15:cb:7a:19: 1a:37:62:3b:96:b3:3b:20:11:b7:1e:a6:63:39:2b: 0c:c2:2b:77:7b:0d:21:ef:42:26:71:ce:76:49:cb: 68:33 Exponent: 65537 (0x10001) X509v3 extensions: X509v3 Basic Constraints: CA:FALSE Netscape Comment: OpenSSL Generated Certificate X509v3 Subject Key Identifier: 38:19:4F:BF:C1:71:41:FE:78:91:B0:09:39:8B:AD:D7:05:B9:D9:82 X509v3 Authority Key Identifier: 03:E4:E7:DA:0F:64:DB:13:1E:BD:85:AB:76:BC:29:CA:2F:A7:C7:4B X509v3 Subject Alternative Name: DNS:localhost, DNS:test-httpd Signature Algorithm: sha256WithRSAEncryption Signature Value: 07:59:06:b5:60:2d:55:ce:09:bd:f1:46:19:ef:e5:90:fa:b8: bf:da:08:ac:cd:96:9e:06:e4:b2:dc:1c:92:bf:b4:c0:ee:84: d5:39:92:43:84:bc:c7:c9:ea:6d:c0:90:f5:0c:d3:df:09:c2: c3:44:6b:5e:4d:fe:7f:6b:04:f9:58:9f:b3:e8:2f:ad:9a:09: 91:b7:3c:dc:2b:ff:6c:db:9f:c8:63:aa:33:0e:3a:93:8e:2a: 99:c4:c0:c0:5a:a1:d1:a2:79:ac:07:cf:f6:aa:f7:f3:7a:42: 9a:99:47:7c:9e:a3:7a:0c:bd:59:d1:07:18:de:f5:64:71:53: 83:99:38:bf:12:30:8d:89:49:8d:4b:c9:58:03:5e:6d:86:58: f3:32:a9:e0:24:18:0f:60:79:5a:54:8b:9e:be:9d:68:41:24: 4b:2b:f8:d0:21:74:9e:bc:ea:f9:0c:c0:f9:56:e2:2c:ff:69: 71:03:5c:76:d2:ea:f6:9c:05:4f:d2:28:7c:99:a1:5d:aa:ab: 9b:31:82:ce:11:69:08:1c:5a:2c:86:92:4c:82:86:9a:ed:9f: f4:fe:c6:0b:df:1b:15:38:13:9c:3b:46:75:d8:ce:b0:ae:6e: 64:3f:1b:b4:0b:1a:fb:bc:67:f4:aa:8e:e3:42:e1:3e:6e:e7: 5f:98:64:2e -----BEGIN CERTIFICATE----- MIIEEjCCAvqgAwIBAgIBADANBgkqhkiG9w0BAQsFADB6MSMwIQYDVQQKDBpBcGFj aGUgU29mdHdhcmUgRm91bmRhdGlvbjEfMB0GA1UECwwWSHR0cENvbXBvbmVudHMg UHJvamVjdDEQMA4GA1UEAwwHVGVzdCBDQTEgMB4GCSqGSIb3DQEJARYRZGV2QGhj LmFwYWNoZS5vcmcwIBcNMjQxMDIwMTkxNDAyWhgPMjEyNDA5MjYxOTE0MDJaMHwx IzAhBgNVBAoMGkFwYWNoZSBTb2Z0d2FyZSBGb3VuZGF0aW9uMR8wHQYDVQQLDBZI dHRwQ29tcG9uZW50cyBQcm9qZWN0MRIwEAYDVQQDDAlsb2NhbGhvc3QxIDAeBgkq hkiG9w0BCQEWEWRldkBoYy5hcGFjaGUub3JnMIIBIjANBgkqhkiG9w0BAQEFAAOC AQ8AMIIBCgKCAQEAnRIP0Ip+CuR2uAivP18PtExwJCJOj49V7K4xbOIFaN/FwE3p pe3ZTnHt5zxRrAr+IZZ8DHsv+m9Pc2k4oCWnTNBp/KKNlMtPnscfo7JblF8gPGFN c6acpHxyJSbuptDY8Enns+D1Td5uVIC5VIw3ndLArItDA42cyayR+TFPbekt1d65 xDTeZz0aTiVDXu6OAWfWskpJU/nTDJNdqR9S9yOTHXM61OHdK6LRZbHvaRIa/Gsk fJZr0ichTjgEr+TR9k6yiqRZtsjFIdXA1th+WLJOOp5vgYoaDg5haRXLehkaN2I7 lrM7IBG3HqZjOSsMwit3ew0h70Imcc52SctoMwIDAQABo4GeMIGbMAkGA1UdEwQC MAAwLAYJYIZIAYb4QgENBB8WHU9wZW5TU0wgR2VuZXJhdGVkIENlcnRpZmljYXRl MB0GA1UdDgQWBBQ4GU+/wXFB/niRsAk5i63XBbnZgjAfBgNVHSMEGDAWgBQD5Ofa D2TbEx69hat2vCnKL6fHSzAgBgNVHREEGTAXgglsb2NhbGhvc3SCCnRlc3QtaHR0 cGQwDQYJKoZIhvcNAQELBQADggEBAAdZBrVgLVXOCb3xRhnv5ZD6uL/aCKzNlp4G 5LLcHJK/tMDuhNU5kkOEvMfJ6m3AkPUM098JwsNEa15N/n9rBPlYn7PoL62aCZG3 PNwr/2zbn8hjqjMOOpOOKpnEwMBaodGieawHz/aq9/N6QpqZR3yeo3oMvVnRBxje 9WRxU4OZOL8SMI2JSY1LyVgDXm2GWPMyqeAkGA9geVpUi56+nWhBJEsr+NAhdJ68 6vkMwPlW4iz/aXEDXHbS6vacBU/SKHyZoV2qq5sxgs4RaQgcWiyGkkyChprtn/T+ xgvfGxU4E5w7RnXYzrCubmQ/G7QLGvu8Z/SqjuNC4T5u51+YZC4= -----END CERTIFICATE----- httpclient5-testing/src/test/resources/docker/server-key.pem0100664 0000000 0000000 00000003250 15005672016 023355 0ustar000000000 0000000 -----BEGIN PRIVATE KEY----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCdEg/Qin4K5Ha4 CK8/Xw+0THAkIk6Pj1XsrjFs4gVo38XATeml7dlOce3nPFGsCv4hlnwMey/6b09z aTigJadM0Gn8oo2Uy0+exx+jsluUXyA8YU1zppykfHIlJu6m0NjwSeez4PVN3m5U gLlUjDed0sCsi0MDjZzJrJH5MU9t6S3V3rnENN5nPRpOJUNe7o4BZ9aySklT+dMM k12pH1L3I5MdczrU4d0rotFlse9pEhr8ayR8lmvSJyFOOASv5NH2TrKKpFm2yMUh 1cDW2H5Ysk46nm+BihoODmFpFct6GRo3YjuWszsgEbcepmM5KwzCK3d7DSHvQiZx znZJy2gzAgMBAAECggEAB11ucmfcCyS1UGHP3dfWQ60F4RvetSqSa9urI6Dhgg5k FmVQ3F/vvZboAdy5M6j8S5Tj0i4AjOylPBMl/ZRmaNqo7ZitrNlvrVFG8YUOeEGR oGMrn42jcK8JJybRL+9BDNtaSvv0ZKdWYw36IrXEcdkNAcox5TvBq081NQsT32Jp 2/dZB6yDlxTD8NVf1mzaeO0v+VxbRvPQ7HY9o0F1FVxBot/NjidU/fQwSSg2lFNq K+u9q5W2e0Ca2KYEV7tHpOJMmMKH6kOYjM+UiQpPWXiuClcf+LbCsj4v3a5MrlsM fdDFMnddn6cvM3RP/lpELCqSgkzTM3srAFydY6wMEQKBgQDPUOQaxo/xPYVAGW/Q THbQjfA7fZweWNT2EmB3PsDA/79TtkKgFF/kuSoq5AOYcQOP3Q0qZF9DjeIhL0tK WZxV9Y24q/EfnLpZOjui+SHu+RA6paFYveKcy7Mj3E5A/D3qKwDIPYX/K195LaEd Pll5hiWcwWIqj1bEerqPSIvSqQKBgQDB9JeR/kPvnNFXnXtUQ/o0w42GKr1Gx5HW iiNllS5OwOGKXif8+T+liJ2eUFJ5lFb6eZhTSdWEUqygDDE00XDwnjUQm4tvBK/3 vfAkpT6RDtLZ7rIWXHXN+45MTl6LhSBYNphZK6UFY4JvtJSweRbXl8OnK1peENTE OOvvpRNJewKBgBwc1QHIgUZuWD5r9Jyjcc0wIi5/Bweadi50KX6iFNNXGuPIKFq6 yJIkhdJRHyex05DTofBosf5gJBTp6+TGKAwEA1bSgh0OTLrCycl8zRwxzACX6zw0 a6FlggJP4pCvY9n4QN/mb+A9SnINPPbROKLhDQKnup8Y1uRH3DqH1OYZAoGBAKO6 MPT5+ilcbM+UThbNJ3rBFUgL7inAsFi11bmb3DJ42iuu3fzL/zFiiQOqdGTTlzTr zm2Ip2iDTdvxTtxybO+B7fOuCl9WSqFMwlp877sOE2oK+GSt+ng+gVni0ibe43Xz 6Fll4XESFnrrqpTqMyEdqPkGPMupU6KtFmX/KK/fAoGAdYADpMf467obKaUPOvR+ wPUjCQlopCK6wCFE2kuEv3e64NOpN7VJ1GHzro4DsaxndBHhG3+Pml3fnoclZgYP 9LVY/rduV+2xwP6GVd5iLSFKtaXPGVxkGPKEgX6842Z6i7BLUQZQyWHr19UEkgFj RB0YbKKxrC01hpdKKHWMlHU= -----END PRIVATE KEY----- httpclient5-testing/src/test/resources/docker/BUILDING.txt0100664 0000000 0000000 00000002140 15005672016 022511 0ustar000000000 0000000 = SSL key / cert material Execute in the project root # Issue a certificate request --- openssl req -config test-CA/openssl.cnf -new -nodes -sha256 -days 36500 \ -subj '/O=Apache Software Foundation/OU=HttpComponents Project/CN=localhost/emailAddress=dev@hc.apache.org/' \ -addext 'subjectAltName = DNS:localhost,DNS:test-httpd' \ -keyout httpclient5-testing/src/test/resources/docker/server-key.pem \ -out httpclient5-testing/src/test/resources/docker/server-certreq.pem --- # Verify the request --- openssl req -in httpclient5-testing/src/test/resources/docker/server-certreq.pem -text -noout --- # Sign new certificate with the test CA key --- openssl ca -config test-CA/openssl.cnf -days 36500 \ -out httpclient5-testing/src/test/resources/docker/server-cert.pem \ -in httpclient5-testing/src/test/resources/docker/server-certreq.pem \ && rm httpclient5-testing/src/test/resources/docker/server-certreq.pem --- # Create JKS store with the Test CA cert keytool -import -trustcacerts -alias test-ca -file test-CA/ca-cert.pem -keystore httpcore5-testing/src/test/resources/test-ca.jks -storepass nopassword httpclient5-testing/src/test/resources/docker/httpd/0040775 0000000 0000000 00000000000 15005672016 021704 5ustar000000000 0000000 httpclient5-testing/src/test/resources/docker/httpd/httpd.conf0100664 0000000 0000000 00000053167 15005672016 023707 0ustar000000000 0000000 # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # ========================================================================== # This is the main Apache HTTP server configuration file. It contains the # configuration directives that give the server its instructions. # See for detailed information. # In particular, see # # for a discussion of each configuration directive. # # Do NOT simply read the instructions in here without understanding # what they do. They're here only as hints or reminders. If you are unsure # consult the online docs. You have been warned. # # Configuration and logfile names: If the filenames you specify for many # of the server's control files begin with "/" (or "drive:/" for Win32), the # server will use that explicit path. If the filenames do *not* begin # with "/", the value of ServerRoot is prepended -- so "logs/access_log" # with ServerRoot set to "/usr/local/apache2" will be interpreted by the # server as "/usr/local/apache2/logs/access_log", whereas "/logs/access_log" # will be interpreted as '/logs/access_log'. # # ServerRoot: The top of the directory tree under which the server's # configuration, error, and log files are kept. # # Do not add a slash at the end of the directory path. If you point # ServerRoot at a non-local disk, be sure to specify a local disk on the # Mutex directive, if file-based mutexes are used. If you wish to share the # same ServerRoot for multiple httpd daemons, you will need to change at # least PidFile. # ServerRoot "/usr/local/apache2" # # Mutex: Allows you to set the mutex mechanism and mutex file directory # for individual mutexes, or change the global defaults # # Uncomment and change the directory if mutexes are file-based and the default # mutex file directory is not on a local disk or is not appropriate for some # other reason. # # Mutex default:logs # # Listen: Allows you to bind Apache to specific IP addresses and/or # ports, instead of the default. See also the # directive. # # Change this to Listen on specific IP addresses as shown below to # prevent Apache from glomming onto all bound IP addresses. # #Listen 12.34.56.78:80 Listen 8080 # # Dynamic Shared Object (DSO) Support # # To be able to use the functionality of a module which was built as a DSO you # have to place corresponding `LoadModule' lines at this location so the # directives contained in it are actually available _before_ they are used. # Statically compiled modules (those listed by `httpd -l') do not need # to be loaded here. # # Example: # LoadModule foo_module modules/mod_foo.so # LoadModule mpm_event_module modules/mod_mpm_event.so #LoadModule mpm_prefork_module modules/mod_mpm_prefork.so #LoadModule mpm_worker_module modules/mod_mpm_worker.so LoadModule authn_file_module modules/mod_authn_file.so #LoadModule authn_dbm_module modules/mod_authn_dbm.so #LoadModule authn_anon_module modules/mod_authn_anon.so #LoadModule authn_dbd_module modules/mod_authn_dbd.so #LoadModule authn_socache_module modules/mod_authn_socache.so LoadModule authn_core_module modules/mod_authn_core.so LoadModule authz_host_module modules/mod_authz_host.so LoadModule authz_groupfile_module modules/mod_authz_groupfile.so LoadModule authz_user_module modules/mod_authz_user.so #LoadModule authz_dbm_module modules/mod_authz_dbm.so #LoadModule authz_owner_module modules/mod_authz_owner.so #LoadModule authz_dbd_module modules/mod_authz_dbd.so LoadModule authz_core_module modules/mod_authz_core.so #LoadModule authnz_ldap_module modules/mod_authnz_ldap.so #LoadModule authnz_fcgi_module modules/mod_authnz_fcgi.so LoadModule access_compat_module modules/mod_access_compat.so LoadModule auth_basic_module modules/mod_auth_basic.so #LoadModule auth_form_module modules/mod_auth_form.so LoadModule auth_digest_module modules/mod_auth_digest.so #LoadModule allowmethods_module modules/mod_allowmethods.so #LoadModule isapi_module modules/mod_isapi.so #LoadModule file_cache_module modules/mod_file_cache.so #LoadModule cache_module modules/mod_cache.so #LoadModule cache_disk_module modules/mod_cache_disk.so #LoadModule cache_socache_module modules/mod_cache_socache.so #LoadModule socache_shmcb_module modules/mod_socache_shmcb.so #LoadModule socache_dbm_module modules/mod_socache_dbm.so #LoadModule socache_memcache_module modules/mod_socache_memcache.so #LoadModule watchdog_module modules/mod_watchdog.so #LoadModule macro_module modules/mod_macro.so #LoadModule dbd_module modules/mod_dbd.so #LoadModule bucketeer_module modules/mod_bucketeer.so #LoadModule dumpio_module modules/mod_dumpio.so #LoadModule echo_module modules/mod_echo.so #LoadModule example_hooks_module modules/mod_example_hooks.so #LoadModule case_filter_module modules/mod_case_filter.so #LoadModule case_filter_in_module modules/mod_case_filter_in.so #LoadModule example_ipc_module modules/mod_example_ipc.so #LoadModule buffer_module modules/mod_buffer.so #LoadModule data_module modules/mod_data.so #LoadModule ratelimit_module modules/mod_ratelimit.so LoadModule reqtimeout_module modules/mod_reqtimeout.so #LoadModule ext_filter_module modules/mod_ext_filter.so #LoadModule request_module modules/mod_request.so #LoadModule include_module modules/mod_include.so LoadModule filter_module modules/mod_filter.so #LoadModule reflector_module modules/mod_reflector.so #LoadModule substitute_module modules/mod_substitute.so #LoadModule sed_module modules/mod_sed.so #LoadModule charset_lite_module modules/mod_charset_lite.so #LoadModule deflate_module modules/mod_deflate.so #LoadModule xml2enc_module modules/mod_xml2enc.so #LoadModule proxy_html_module modules/mod_proxy_html.so LoadModule mime_module modules/mod_mime.so #LoadModule ldap_module modules/mod_ldap.so LoadModule log_config_module modules/mod_log_config.so #LoadModule log_debug_module modules/mod_log_debug.so #LoadModule log_forensic_module modules/mod_log_forensic.so #LoadModule logio_module modules/mod_logio.so #LoadModule lua_module modules/mod_lua.so LoadModule env_module modules/mod_env.so #LoadModule mime_magic_module modules/mod_mime_magic.so #LoadModule cern_meta_module modules/mod_cern_meta.so #LoadModule expires_module modules/mod_expires.so LoadModule headers_module modules/mod_headers.so #LoadModule ident_module modules/mod_ident.so #LoadModule usertrack_module modules/mod_usertrack.so #LoadModule unique_id_module modules/mod_unique_id.so LoadModule setenvif_module modules/mod_setenvif.so LoadModule version_module modules/mod_version.so #LoadModule remoteip_module modules/mod_remoteip.so #LoadModule proxy_module modules/mod_proxy.so #LoadModule proxy_connect_module modules/mod_proxy_connect.so #LoadModule proxy_ftp_module modules/mod_proxy_ftp.so #LoadModule proxy_http_module modules/mod_proxy_http.so #LoadModule proxy_fcgi_module modules/mod_proxy_fcgi.so #LoadModule proxy_scgi_module modules/mod_proxy_scgi.so #LoadModule proxy_uwsgi_module modules/mod_proxy_uwsgi.so #LoadModule proxy_fdpass_module modules/mod_proxy_fdpass.so #LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so #LoadModule proxy_ajp_module modules/mod_proxy_ajp.so #LoadModule proxy_balancer_module modules/mod_proxy_balancer.so #LoadModule proxy_express_module modules/mod_proxy_express.so #LoadModule proxy_hcheck_module modules/mod_proxy_hcheck.so #LoadModule session_module modules/mod_session.so #LoadModule session_cookie_module modules/mod_session_cookie.so #LoadModule session_crypto_module modules/mod_session_crypto.so #LoadModule session_dbd_module modules/mod_session_dbd.so #LoadModule slotmem_shm_module modules/mod_slotmem_shm.so #LoadModule slotmem_plain_module modules/mod_slotmem_plain.so #LoadModule ssl_module modules/mod_ssl.so #LoadModule optional_hook_export_module modules/mod_optional_hook_export.so #LoadModule optional_hook_import_module modules/mod_optional_hook_import.so #LoadModule optional_fn_import_module modules/mod_optional_fn_import.so #LoadModule optional_fn_export_module modules/mod_optional_fn_export.so #LoadModule dialup_module modules/mod_dialup.so LoadModule http2_module modules/mod_http2.so #LoadModule proxy_http2_module modules/mod_proxy_http2.so #LoadModule lbmethod_byrequests_module modules/mod_lbmethod_byrequests.so #LoadModule lbmethod_bytraffic_module modules/mod_lbmethod_bytraffic.so #LoadModule lbmethod_bybusyness_module modules/mod_lbmethod_bybusyness.so #LoadModule lbmethod_heartbeat_module modules/mod_lbmethod_heartbeat.so LoadModule unixd_module modules/mod_unixd.so #LoadModule heartbeat_module modules/mod_heartbeat.so #LoadModule heartmonitor_module modules/mod_heartmonitor.so #LoadModule dav_module modules/mod_dav.so LoadModule status_module modules/mod_status.so LoadModule autoindex_module modules/mod_autoindex.so #LoadModule asis_module modules/mod_asis.so #LoadModule info_module modules/mod_info.so #LoadModule suexec_module modules/mod_suexec.so #LoadModule cgid_module modules/mod_cgid.so #LoadModule cgi_module modules/mod_cgi.so #LoadModule dav_fs_module modules/mod_dav_fs.so #LoadModule dav_lock_module modules/mod_dav_lock.so #LoadModule vhost_alias_module modules/mod_vhost_alias.so #LoadModule negotiation_module modules/mod_negotiation.so LoadModule dir_module modules/mod_dir.so #LoadModule imagemap_module modules/mod_imagemap.so #LoadModule actions_module modules/mod_actions.so #LoadModule speling_module modules/mod_speling.so #LoadModule userdir_module modules/mod_userdir.so LoadModule alias_module modules/mod_alias.so #LoadModule rewrite_module modules/mod_rewrite.so # # If you wish httpd to run as a different user or group, you must run # httpd as root initially and it will switch. # # User/Group: The name (or #number) of the user/group to run httpd as. # It is usually good practice to create a dedicated user and group for # running httpd, as with most system services. # User daemon Group daemon # 'Main' server configuration # # The directives in this section set up the values used by the 'main' # server, which responds to any requests that aren't handled by a # definition. These values also provide defaults for # any containers you may define later in the file. # # All of these directives may appear inside containers, # in which case these default settings will be overridden for the # virtual host being defined. # # # ServerAdmin: Your address, where problems with the server should be # e-mailed. This address appears on some server-generated pages, such # as error documents. e.g. admin@your-domain.com # ServerAdmin dev@hc.apache.org # # ServerName gives the name and port that the server uses to identify itself. # This can often be determined automatically, but we recommend you specify # it explicitly to prevent problems during startup. # # If your host doesn't have a registered DNS name, enter its IP address here. # ServerName localhost:8080 Protocols h2c http/1.1 LogLevel http2:info H2Push on # # Deny access to the entirety of your server's filesystem. You must # explicitly permit access to web content directories in other # blocks below. # AllowOverride none Require all denied # # Note that from this point forward you must specifically allow # particular features to be enabled - so if something's not working as # you might expect, make sure that you have specifically enabled it # below. # # # DocumentRoot: The directory out of which you will serve your # documents. By default, all requests are taken from this directory, but # symbolic links and aliases may be used to point to other locations. # DocumentRoot "/var/httpd/www" # # Possible values for the Options directive are "None", "All", # or any combination of: # Indexes Includes FollowSymLinks SymLinksifOwnerMatch ExecCGI MultiViews # # Note that "MultiViews" must be named *explicitly* --- "Options All" # doesn't give it to you. # # The Options directive is both complicated and important. Please see # http://httpd.apache.org/docs/2.4/mod/core.html#options # for more information. # Options Indexes FollowSymLinks # # AllowOverride controls what directives may be placed in .htaccess files. # It can be "All", "None", or any combination of the keywords: # AllowOverride FileInfo AuthConfig Limit # AllowOverride None # # Controls who can get stuff from this server. # Require all granted Header set Cache-Control "max-age=600" # # DirectoryIndex: sets the file that Apache will serve if a directory # is requested. # DirectoryIndex index.html # # The following lines prevent .htaccess and .htpasswd files from being # viewed by Web clients. # Require all denied # # ErrorLog: The location of the error log file. # If you do not specify an ErrorLog directive within a # container, error messages relating to that virtual host will be # logged here. If you *do* define an error logfile for a # container, that host's errors will be logged there and not here. # ErrorLog /proc/self/fd/2 # # LogLevel: Control the number of messages logged to the error_log. # Possible values include: debug, info, notice, warn, error, crit, # alert, emerg. # LogLevel warn # # The following directives define some format nicknames for use with # a CustomLog directive (see below). # LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined LogFormat "%h %l %u %t \"%r\" %>s %b" common # You need to enable mod_logio.c to use %I and %O LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %I %O" combinedio # # The location and format of the access logfile (Common Logfile Format). # If you do not define any access logfiles within a # container, they will be logged here. Contrariwise, if you *do* # define per- access logfiles, transactions will be # logged therein and *not* in this file. # CustomLog /proc/self/fd/1 common # # If you prefer a logfile with access, agent, and referer information # (Combined Logfile Format) you can use the following directive. # #CustomLog "logs/access_log" combined # # Redirect: Allows you to tell clients about documents that used to # exist in your server's namespace, but do not anymore. The client # will make a new request for the document at its new location. # Example: # Redirect permanent /foo http://www.example.com/bar # # Alias: Maps web paths into filesystem paths and is used to # access content that does not live under the DocumentRoot. # Example: # Alias /webpath /full/filesystem/path # # If you include a trailing / on /webpath then the server will # require it to be present in the URL. You will also likely # need to provide a section to allow access to # the filesystem path. # # ScriptAlias: This controls which directories contain server scripts. # ScriptAliases are essentially the same as Aliases, except that # documents in the target directory are treated as applications and # run by the server when requested rather than as documents sent to the # client. The same rules about trailing "/" apply to ScriptAlias # directives as to Alias. # ScriptAlias /cgi-bin/ "/usr/local/apache2/cgi-bin/" # # ScriptSock: On threaded servers, designate the path to the UNIX # socket used to communicate with the CGI daemon of mod_cgid. # #Scriptsock cgisock # # "/usr/local/apache2/cgi-bin" should be changed to whatever your ScriptAliased # CGI directory exists, if you have that configured. # AllowOverride None Options None Require all granted # # Avoid passing HTTP_PROXY environment to CGI's on this or any proxied # backend servers which have lingering "httpoxy" defects. # 'Proxy' request header is undefined by the IETF, not listed by IANA # RequestHeader unset Proxy early # # TypesConfig points to the file containing the list of mappings from # filename extension to MIME-type. # TypesConfig conf/mime.types # # AddType allows you to add to or override the MIME configuration # file specified in TypesConfig for specific file types. # #AddType application/x-gzip .tgz # # AddEncoding allows you to have certain browsers uncompress # information on the fly. Note: Not all browsers support this. # #AddEncoding x-compress .Z #AddEncoding x-gzip .gz .tgz # # If the AddEncoding directives above are commented-out, then you # probably should define those extensions to indicate media types: # AddType application/x-compress .Z AddType application/x-gzip .gz .tgz # # AddHandler allows you to map certain file extensions to "handlers": # actions unrelated to filetype. These can be either built into the server # or added with the Action directive (see below) # # To use CGI scripts outside of ScriptAliased directories: # (You will also need to add "ExecCGI" to the "Options" directive.) # #AddHandler cgi-script .cgi # For type maps (negotiated resources): #AddHandler type-map var # # Filters allow you to process content before it is sent to the client. # # To parse .shtml files for server-side includes (SSI): # (You will also need to add "Includes" to the "Options" directive.) # #AddType text/html .shtml #AddOutputFilter INCLUDES .shtml # # The mod_mime_magic module allows the server to use various hints from the # contents of the file itself to determine its type. The MIMEMagicFile # directive tells the module where the hint definitions are located. # #MIMEMagicFile conf/magic # # Customizable error responses come in three flavors: # 1) plain text 2) local redirects 3) external redirects # # Some examples: #ErrorDocument 500 "The server made a boo boo." #ErrorDocument 404 /missing.html #ErrorDocument 404 "/cgi-bin/missing_handler.pl" #ErrorDocument 402 http://www.example.com/subscription_info.html # # # MaxRanges: Maximum number of Ranges in a request before # returning the entire resource, or one of the special # values 'default', 'none' or 'unlimited'. # Default setting is to accept 200 Ranges. #MaxRanges unlimited # # EnableMMAP and EnableSendfile: On systems that support it, # memory-mapping or the sendfile syscall may be used to deliver # files. This usually improves server performance, but must # be turned off when serving from networked-mounted # filesystems or if support for these functions is otherwise # broken on your system. # Defaults: EnableMMAP On, EnableSendfile Off # #EnableMMAP off #EnableSendfile on # Supplemental configuration # # The configuration files in the conf/extra/ directory can be # included to add extra features or to modify the default configuration of # the server, or you may simply copy their contents here and change as # necessary. # Server-pool management (MPM specific) #Include conf/extra/httpd-mpm.conf # Multi-language error messages #Include conf/extra/httpd-multilang-errordoc.conf # Fancy directory listings #Include conf/extra/httpd-autoindex.conf # Language settings #Include conf/extra/httpd-languages.conf # User home directories #Include conf/extra/httpd-userdir.conf # Real-time info on requests and configuration #Include conf/extra/httpd-info.conf # Virtual hosts #Include conf/extra/httpd-vhosts.conf # Local access to the Apache HTTP Server Manual #Include conf/extra/httpd-manual.conf # Distributed authoring and versioning (WebDAV) #Include conf/extra/httpd-dav.conf # Various default settings #Include conf/extra/httpd-default.conf # Configure mod_proxy_html to understand HTML4/XHTML1 Include conf/extra/proxy-html.conf # Secure (SSL/TLS) connections Include conf/extra/httpd-ssl.conf # # Note: The following must must be present to support # starting without SSL on platforms with no /dev/random equivalent # but a statically compiled-in mod_ssl. # SSLRandomSeed startup builtin SSLRandomSeed connect builtin AuthType Basic AuthName "Restricted Files" AuthBasicProvider file AuthUserFile "/var/httpd/www/private/.htpasswd" Require valid-user AuthType Digest AuthName "Restricted Files" AuthDigestDomain / AuthBasicProvider file AuthUserFile "/var/httpd/www/private/.htpasswd_digest" Require valid-user httpclient5-testing/src/test/resources/docker/httpd/httpd-ssl.conf0100664 0000000 0000000 00000034431 15005672016 024477 0ustar000000000 0000000 # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # ========================================================================== # # This is the Apache server configuration file providing SSL support. # It contains the configuration directives to instruct the server how to # serve pages over an https connection. For detailed information about these # directives see # # Do NOT simply read the instructions in here without understanding # what they do. They're here only as hints or reminders. If you are unsure # consult the online docs. You have been warned. # # Required modules: mod_log_config, mod_setenvif, mod_ssl, # socache_shmcb_module (for default value of SSLSessionCache) LoadModule ssl_module modules/mod_ssl.so LoadModule socache_shmcb_module modules/mod_socache_shmcb.so # # Pseudo Random Number Generator (PRNG): # Configure one or more sources to seed the PRNG of the SSL library. # The seed data should be of good random quality. # WARNING! On some platforms /dev/random blocks if not enough entropy # is available. This means you then cannot use the /dev/random device # because it would lead to very long connection times (as long as # it requires to make more entropy available). But usually those # platforms additionally provide a /dev/urandom device which doesn't # block. So, if available, use this one instead. Read the mod_ssl User # Manual for more details. # #SSLRandomSeed startup file:/dev/random 512 #SSLRandomSeed startup file:/dev/urandom 512 #SSLRandomSeed connect file:/dev/random 512 #SSLRandomSeed connect file:/dev/urandom 512 # # When we also provide SSL we have to listen to the # standard HTTP port (see above) and to the HTTPS port # Listen 8443 ## ## SSL Global Context ## ## All SSL configuration in this context applies both to ## the main server and all SSL-enabled virtual hosts. ## # SSL Cipher Suite: # List the ciphers that the client is permitted to negotiate, # and that httpd will negotiate as the client of a proxied server. # See the OpenSSL documentation for a complete list of ciphers, and # ensure these follow appropriate best practices for this deployment. # httpd 2.2.30, 2.4.13 and later force-disable aNULL, eNULL and EXP ciphers, # while OpenSSL disabled these by default in 0.9.8zf/1.0.0r/1.0.1m/1.0.2a. SSLCipherSuite HIGH:MEDIUM:!MD5:!RC4:!3DES SSLProxyCipherSuite HIGH:MEDIUM:!MD5:!RC4:!3DES # By the end of 2016, only TLSv1.2 ciphers should remain in use. # Older ciphers should be disallowed as soon as possible, while the # kRSA ciphers do not offer forward secrecy. These changes inhibit # older clients (such as IE6 SP2 or IE8 on Windows XP, or other legacy # non-browser tooling) from successfully connecting. # # To restrict mod_ssl to use only TLSv1.2 ciphers, and disable # those protocols which do not support forward secrecy, replace # the SSLCipherSuite and SSLProxyCipherSuite directives above with # the following two directives, as soon as practical. # SSLCipherSuite HIGH:MEDIUM:!SSLv3:!kRSA # SSLProxyCipherSuite HIGH:MEDIUM:!SSLv3:!kRSA # User agents such as web browsers are not configured for the user's # own preference of either security or performance, therefore this # must be the prerogative of the web server administrator who manages # cpu load versus confidentiality, so enforce the server's cipher order. SSLHonorCipherOrder on # SSL Protocol support: # List the protocol versions which clients are allowed to connect with. # Disable SSLv3 by default (cf. RFC 7525 3.1.1). TLSv1 (1.0) should be # disabled as quickly as practical. By the end of 2016, only the TLSv1.2 # protocol or later should remain in use. SSLProtocol all -SSLv3 SSLProxyProtocol all -SSLv3 # Pass Phrase Dialog: # Configure the pass phrase gathering process. # The filtering dialog program (`builtin' is an internal # terminal dialog) has to provide the pass phrase on stdout. SSLPassPhraseDialog builtin # Inter-Process Session Cache: # Configure the SSL Session Cache: First the mechanism # to use and second the expiring timeout (in seconds). #SSLSessionCache "dbm:/usr/local/apache2/logs/ssl_scache" SSLSessionCache "shmcb:/usr/local/apache2/logs/ssl_scache(512000)" SSLSessionCacheTimeout 300 # OCSP Stapling (requires OpenSSL 0.9.8h or later) # # This feature is disabled by default and requires at least # the two directives SSLUseStapling and SSLStaplingCache. # Refer to the documentation on OCSP Stapling in the SSL/TLS # How-To for more information. # # Enable stapling for all SSL-enabled servers: #SSLUseStapling On # Define a relatively small cache for OCSP Stapling using # the same mechanism that is used for the SSL session cache # above. If stapling is used with more than a few certificates, # the size may need to be increased. (AH01929 will be logged.) #SSLStaplingCache "shmcb:/usr/local/apache2/logs/ssl_stapling(32768)" # Seconds before valid OCSP responses are expired from the cache #SSLStaplingStandardCacheTimeout 3600 # Seconds before invalid OCSP responses are expired from the cache #SSLStaplingErrorCacheTimeout 600 ## ## SSL Virtual Host Context ## # General setup for the virtual host Protocols h2 http/1.1 LogLevel http2:info H2Push on H2Direct on ServerAdmin dev@hc.apache.org ServerName localhost:8443 ErrorLog /proc/self/fd/2 TransferLog /proc/self/fd/2 DocumentRoot "/var/httpd/www" Options Indexes FollowSymLinks AllowOverride None Require all granted Header set Cache-Control "max-age=600" # SSL Engine Switch: # Enable/Disable SSL for this virtual host. SSLEngine on # Server Certificate: # Point SSLCertificateFile at a PEM encoded certificate. If # the certificate is encrypted, then you will be prompted for a # pass phrase. Note that a kill -HUP will prompt again. Keep # in mind that if you have both an RSA and a DSA certificate you # can configure both in parallel (to also allow the use of DSA # ciphers, etc.) # Some ECC cipher suites (http://www.ietf.org/rfc/rfc4492.txt) # require an ECC certificate which can also be configured in # parallel. SSLCertificateFile "/usr/local/apache2/ssl/server-cert.pem" #SSLCertificateFile "/usr/local/apache2/conf/server-dsa.crt" #SSLCertificateFile "/usr/local/apache2/conf/server-ecc.crt" # Server Private Key: # If the key is not combined with the certificate, use this # directive to point at the key file. Keep in mind that if # you've both a RSA and a DSA private key you can configure # both in parallel (to also allow the use of DSA ciphers, etc.) # ECC keys, when in use, can also be configured in parallel SSLCertificateKeyFile "/usr/local/apache2/ssl/server-key.pem" #SSLCertificateKeyFile "/usr/local/apache2/conf/server-dsa.key" #SSLCertificateKeyFile "/usr/local/apache2/conf/server-ecc.key" # Server Certificate Chain: # Point SSLCertificateChainFile at a file containing the # concatenation of PEM encoded CA certificates which form the # certificate chain for the server certificate. Alternatively # the referenced file can be the same as SSLCertificateFile # when the CA certificates are directly appended to the server # certificate for convenience. #SSLCertificateChainFile "/usr/local/apache2/conf/server-ca.crt" # Certificate Authority (CA): # Set the CA certificate verification path where to find CA # certificates for client authentication or alternatively one # huge file containing all of them (file must be PEM encoded) # Note: Inside SSLCACertificatePath you need hash symlinks # to point to the certificate files. Use the provided # Makefile to update the hash symlinks after changes. #SSLCACertificatePath "/usr/local/apache2/conf/ssl.crt" #SSLCACertificateFile "/usr/local/apache2/conf/ssl.crt/ca-bundle.crt" # Certificate Revocation Lists (CRL): # Set the CA revocation path where to find CA CRLs for client # authentication or alternatively one huge file containing all # of them (file must be PEM encoded). # The CRL checking mode needs to be configured explicitly # through SSLCARevocationCheck (defaults to "none" otherwise). # Note: Inside SSLCARevocationPath you need hash symlinks # to point to the certificate files. Use the provided # Makefile to update the hash symlinks after changes. #SSLCARevocationPath "/usr/local/apache2/conf/ssl.crl" #SSLCARevocationFile "/usr/local/apache2/conf/ssl.crl/ca-bundle.crl" #SSLCARevocationCheck chain # Client Authentication (Type): # Client certificate verification type and depth. Types are # none, optional, require and optional_no_ca. Depth is a # number which specifies how deeply to verify the certificate # issuer chain before deciding the certificate is not valid. #SSLVerifyClient require #SSLVerifyDepth 10 # TLS-SRP mutual authentication: # Enable TLS-SRP and set the path to the OpenSSL SRP verifier # file (containing login information for SRP user accounts). # Requires OpenSSL 1.0.1 or newer. See the mod_ssl FAQ for # detailed instructions on creating this file. Example: # "openssl srp -srpvfile /usr/local/apache2/conf/passwd.srpv -add username" #SSLSRPVerifierFile "/usr/local/apache2/conf/passwd.srpv" # Access Control: # With SSLRequire you can do per-directory access control based # on arbitrary complex boolean expressions containing server # variable checks and other lookup directives. The syntax is a # mixture between C and Perl. See the mod_ssl documentation # for more details. # #SSLRequire ( %{SSL_CIPHER} !~ m/^(EXP|NULL)/ \ # and %{SSL_CLIENT_S_DN_O} eq "Snake Oil, Ltd." \ # and %{SSL_CLIENT_S_DN_OU} in {"Staff", "CA", "Dev"} \ # and %{TIME_WDAY} >= 1 and %{TIME_WDAY} <= 5 \ # and %{TIME_HOUR} >= 8 and %{TIME_HOUR} <= 20 ) \ # or %{REMOTE_ADDR} =~ m/^192\.76\.162\.[0-9]+$/ # # SSL Engine Options: # Set various options for the SSL engine. # o FakeBasicAuth: # Translate the client X.509 into a Basic Authorisation. This means that # the standard Auth/DBMAuth methods can be used for access control. The # user name is the `one line' version of the client's X.509 certificate. # Note that no password is obtained from the user. Every entry in the user # file needs this password: `xxj31ZMTZzkVA'. # o ExportCertData: # This exports two additional environment variables: SSL_CLIENT_CERT and # SSL_SERVER_CERT. These contain the PEM-encoded certificates of the # server (always existing) and the client (only existing when client # authentication is used). This can be used to import the certificates # into CGI scripts. # o StdEnvVars: # This exports the standard SSL/TLS related `SSL_*' environment variables. # Per default this exportation is switched off for performance reasons, # because the extraction step is an expensive operation and is usually # useless for serving static content. So one usually enables the # exportation for CGI and SSI requests only. # o StrictRequire: # This denies access when "SSLRequireSSL" or "SSLRequire" applied even # under a "Satisfy any" situation, i.e. when it applies access is denied # and no other module can change it. # o OptRenegotiate: # This enables optimized SSL connection renegotiation handling when SSL # directives are used in per-directory context. #SSLOptions +FakeBasicAuth +ExportCertData +StrictRequire SSLOptions +StdEnvVars SSLOptions +StdEnvVars # SSL Protocol Adjustments: # The safe and default but still SSL/TLS standard compliant shutdown # approach is that mod_ssl sends the close notify alert but doesn't wait for # the close notify alert from client. When you need a different shutdown # approach you can use one of the following variables: # o ssl-unclean-shutdown: # This forces an unclean shutdown when the connection is closed, i.e. no # SSL close notify alert is sent or allowed to be received. This violates # the SSL/TLS standard but is needed for some brain-dead browsers. Use # this when you receive I/O errors because of the standard approach where # mod_ssl sends the close notify alert. # o ssl-accurate-shutdown: # This forces an accurate shutdown when the connection is closed, i.e. a # SSL close notify alert is send and mod_ssl waits for the close notify # alert of the client. This is 100% SSL/TLS standard compliant, but in # practice often causes hanging connections with brain-dead browsers. Use # this only for browsers where you know that their SSL implementation # works correctly. # Notice: Most problems of broken clients are also related to the HTTP # keep-alive facility, so you usually additionally want to disable # keep-alive for those clients, too. Use variable "nokeepalive" for this. # Similarly, one has to force some clients to use HTTP/1.0 to workaround # their broken HTTP/1.1 implementation. Use variables "downgrade-1.0" and # "force-response-1.0" for this. BrowserMatch "MSIE [2-5]" \ nokeepalive ssl-unclean-shutdown \ downgrade-1.0 force-response-1.0 # Per-Server Logging: # The home of a custom SSL log file. Use this when you want a # compact non-error SSL logfile on a virtual host basis. CustomLog "/usr/local/apache2/logs/ssl_request_log" \ "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b" httpclient5-testing/src/test/java/0040775 0000000 0000000 00000000000 14666635064 016237 5ustar000000000 0000000 httpclient5-testing/src/test/java/org/0040775 0000000 0000000 00000000000 14666635064 017026 5ustar000000000 0000000 httpclient5-testing/src/test/java/org/apache/0040775 0000000 0000000 00000000000 14666635064 020247 5ustar000000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/0040775 0000000 0000000 00000000000 14666635064 020641 5ustar000000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/0040775 0000000 0000000 00000000000 14666635064 022204 5ustar000000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/0040775 0000000 0000000 00000000000 15063503632 023644 5ustar000000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/OldPathRedirectResolver.java0100664 0000000 0000000 00000005054 14666635064 031264 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing; import java.net.URI; import java.net.URISyntaxException; import org.apache.hc.client5.testing.redirect.Redirect; import org.apache.hc.client5.testing.redirect.RedirectResolver; import org.apache.hc.core5.net.URIBuilder; public class OldPathRedirectResolver implements RedirectResolver { private final String oldPath; private final String newPath; private final int status; private final Redirect.ConnControl connControl; public OldPathRedirectResolver( final String oldPath, final String newPath, final int status, final Redirect.ConnControl connControl) { this.oldPath = oldPath; this.newPath = newPath; this.status = status; this.connControl = connControl; } public OldPathRedirectResolver(final String oldPath, final String newPath, final int status) { this(oldPath, newPath, status, Redirect.ConnControl.PROTOCOL_DEFAULT); } @Override public Redirect resolve(final URI requestUri) throws URISyntaxException { final String path = requestUri.getPath(); if (path.startsWith(oldPath)) { final URI location = new URIBuilder(requestUri) .setPath(newPath + path.substring(oldPath.length())) .build(); return new Redirect(status, location.toString(), connControl); } return null; } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/BasicTestAuthenticator.java0100664 0000000 0000000 00000005263 15005672016 031125 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing; import java.util.Objects; import org.apache.hc.client5.testing.auth.AuthResult; import org.apache.hc.client5.testing.auth.Authenticator; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.TextUtils; public class BasicTestAuthenticator implements Authenticator { private final String userToken; private final String realm; public BasicTestAuthenticator(final String userToken, final String realm) { this.userToken = userToken; this.realm = realm; } @Override public boolean authenticate(final URIAuthority authority, final String requestUri, final String credentials) { return Objects.equals(userToken, credentials); } @Override public AuthResult perform(final URIAuthority authority, final String requestUri, final String credentials) { final boolean result = authenticate(authority, requestUri, credentials); if (result) { return new AuthResult(true); } if (TextUtils.isBlank(credentials)) { return new AuthResult(false); } final String error = credentials.endsWith("-expired") ? "token expired" : "invalid token"; return new AuthResult(false, new BasicNameValuePair("error", error)); } @Override public String getRealm(final URIAuthority authority, final String requestUri) { return realm; } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/0040775 0000000 0000000 00000000000 15063503637 024766 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000147 14704162040 011633 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/HttpMinimalIntegrationTests.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/HttpMinimalIntegrationTests.ja0100664 0000000 0000000 00000004115 14704162040 032743 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.core5.http.URIScheme; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Nested; class HttpMinimalIntegrationTests { @Nested @DisplayName("Fundamentals (HTTP/1.1)") class Http1 extends TestHttp1AsyncMinimal { public Http1() { super(URIScheme.HTTP); } } @Nested @DisplayName("Fundamentals (HTTP/1.1, TLS)") class Http1Tls extends TestHttp1AsyncMinimal { public Http1Tls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("Fundamentals (HTTP/2)") class H2 extends TestH2AsyncMinimal { public H2() { super(URIScheme.HTTP); } } @Nested @DisplayName("Fundamentals (HTTP/2, TLS)") class H2Tls extends TestH2AsyncMinimal { public H2Tls() { super(URIScheme.HTTPS); } } }httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttp1Reactive.java0100664 0000000 0000000 00000016663 15061532163 031157 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import static java.util.concurrent.TimeUnit.MILLISECONDS; import static org.hamcrest.MatcherAssert.assertThat; import java.nio.ByteBuffer; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManager; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.Message; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.support.AsyncRequestBuilder; import org.apache.hc.core5.reactive.ReactiveResponseConsumer; import org.apache.hc.core5.reactive.ReactiveServerExchangeHandler; import org.apache.hc.core5.testing.reactive.ReactiveRandomProcessor; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Timeout; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.ValueSource; import org.reactivestreams.Publisher; abstract class TestHttp1Reactive extends AbstractHttpReactiveFundamentalsTest { public TestHttp1Reactive(final URIScheme scheme) { super(scheme, ClientProtocolLevel.STANDARD, ServerProtocolLevel.STANDARD); } @ParameterizedTest(name = "{displayName}; concurrent connections: {0}") @ValueSource(ints = {5, 1, 20}) @Timeout(value = 60_000, unit = MILLISECONDS) public void testSequentialGetRequestsCloseConnection(final int concurrentConns) throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", () -> new ReactiveServerExchangeHandler(new ReactiveRandomProcessor()))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final PoolingAsyncClientConnectionManager connManager = client.getConnectionManager(); connManager.setDefaultMaxPerRoute(concurrentConns); connManager.setMaxTotal(100); for (int i = 0; i < 3; i++) { final SimpleHttpRequest get = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(); get.setHeader(HttpHeaders.CONNECTION, HeaderElements.CLOSE); final AsyncRequestProducer request = AsyncRequestBuilder.get(target + "/random/2048").build(); final ReactiveResponseConsumer consumer = new ReactiveResponseConsumer(); client.execute(request, consumer, null); final Message> response = consumer.getResponseFuture().get(); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getHead().getCode(), CoreMatchers.equalTo(200)); final String body = publisherToString(response.getBody()); assertThat(body, CoreMatchers.notNullValue()); assertThat(body.length(), CoreMatchers.equalTo(2048)); } } @Test @Timeout(value = 60_000, unit = MILLISECONDS) void testSharedPool() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", () -> new ReactiveServerExchangeHandler(new ReactiveRandomProcessor()))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final PoolingAsyncClientConnectionManager connManager = client.getConnectionManager(); final AsyncRequestProducer request1 = AsyncRequestBuilder.get(target + "/random/2048").build(); final ReactiveResponseConsumer consumer1 = new ReactiveResponseConsumer(); client.execute(request1, consumer1, null); final Message> response1 = consumer1.getResponseFuture().get(); assertThat(response1, CoreMatchers.notNullValue()); assertThat(response1.getHead(), CoreMatchers.notNullValue()); assertThat(response1.getHead().getCode(), CoreMatchers.equalTo(200)); final String body1 = publisherToString(response1.getBody()); assertThat(body1, CoreMatchers.notNullValue()); assertThat(body1.length(), CoreMatchers.equalTo(2048)); try (final CloseableHttpAsyncClient httpclient2 = HttpAsyncClients.custom() .setConnectionManager(connManager) .setConnectionManagerShared(true) .build()) { httpclient2.start(); final AsyncRequestProducer request2 = AsyncRequestBuilder.get(target + "/random/2048").build(); final ReactiveResponseConsumer consumer2 = new ReactiveResponseConsumer(); httpclient2.execute(request2, consumer2, null); final Message> response2 = consumer2.getResponseFuture().get(); assertThat(response2, CoreMatchers.notNullValue()); assertThat(response2.getHead().getCode(), CoreMatchers.equalTo(200)); final String body2 = publisherToString(response2.getBody()); assertThat(body2, CoreMatchers.notNullValue()); assertThat(body2.length(), CoreMatchers.equalTo(2048)); } final AsyncRequestProducer request3 = AsyncRequestBuilder.get(target + "/random/2048").build(); final ReactiveResponseConsumer consumer3 = new ReactiveResponseConsumer(); client.execute(request3, consumer3, null); final Message> response3 = consumer3.getResponseFuture().get(); assertThat(response3, CoreMatchers.notNullValue()); assertThat(response3.getHead().getCode(), CoreMatchers.equalTo(200)); final String body3 = publisherToString(response3.getBody()); assertThat(body3, CoreMatchers.notNullValue()); assertThat(body3.length(), CoreMatchers.equalTo(2048)); } } ././@LongLink0100644 0000000 0000000 00000000154 15061532347 011641 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttpAsyncMinimalTlsHandshake.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttpAsyncMinimalTlsHandsha0100664 0000000 0000000 00000007615 15061532347 032753 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import javax.net.ssl.SSLException; import org.apache.hc.client5.http.impl.async.MinimalHttpAsyncClient; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManager; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.AsyncClientEndpoint; import org.apache.hc.core5.ssl.SSLContexts; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestHttpAsyncMinimalTlsHandshake extends AbstractIntegrationTestBase { public TestHttpAsyncMinimalTlsHandshake() { super(URIScheme.HTTPS, ClientProtocolLevel.MINIMAL, ServerProtocolLevel.STANDARD); } @Test void testSuccessfulTlsHandshake() throws Exception { final HttpHost target = startServer(); final int maxConnNo = 2; final PoolingAsyncClientConnectionManager connectionManager = startClient().getConnectionManager(); connectionManager.setDefaultMaxPerRoute(maxConnNo); connectionManager.setMaxTotal(maxConnNo); final MinimalHttpAsyncClient client = startClient().getImplementation(); for (int i = 0; i < maxConnNo + 1; i++) { final Future endpointLease = client.lease(target, null); final AsyncClientEndpoint endpoint = endpointLease.get(5, TimeUnit.SECONDS); endpoint.releaseAndDiscard(); } } @Test void testTlsHandshakeFailure() throws Exception { final HttpHost target = startServer(); configureClient(builder -> builder.setTlsStrategy(new DefaultClientTlsStrategy(SSLContexts.createDefault()))); final int maxConnNo = 2; final PoolingAsyncClientConnectionManager connectionManager = startClient().getConnectionManager(); connectionManager.setDefaultMaxPerRoute(maxConnNo); connectionManager.setMaxTotal(maxConnNo); final MinimalHttpAsyncClient client = startClient().getImplementation(); for (int i = 0; i < maxConnNo + 1; i++) { final Future endpointLease = client.lease(target, null); final ExecutionException executionException = Assertions.assertThrows(ExecutionException.class, () -> endpointLease.get(5, TimeUnit.SECONDS)); Assertions.assertInstanceOf(SSLException.class, executionException.getCause()); } } }././@LongLink0100644 0000000 0000000 00000000147 15063503632 011640 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttp1RequestReExecution.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttp1RequestReExecution.ja0100664 0000000 0000000 00000011255 15063503632 032662 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import static org.hamcrest.MatcherAssert.assertThat; import java.util.concurrent.Future; import java.util.concurrent.atomic.AtomicInteger; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.impl.DefaultHttpRequestRetryStrategy; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.util.TimeValue; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; abstract class TestHttp1RequestReExecution extends AbstractIntegrationTestBase { public TestHttp1RequestReExecution(final URIScheme scheme) { super(scheme, ClientProtocolLevel.STANDARD, ServerProtocolLevel.STANDARD); } @BeforeEach void setup() { final Resolver serviceAvailabilityResolver = new Resolver() { private final AtomicInteger count = new AtomicInteger(0); @Override public TimeValue resolve(final HttpRequest request) { final int n = count.incrementAndGet(); return n <= 3 ? TimeValue.ofSeconds(1) : null; } }; configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(handler -> new ServiceUnavailableAsyncDecorator(handler, serviceAvailabilityResolver))); } @Test void testGiveUpAfterOneRetry() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); configureClient(builder -> builder .setRetryStrategy(new DefaultHttpRequestRetryStrategy(1, TimeValue.ofSeconds(1)))); final TestAsyncClient client = startClient(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(), null); final SimpleHttpResponse response = future.get(); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getCode(), CoreMatchers.equalTo(HttpStatus.SC_SERVICE_UNAVAILABLE)); } @Test void testDoNotGiveUpEasily() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); configureClient(builder -> builder .setRetryStrategy(new DefaultHttpRequestRetryStrategy(5, TimeValue.ofSeconds(1)))); final TestAsyncClient client = startClient(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(), null); final SimpleHttpResponse response = future.get(); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getCode(), CoreMatchers.equalTo(HttpStatus.SC_OK)); } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestH2ReactiveMinimal.java0100664 0000000 0000000 00000003200 15005672016 031716 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.URIScheme; abstract class TestH2ReactiveMinimal extends AbstractHttpReactiveFundamentalsTest { public TestH2ReactiveMinimal(final URIScheme scheme) { super(scheme, ClientProtocolLevel.MINIMAL_H2_ONLY, ServerProtocolLevel.H2_ONLY); } } ././@LongLink0100644 0000000 0000000 00000000160 15061532332 011630 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttp1AsyncStatefulConnManagement.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttp1AsyncStatefulConnMana0100664 0000000 0000000 00000024663 15061532332 032672 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EndpointDetails; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpCoreContext; import org.apache.hc.core5.net.URIAuthority; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestHttp1AsyncStatefulConnManagement extends AbstractIntegrationTestBase { public TestHttp1AsyncStatefulConnManagement() { super(URIScheme.HTTP, ClientProtocolLevel.STANDARD, ServerProtocolLevel.STANDARD); } @Test void testStatefulConnections() throws Exception { configureServer(bootstrap -> bootstrap.register("*", () -> new AbstractSimpleServerExchangeHandler() { @Override protected SimpleHttpResponse handle( final SimpleHttpRequest request, final HttpCoreContext context) { final SimpleHttpResponse response = new SimpleHttpResponse(HttpStatus.SC_OK); response.setBody("Whatever", ContentType.TEXT_PLAIN); return response; } })); final HttpHost target = startServer(); configureClient(builder -> builder .setUserTokenHandler((route, context) -> context.getAttribute("user"))); final TestAsyncClient client = startClient(); final int workerCount = 2; final int requestCount = 5; final HttpContext[] contexts = new HttpContext[workerCount]; final HttpWorker[] workers = new HttpWorker[workerCount]; for (int i = 0; i < contexts.length; i++) { final HttpClientContext context = HttpClientContext.create(); contexts[i] = context; workers[i] = new HttpWorker( "user" + i, context, requestCount, target, client); } for (final HttpWorker worker : workers) { worker.start(); } for (final HttpWorker worker : workers) { worker.join(TIMEOUT.toMilliseconds()); } for (final HttpWorker worker : workers) { final Exception ex = worker.getException(); if (ex != null) { throw ex; } Assertions.assertEquals(requestCount, worker.getCount()); } for (final HttpContext context : contexts) { final String state0 = (String) context.getAttribute("r0"); Assertions.assertNotNull(state0); for (int r = 1; r < requestCount; r++) { Assertions.assertEquals(state0, context.getAttribute("r" + r)); } } } static class HttpWorker extends Thread { private final String uid; private final HttpClientContext context; private final int requestCount; private final HttpHost target; private final CloseableHttpAsyncClient httpclient; private volatile Exception exception; private volatile int count; public HttpWorker( final String uid, final HttpClientContext context, final int requestCount, final HttpHost target, final CloseableHttpAsyncClient httpclient) { super(); this.uid = uid; this.context = context; this.requestCount = requestCount; this.target = target; this.httpclient = httpclient; this.count = 0; } public int getCount() { return count; } public Exception getException() { return exception; } @Override public void run() { try { context.setAttribute("user", uid); for (int r = 0; r < requestCount; r++) { final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); final Future future = httpclient.execute(request, null); future.get(); count++; final EndpointDetails endpointDetails = context.getEndpointDetails(); final String connuid = Integer.toHexString(System.identityHashCode(endpointDetails)); context.setAttribute("r" + r, connuid); } } catch (final Exception ex) { exception = ex; } } } @Test void testRouteSpecificPoolRecylcing() throws Exception { configureServer(bootstrap -> bootstrap.register("*", () -> new AbstractSimpleServerExchangeHandler() { @Override protected SimpleHttpResponse handle( final SimpleHttpRequest request, final HttpCoreContext context) { final SimpleHttpResponse response = new SimpleHttpResponse(HttpStatus.SC_OK); response.setBody("Whatever", ContentType.TEXT_PLAIN); return response; } })); final HttpHost target = startServer(); // This tests what happens when a maxed connection pool needs // to kill the last idle connection to a route to build a new // one to the same route. configureClient(builder -> builder .setUserTokenHandler((route, context) -> context.getAttribute("user"))); final TestAsyncClient client = startClient(); final PoolingAsyncClientConnectionManager connManager = client.getConnectionManager(); final int maxConn = 2; // We build a client with 2 max active // connections, and 2 max per route. connManager.setMaxTotal(maxConn); connManager.setDefaultMaxPerRoute(maxConn); // Bottom of the pool : a *keep alive* connection to Route 1. final HttpContext context1 = HttpClientContext.create(); context1.setAttribute("user", "stuff"); final SimpleHttpRequest request1 = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); final Future future1 = client.execute(request1, context1, null); final HttpResponse response1 = future1.get(); Assertions.assertNotNull(response1); Assertions.assertEquals(200, response1.getCode()); // The ConnPoolByRoute now has 1 free connection, out of 2 max // The ConnPoolByRoute has one RouteSpcfcPool, that has one free connection // for [localhost][stuff] Thread.sleep(100); // Send a very simple HTTP get (it MUST be simple, no auth, no proxy, no 302, no 401, ...) // Send it to another route. Must be a keepalive. final HttpContext context2 = HttpClientContext.create(); final SimpleHttpRequest request2 = SimpleRequestBuilder.get() .setScheme(target.getSchemeName()) .setAuthority(new URIAuthority("127.0.0.1", target.getPort())) .setPath("/") .build(); final Future future2 = client.execute(request2, context2, null); final HttpResponse response2 = future2.get(); Assertions.assertNotNull(response2); Assertions.assertEquals(200, response2.getCode()); // ConnPoolByRoute now has 2 free connexions, out of its 2 max. // The [localhost][stuff] RouteSpcfcPool is the same as earlier // And there is a [127.0.0.1][null] pool with 1 free connection Thread.sleep(100); // This will put the ConnPoolByRoute to the targeted state : // [localhost][stuff] will not get reused because this call is [localhost][null] // So the ConnPoolByRoute will need to kill one connection (it is maxed out globally). // The killed conn is the oldest, which means the first HTTPGet ([localhost][stuff]). // When this happens, the RouteSpecificPool becomes empty. final HttpContext context3 = HttpClientContext.create(); final SimpleHttpRequest request3 = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); final Future future3 = client.execute(request3, context3, null); final HttpResponse response3 = future3.get(); Assertions.assertNotNull(response3); Assertions.assertEquals(200, response3.getCode()); } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/HttpIntegrationTests.java0100664 0000000 0000000 00000013351 15005672016 031771 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.URIScheme; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Nested; class HttpIntegrationTests { @Nested @DisplayName("Fundamentals (HTTP/1.1)") class Http1 extends TestHttp1Async { public Http1() { super(URIScheme.HTTP); } } @Nested @DisplayName("Fundamentals (HTTP/1.1, TLS)") class Http1Tls extends TestHttp1Async { public Http1Tls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("Fundamentals (HTTP/2)") class H2 extends TestH2Async { public H2() { super(URIScheme.HTTP); } } @Nested @DisplayName("Fundamentals (HTTP/2, TLS)") class H2Tls extends TestH2Async { public H2Tls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("Request re-execution (HTTP/1.1)") class Http1RequestReExecution extends TestHttp1RequestReExecution { public Http1RequestReExecution() { super(URIScheme.HTTP); } } @Nested @DisplayName("Request re-execution (HTTP/1.1, TLS)") class Http1RequestReExecutionTls extends TestHttp1RequestReExecution { public Http1RequestReExecutionTls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("HTTP protocol policy (HTTP/1.1)") class Http1ProtocolPolicy extends TestHttpAsyncProtocolPolicy { public Http1ProtocolPolicy() { super(URIScheme.HTTP, HttpVersion.HTTP_1_1); } } @Nested @DisplayName("HTTP protocol policy (HTTP/1.1, TLS)") class Http1ProtocolPolicyTls extends TestHttpAsyncProtocolPolicy { public Http1ProtocolPolicyTls() { super(URIScheme.HTTPS, HttpVersion.HTTP_1_1); } } @Nested @DisplayName("HTTP protocol policy (HTTP/2)") class H2ProtocolPolicy extends TestHttpAsyncProtocolPolicy { public H2ProtocolPolicy() { super(URIScheme.HTTP, HttpVersion.HTTP_2); } } @Nested @DisplayName("HTTP protocol policy (HTTP/2, TLS)") class H2ProtocolPolicyTls extends TestHttpAsyncProtocolPolicy { public H2ProtocolPolicyTls() { super(URIScheme.HTTPS, HttpVersion.HTTP_2); } } @Nested @DisplayName("Redirects (HTTP/1.1)") class RedirectsHttp1 extends TestHttp1AsyncRedirects { public RedirectsHttp1() { super(URIScheme.HTTP); } } @Nested @DisplayName("Redirects (HTTP/1.1, TLS)") class RedirectsHttp1Tls extends TestHttp1AsyncRedirects { public RedirectsHttp1Tls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("Redirects (HTTP/2)") class RedirectsH2 extends TestH2AsyncRedirect { public RedirectsH2() { super(URIScheme.HTTP); } } @Nested @DisplayName("Redirects (HTTP/2, TLS)") class RedirectsH2Tls extends TestH2AsyncRedirect { public RedirectsH2Tls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("Client authentication (HTTP/1.1)") class AuthenticationHttp1 extends TestHttp1ClientAuthentication { public AuthenticationHttp1() throws Exception { super(URIScheme.HTTP); } } @Nested @DisplayName("Client authentication (HTTP/1.1, TLS)") class AuthenticationHttp1Tls extends TestHttp1ClientAuthentication { public AuthenticationHttp1Tls() throws Exception { super(URIScheme.HTTPS); } } @Nested @DisplayName("Client authentication (HTTP/2)") class AuthenticationH2 extends TestH2ClientAuthentication { public AuthenticationH2() throws Exception { super(URIScheme.HTTP); } } @Nested @DisplayName("Client authentication (HTTP/2, TLS)") class AuthenticationH2Tls extends TestH2ClientAuthentication { public AuthenticationH2Tls() throws Exception { super(URIScheme.HTTPS); } } @Nested @DisplayName("HTTP message multiplexing (HTTP/2)") class RequestMultiplexing extends TestHttpAsyncRequestMultiplexing { public RequestMultiplexing() { super(URIScheme.HTTP); } } @Nested @DisplayName("HTTP message multiplexing (HTTP/2, TLS)") class RequestMultiplexingTls extends TestHttpAsyncRequestMultiplexing { public RequestMultiplexingTls() { super(URIScheme.HTTPS); } } }httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestClassicOverAsync.java0100664 0000000 0000000 00000023076 15005672016 031703 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.io.IOException; import java.util.Queue; import java.util.Random; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.CountDownLatch; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.testing.Result; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.ValueSource; public abstract class TestClassicOverAsync extends AbstractClassicOverAsyncIntegrationTestBase { public TestClassicOverAsync(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel, final ServerProtocolLevel serverProtocolLevel) { super(scheme, clientProtocolLevel, serverProtocolLevel); } @ValueSource(ints = {0, 2048, 10240}) @ParameterizedTest(name = "{displayName}; content length: {0}") void testSequentialGetRequests(final int contentSize) throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); final CloseableHttpClient client = startClient(); final int n = 10; for (int i = 0; i < n; i++) { client.execute( ClassicRequestBuilder.get() .setHttpHost(target) .setPath("/random/" + contentSize) .build(), response -> { Assertions.assertEquals(200, response.getCode()); final byte[] bytes = EntityUtils.toByteArray(response.getEntity()); Assertions.assertNotNull(bytes); Assertions.assertEquals(contentSize, bytes.length); return null; }); } } @ValueSource(ints = {0, 2048, 10240}) @ParameterizedTest(name = "{displayName}; content length: {0}") void testConcurrentGetRequests(final int contentSize) throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); final CloseableHttpClient client = startClient(); final int n = 10; final ExecutorService executorService = Executors.newFixedThreadPool(n); final CountDownLatch countDownLatch = new CountDownLatch(n); final Queue>> resultQueue = new ConcurrentLinkedQueue<>(); for (int i = 0; i < n; i++) { resultQueue.add(executorService.submit(() -> { final ClassicHttpRequest request = ClassicRequestBuilder.get() .setHttpHost(target) .setPath("/random/" + contentSize) .build(); try { return client.execute( request, response -> { final byte[] bytes = EntityUtils.toByteArray(response.getEntity()); countDownLatch.countDown(); return new Result<>(request, response, bytes); }); } catch (final RuntimeException | IOException ex) { countDownLatch.countDown(); return new Result<>(request, ex); } })); } Assertions.assertTrue(countDownLatch.await(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit())); Assertions.assertEquals(n, resultQueue.size()); for (final Future> future : resultQueue) { final Result result = future.get(); Assertions.assertNotNull(result.response); Assertions.assertEquals(200, result.response.getCode()); Assertions.assertNotNull(result.content); Assertions.assertEquals(contentSize, result.content.length); } executorService.shutdownNow(); } @ValueSource(ints = {0, 2048, 10240}) @ParameterizedTest(name = "{displayName}; content length: {0}") void testSequentialPostRequests(final int contentSize) throws Exception { configureServer(bootstrap -> bootstrap.register("/echo/*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final CloseableHttpClient client = startClient(); final int n = 10; for (int i = 0; i < n; i++) { final byte[] temp = new byte[contentSize]; new Random(System.currentTimeMillis()).nextBytes(temp); client.execute( ClassicRequestBuilder.post() .setHttpHost(target) .setPath("/echo/") .setEntity(new ByteArrayEntity(temp, ContentType.DEFAULT_BINARY)) .build(), response -> { Assertions.assertEquals(200, response.getCode()); final byte[] bytes = EntityUtils.toByteArray(response.getEntity()); Assertions.assertNotNull(bytes); Assertions.assertArrayEquals(temp, bytes); return null; }); } } @ValueSource(ints = {0, 2048, 10240}) @ParameterizedTest(name = "{displayName}; content length: {0}") void testConcurrentPostRequests(final int contentSize) throws Exception { configureServer(bootstrap -> bootstrap.register("/echo/*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final CloseableHttpClient client = startClient(); final int n = 10; final ExecutorService executorService = Executors.newFixedThreadPool(n); final CountDownLatch countDownLatch = new CountDownLatch(n); final Queue>> resultQueue = new ConcurrentLinkedQueue<>(); for (int i = 0; i < n; i++) { final byte[] temp = new byte[contentSize]; new Random(System.currentTimeMillis()).nextBytes(temp); resultQueue.add(executorService.submit(() -> { final ClassicHttpRequest request = ClassicRequestBuilder.post() .setHttpHost(target) .setPath("/echo/") .setEntity(new ByteArrayEntity(temp, ContentType.DEFAULT_BINARY)) .build(); try { return client.execute( request, response -> { final byte[] bytes = EntityUtils.toByteArray(response.getEntity()); countDownLatch.countDown(); return new Result<>(request, response, bytes); }); } catch (final RuntimeException | IOException ex) { countDownLatch.countDown(); return new Result<>(request, ex); } })); } Assertions.assertTrue(countDownLatch.await(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit())); Assertions.assertEquals(n, resultQueue.size()); for (final Future> future : resultQueue) { final Result result = future.get(); if (result.exception != null) { Assertions.fail(result.exception); } Assertions.assertNotNull(result.response); Assertions.assertEquals(200, result.response.getCode()); Assertions.assertNotNull(result.content); Assertions.assertEquals(contentSize, result.content.length); } executorService.shutdownNow(); } }././@LongLink0100644 0000000 0000000 00000000147 15005672016 011637 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttpAsyncProtocolPolicy.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttpAsyncProtocolPolicy.ja0100664 0000000 0000000 00000007531 15005672016 032756 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import static org.hamcrest.MatcherAssert.assertThat; import java.util.concurrent.Future; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Test; abstract class TestHttpAsyncProtocolPolicy extends AbstractIntegrationTestBase { private final HttpVersion version; public TestHttpAsyncProtocolPolicy(final URIScheme scheme, final HttpVersion version) { super(scheme, ClientProtocolLevel.STANDARD, version == HttpVersion.HTTP_2 ? ServerProtocolLevel.H2_ONLY : ServerProtocolLevel.STANDARD); this.version = version; } @Test void testRequestContext() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); final AtomicReference versionRef = new AtomicReference<>(); configureClient(builder -> builder .setDefaultTlsConfig(TlsConfig.custom() .setVersionPolicy(version.greaterEquals(HttpVersion.HTTP_2) ? HttpVersionPolicy.FORCE_HTTP_2 : HttpVersionPolicy.FORCE_HTTP_1) .build()) .addRequestInterceptorFirst((request, entity, context) -> versionRef.set(context.getProtocolVersion()))); final TestAsyncClient client = startClient(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(), null); final SimpleHttpResponse response = future.get(); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getCode(), CoreMatchers.equalTo(200)); final String body = response.getBodyText(); assertThat(body, CoreMatchers.notNullValue()); assertThat(body.length(), CoreMatchers.equalTo(2048)); assertThat(versionRef.get(), CoreMatchers.equalTo(version)); } } ././@LongLink0100644 0000000 0000000 00000000152 15005672035 011634 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractHttpAsyncRedirectsTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractHttpAsyncRedirectsTest0100664 0000000 0000000 00000075677 15005672035 033035 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import static org.hamcrest.MatcherAssert.assertThat; import java.net.InetSocketAddress; import java.net.URI; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import org.apache.hc.client5.http.CircularRedirectException; import org.apache.hc.client5.http.RedirectException; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.cookie.BasicClientCookie; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectLocations; import org.apache.hc.client5.testing.OldPathRedirectResolver; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.client5.testing.extension.async.TestAsyncServer; import org.apache.hc.client5.testing.extension.async.TestAsyncServerBootstrap; import org.apache.hc.client5.testing.redirect.Redirect; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.protocol.HttpCoreContext; import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.util.TimeValue; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.ValueSource; abstract class AbstractHttpAsyncRedirectsTest extends AbstractIntegrationTestBase { public AbstractHttpAsyncRedirectsTest(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel, final ServerProtocolLevel serverProtocolLevel) { super(scheme, clientProtocolLevel, serverProtocolLevel); } @Test void testBasicRedirect300() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MULTIPLE_CHOICES)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_MULTIPLE_CHOICES, response.getCode()); Assertions.assertEquals("/oldlocation/", request.getRequestUri()); } @Test void testBasicRedirect301() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MOVED_PERMANENTLY)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/100") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/random/100", request.getRequestUri()); Assertions.assertEquals(target, new HttpHost(request.getScheme(), request.getAuthority())); } @Test void testBasicRedirect302() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MOVED_TEMPORARILY)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/123") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/random/123", request.getRequestUri()); Assertions.assertEquals(target, new HttpHost(request.getScheme(), request.getAuthority())); } @Test void testBasicRedirect302NoLocation() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, requestUri -> { final String path = requestUri.getPath(); if (path.startsWith("/oldlocation")) { return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, null); } return null; }))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/100") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_MOVED_TEMPORARILY, response.getCode()); Assertions.assertEquals("/oldlocation/100", request.getRequestUri()); Assertions.assertEquals(target, new HttpHost(request.getScheme(), request.getAuthority())); } @Test void testBasicRedirect303() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_SEE_OTHER)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/123") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/random/123", request.getRequestUri()); Assertions.assertEquals(target, new HttpHost(request.getScheme(), request.getAuthority())); } @Test void testBasicRedirect304() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .register("/oldlocation/*", () -> new AbstractSimpleServerExchangeHandler() { @Override protected SimpleHttpResponse handle(final SimpleHttpRequest request, final HttpCoreContext context) { return SimpleHttpResponse.create(HttpStatus.SC_NOT_MODIFIED, (String) null); } })); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, response.getCode()); Assertions.assertEquals("/oldlocation/", request.getRequestUri()); } @Test void testBasicRedirect305() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .register("/oldlocation/*", () -> new AbstractSimpleServerExchangeHandler() { @Override protected SimpleHttpResponse handle(final SimpleHttpRequest request, final HttpCoreContext context) { return SimpleHttpResponse.create(HttpStatus.SC_USE_PROXY, (String) null); } })); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_USE_PROXY, response.getCode()); Assertions.assertEquals("/oldlocation/", request.getRequestUri()); } @Test void testBasicRedirect307() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_TEMPORARY_REDIRECT)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/123") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/random/123", request.getRequestUri()); Assertions.assertEquals(target, new HttpHost(request.getScheme(), request.getAuthority())); } @Test void testMaxRedirectCheck() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/circular-oldlocation/", "/circular-oldlocation/", HttpStatus.SC_MOVED_TEMPORARILY)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final RequestConfig config = RequestConfig.custom() .setCircularRedirectsAllowed(true) .setMaxRedirects(5).build(); final ExecutionException exception = Assertions.assertThrows(ExecutionException.class, () -> { final Future future = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/circular-oldlocation/") .setRequestConfig(config) .build(), null); future.get(); }); assertThat(exception.getCause(), CoreMatchers.instanceOf(RedirectException.class)); } @Test void testCircularRedirect() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/circular-oldlocation/", "/circular-oldlocation/", HttpStatus.SC_MOVED_TEMPORARILY)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final RequestConfig config = RequestConfig.custom() .setCircularRedirectsAllowed(false) .build(); final ExecutionException exception = Assertions.assertThrows(ExecutionException.class, () -> { final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/circular-oldlocation/") .setRequestConfig(config) .build(), null); future.get(); }); assertThat(exception.getCause(), CoreMatchers.instanceOf(CircularRedirectException.class)); } @Test void testPostRedirect() throws Exception { configureServer(bootstrap -> bootstrap .register("/echo/*", AsyncEchoHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/oldlocation", "/echo", HttpStatus.SC_TEMPORARY_REDIRECT)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.post() .setHttpHost(target) .setPath("/oldlocation/stuff") .setBody("stuff", ContentType.TEXT_PLAIN) .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/echo/stuff", request.getRequestUri()); Assertions.assertEquals("POST", request.getMethod()); } @Test void testPostRedirectSeeOther() throws Exception { configureServer(bootstrap -> bootstrap .register("/echo/*", AsyncEchoHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/oldlocation", "/echo", HttpStatus.SC_SEE_OTHER)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.post() .setHttpHost(target) .setPath("/oldlocation/stuff") .setBody("stuff", ContentType.TEXT_PLAIN) .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/echo/stuff", request.getRequestUri()); Assertions.assertEquals("GET", request.getMethod()); } @Test void testRelativeRedirect() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, requestUri -> { final String path = requestUri.getPath(); if (path.startsWith("/oldlocation")) { return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, "/random/100"); } return null; }))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/stuff") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/random/100", request.getRequestUri()); Assertions.assertEquals(target, new HttpHost(request.getScheme(), request.getAuthority())); } @Test void testRelativeRedirect2() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, requestUri -> { final String path = requestUri.getPath(); if (path.equals("/random/oldlocation")) { return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, "100"); } return null; }))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/oldlocation") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/random/100", request.getRequestUri()); Assertions.assertEquals(target, new HttpHost(request.getScheme(), request.getAuthority())); } @Test void testRejectBogusRedirectLocation() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, requestUri -> { final String path = requestUri.getPath(); if (path.equals("/oldlocation/")) { return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, "xxx://bogus"); } return null; }))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final ExecutionException exception = Assertions.assertThrows(ExecutionException.class, () -> { final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/") .build(), null); future.get(); }); assertThat(exception.getCause(), CoreMatchers.instanceOf(HttpException.class)); } @Test void testRejectInvalidRedirectLocation() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, requestUri -> { final String path = requestUri.getPath(); if (path.equals("/oldlocation/")) { return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, "/newlocation/?p=I have spaces"); } return null; }))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final ExecutionException exception = Assertions.assertThrows(ExecutionException.class, () -> { final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/") .build(), null); future.get(); }); assertThat(exception.getCause(), CoreMatchers.instanceOf(ProtocolException.class)); } @Test void testRedirectWithCookie() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MOVED_TEMPORARILY)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final CookieStore cookieStore = new BasicCookieStore(); final HttpClientContext context = HttpClientContext.create(); context.setCookieStore(cookieStore); final BasicClientCookie cookie = new BasicClientCookie("name", "value"); cookie.setDomain(target.getHostName()); cookie.setPath("/"); cookieStore.addCookie(cookie); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/100") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/random/100", request.getRequestUri()); final Header[] headers = request.getHeaders("Cookie"); Assertions.assertEquals(1, headers.length, "There can only be one (cookie)"); } @Test void testCrossSiteRedirect() throws Exception { final URIScheme scheme = scheme(); final TestAsyncServer secondServer = new TestAsyncServerBootstrap(scheme(), getServerProtocolLevel()) .register("/random/*", AsyncRandomHandler::new) .build(); try { final InetSocketAddress address2 = secondServer.start(); final HttpHost redirectTarget = new HttpHost(scheme.name(), "localhost", address2.getPort()); configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, requestUri -> { final String path = requestUri.getPath(); if (path.equals("/oldlocation")) { final URI location = new URIBuilder(requestUri) .setHttpHost(redirectTarget) .setPath("/random/100") .build(); return new Redirect(HttpStatus.SC_MOVED_PERMANENTLY, location.toString()); } return null; }))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/random/100", request.getRequestUri()); Assertions.assertEquals(redirectTarget, new HttpHost(request.getScheme(), request.getAuthority())); } finally { secondServer.shutdown(TimeValue.ofSeconds(5)); } } @ParameterizedTest(name = "{displayName}; manually added header: {0}") @ValueSource(strings = {HttpHeaders.AUTHORIZATION, HttpHeaders.COOKIE}) void testCrossSiteRedirectWithSensitiveHeaders(final String headerName) throws Exception { final URIScheme scheme = scheme(); final TestAsyncServer secondServer = new TestAsyncServerBootstrap(scheme(), getServerProtocolLevel()) .register("/random/*", AsyncRandomHandler::new) .build(); try { final InetSocketAddress address2 = secondServer.start(); final HttpHost redirectTarget = new HttpHost(scheme.name(), "localhost", address2.getPort()); configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, requestUri -> { final String path = requestUri.getPath(); if (path.equals("/oldlocation")) { final URI location = new URIBuilder(requestUri) .setHttpHost(redirectTarget) .setPath("/random/100") .build(); return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, location.toString()); } return null; }))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation") .setHeader(headerName, "custom header") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_MOVED_TEMPORARILY, response.getCode()); final RedirectLocations redirects = context.getRedirectLocations(); Assertions.assertNotNull(redirects); Assertions.assertEquals(0, redirects.size()); } finally { secondServer.shutdown(TimeValue.ofSeconds(5)); } } } ././@LongLink0100644 0000000 0000000 00000000145 15005672016 011635 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestClassicOverAsyncHttp1.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestClassicOverAsyncHttp1.java0100664 0000000 0000000 00000007232 15005672016 032620 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.util.Random; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.ValueSource; public abstract class TestClassicOverAsyncHttp1 extends TestClassicOverAsync { public TestClassicOverAsyncHttp1(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel, final ServerProtocolLevel serverProtocolLevel) { super(scheme, clientProtocolLevel, serverProtocolLevel); } @ValueSource(ints = {0, 2048, 10240}) @ParameterizedTest(name = "{displayName}; content length: {0}") void testSequentialPostRequestsNoKeepAlive(final int contentSize) throws Exception { configureServer(bootstrap -> bootstrap.register("/echo/*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final CloseableHttpClient client = startClient(); final int n = 10; for (int i = 0; i < n; i++) { final byte[] temp = new byte[contentSize]; new Random(System.currentTimeMillis()).nextBytes(temp); client.execute( ClassicRequestBuilder.post() .setHttpHost(target) .setPath("/echo/") .addHeader(HttpHeaders.CONNECTION, "Close") .setEntity(new ByteArrayEntity(temp, ContentType.DEFAULT_BINARY)) .build(), response -> { Assertions.assertEquals(200, response.getCode()); final byte[] bytes = EntityUtils.toByteArray(response.getEntity()); Assertions.assertNotNull(bytes); Assertions.assertArrayEquals(temp, bytes); return null; }); } } }././@LongLink0100644 0000000 0000000 00000000155 15063503632 011637 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractHttpAsyncFundamentalsTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractHttpAsyncFundamentalsT0100664 0000000 0000000 00000025252 15063503632 032776 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import static org.hamcrest.MatcherAssert.assertThat; import java.util.LinkedList; import java.util.Queue; import java.util.Random; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.CountDownLatch; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.atomic.AtomicInteger; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.Message; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.entity.AsyncEntityProducers; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityConsumer; import org.apache.hc.core5.http.nio.support.BasicRequestProducer; import org.apache.hc.core5.http.nio.support.BasicResponseConsumer; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Test; abstract class AbstractHttpAsyncFundamentalsTest extends AbstractIntegrationTestBase { protected AbstractHttpAsyncFundamentalsTest(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel, final ServerProtocolLevel serverProtocolLevel) { super(scheme, clientProtocolLevel, serverProtocolLevel); } @Test void testSequentialGetRequests() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); for (int i = 0; i < 3; i++) { final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(), null); final SimpleHttpResponse response = future.get(); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getCode(), CoreMatchers.equalTo(200)); final String body = response.getBodyText(); assertThat(body, CoreMatchers.notNullValue()); assertThat(body.length(), CoreMatchers.equalTo(2048)); } } @Test void testSequentialHeadRequests() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); for (int i = 0; i < 3; i++) { final Future future = client.execute( SimpleRequestBuilder.head() .setHttpHost(target) .setPath("/random/2048") .build(), null); final SimpleHttpResponse response = future.get(); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getCode(), CoreMatchers.equalTo(200)); final String body = response.getBodyText(); assertThat(body, CoreMatchers.nullValue()); } } @Test void testSequentialPostRequests() throws Exception { configureServer(bootstrap -> bootstrap.register("/echo/*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); for (int i = 0; i < 3; i++) { final byte[] b1 = new byte[1024]; final Random rnd = new Random(System.currentTimeMillis()); rnd.nextBytes(b1); final Future> future = client.execute( new BasicRequestProducer(Method.GET, target, "/echo/", AsyncEntityProducers.create(b1, ContentType.APPLICATION_OCTET_STREAM)), new BasicResponseConsumer<>(new BasicAsyncEntityConsumer()), HttpClientContext.create(), null); final Message responseMessage = future.get(); assertThat(responseMessage, CoreMatchers.notNullValue()); final HttpResponse response = responseMessage.getHead(); assertThat(response.getCode(), CoreMatchers.equalTo(200)); final byte[] b2 = responseMessage.getBody(); assertThat(b1, CoreMatchers.equalTo(b2)); } } @Test void testConcurrentPostRequests() throws Exception { configureServer(bootstrap -> bootstrap.register("/echo/*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final byte[] b1 = new byte[1024]; final Random rnd = new Random(System.currentTimeMillis()); rnd.nextBytes(b1); final int reqCount = 20; final Queue>> queue = new LinkedList<>(); for (int i = 0; i < reqCount; i++) { final Future> future = client.execute( new BasicRequestProducer(Method.POST, target, "/echo/", AsyncEntityProducers.create(b1, ContentType.APPLICATION_OCTET_STREAM)), new BasicResponseConsumer<>(new BasicAsyncEntityConsumer()), HttpClientContext.create(), null); queue.add(future); } while (!queue.isEmpty()) { final Future> future = queue.remove(); final Message responseMessage = future.get(); assertThat(responseMessage, CoreMatchers.notNullValue()); final HttpResponse response = responseMessage.getHead(); assertThat(response.getCode(), CoreMatchers.equalTo(200)); final byte[] b2 = responseMessage.getBody(); assertThat(b1, CoreMatchers.equalTo(b2)); } } @Test void testRequestExecutionFromCallback() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final int requestNum = 50; final AtomicInteger count = new AtomicInteger(requestNum); final Queue resultQueue = new ConcurrentLinkedQueue<>(); final CountDownLatch countDownLatch = new CountDownLatch(requestNum); final FutureCallback callback = new FutureCallback() { @Override public void completed(final SimpleHttpResponse result) { try { resultQueue.add(result); if (count.decrementAndGet() > 0) { client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(), this); } } finally { countDownLatch.countDown(); } } @Override public void failed(final Exception ex) { countDownLatch.countDown(); } @Override public void cancelled() { countDownLatch.countDown(); } }; final int threadNum = 5; final ExecutorService executorService = Executors.newFixedThreadPool(threadNum); for (int i = 0; i < threadNum; i++) { executorService.execute(() -> { if (!Thread.currentThread().isInterrupted()) { client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(), callback); } }); } assertThat(countDownLatch.await(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()), CoreMatchers.equalTo(true)); executorService.shutdownNow(); executorService.awaitTermination(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); for (;;) { final SimpleHttpResponse response = resultQueue.poll(); if (response == null) { break; } assertThat(response.getCode(), CoreMatchers.equalTo(200)); } } @Test void testBadRequest() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/boom") .build(), null); final SimpleHttpResponse response = future.get(); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getCode(), CoreMatchers.equalTo(400)); } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttp1AsyncMinimal.java0100664 0000000 0000000 00000010651 15005672016 031770 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import static org.hamcrest.MatcherAssert.assertThat; import java.util.LinkedList; import java.util.Queue; import java.util.Random; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import org.apache.hc.client5.http.impl.async.MinimalHttpAsyncClient; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.Message; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.AsyncClientEndpoint; import org.apache.hc.core5.http.nio.entity.AsyncEntityProducers; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityConsumer; import org.apache.hc.core5.http.nio.support.BasicRequestProducer; import org.apache.hc.core5.http.nio.support.BasicResponseConsumer; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Test; abstract class TestHttp1AsyncMinimal extends AbstractHttpAsyncFundamentalsTest { public TestHttp1AsyncMinimal(final URIScheme scheme) { super(scheme, ClientProtocolLevel.MINIMAL, ServerProtocolLevel.STANDARD); } @Test void testConcurrentPostRequestsSameEndpoint() throws Exception { configureServer(bootstrap -> bootstrap.register("/echo/*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final MinimalHttpAsyncClient client = startClient().getImplementation(); final byte[] b1 = new byte[1024]; final Random rnd = new Random(System.currentTimeMillis()); rnd.nextBytes(b1); final int reqCount = 20; final Future endpointLease = client.lease(target, null); final AsyncClientEndpoint endpoint = endpointLease.get(5, TimeUnit.SECONDS); try { final Queue>> queue = new LinkedList<>(); for (int i = 0; i < reqCount; i++) { final Future> future = endpoint.execute( new BasicRequestProducer(Method.GET, target, "/echo/", AsyncEntityProducers.create(b1, ContentType.APPLICATION_OCTET_STREAM)), new BasicResponseConsumer<>(new BasicAsyncEntityConsumer()), HttpClientContext.create(), null); queue.add(future); } while (!queue.isEmpty()) { final Future> future = queue.remove(); final Message responseMessage = future.get(); assertThat(responseMessage, CoreMatchers.notNullValue()); final HttpResponse response = responseMessage.getHead(); assertThat(response.getCode(), CoreMatchers.equalTo(200)); final byte[] b2 = responseMessage.getBody(); assertThat(b1, CoreMatchers.equalTo(b2)); endpoint.releaseAndReuse(); } } finally { endpoint.releaseAndDiscard(); } } }././@LongLink0100644 0000000 0000000 00000000153 14704162040 011630 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/ReactiveMinimalIntegrationTests.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/ReactiveMinimalIntegrationTest0100664 0000000 0000000 00000004135 14704162040 033014 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.core5.http.URIScheme; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Nested; class ReactiveMinimalIntegrationTests { @Nested @DisplayName("Fundamentals (HTTP/1.1)") class Http1 extends TestHttp1ReactiveMinimal { public Http1() { super(URIScheme.HTTP); } } @Nested @DisplayName("Fundamentals (HTTP/1.1, TLS)") class Http1Tls extends TestHttp1ReactiveMinimal { public Http1Tls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("Fundamentals (HTTP/2)") class H2 extends TestH2ReactiveMinimal { public H2() { super(URIScheme.HTTP); } } @Nested @DisplayName("Fundamentals (HTTP/2, TLS)") class H2Tls extends TestH2ReactiveMinimal { public H2Tls() { super(URIScheme.HTTPS); } } }././@LongLink0100644 0000000 0000000 00000000160 15005672016 011632 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractHttpReactiveFundamentalsTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractHttpReactiveFundamenta0100664 0000000 0000000 00000037043 15005672016 033000 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import static java.util.concurrent.TimeUnit.MILLISECONDS; import static org.hamcrest.MatcherAssert.assertThat; import java.io.ByteArrayOutputStream; import java.nio.ByteBuffer; import java.nio.channels.Channels; import java.nio.channels.WritableByteChannel; import java.nio.charset.StandardCharsets; import java.util.LinkedHashMap; import java.util.List; import java.util.Map; import java.util.Queue; import java.util.Random; import java.util.concurrent.ArrayBlockingQueue; import java.util.concurrent.BlockingQueue; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.CountDownLatch; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicReference; import io.reactivex.rxjava3.core.Flowable; import io.reactivex.rxjava3.schedulers.Schedulers; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.Message; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.support.AsyncRequestBuilder; import org.apache.hc.core5.reactive.ReactiveEntityProducer; import org.apache.hc.core5.reactive.ReactiveResponseConsumer; import org.apache.hc.core5.reactive.ReactiveServerExchangeHandler; import org.apache.hc.core5.testing.reactive.Reactive3TestUtils; import org.apache.hc.core5.testing.reactive.Reactive3TestUtils.StreamDescription; import org.apache.hc.core5.testing.reactive.ReactiveEchoProcessor; import org.apache.hc.core5.testing.reactive.ReactiveRandomProcessor; import org.apache.hc.core5.util.TextUtils; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Timeout; import org.reactivestreams.Publisher; abstract class AbstractHttpReactiveFundamentalsTest extends AbstractIntegrationTestBase { public AbstractHttpReactiveFundamentalsTest(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel, final ServerProtocolLevel serverProtocolLevel) { super(scheme, clientProtocolLevel, serverProtocolLevel); } @Test @Timeout(value = 60_000, unit = MILLISECONDS) void testSequentialGetRequests() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", () -> new ReactiveServerExchangeHandler(new ReactiveRandomProcessor()))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); for (int i = 0; i < 3; i++) { final ReactiveResponseConsumer consumer = new ReactiveResponseConsumer(); client.execute(AsyncRequestBuilder.get(target + "/random/2048").build(), consumer, null); final Message> response = consumer.getResponseFuture().get(); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getHead().getCode(), CoreMatchers.equalTo(200)); final String body = publisherToString(response.getBody()); assertThat(body, CoreMatchers.notNullValue()); assertThat(body.length(), CoreMatchers.equalTo(2048)); } } @Test @Timeout(value = 2000, unit = MILLISECONDS) void testSequentialHeadRequests() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", () -> new ReactiveServerExchangeHandler(new ReactiveRandomProcessor()))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); for (int i = 0; i < 3; i++) { final ReactiveResponseConsumer consumer = new ReactiveResponseConsumer(); client.execute(AsyncRequestBuilder.head(target + "/random/2048").build(), consumer, null); final Message> response = consumer.getResponseFuture().get(); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getHead().getCode(), CoreMatchers.equalTo(200)); final String body = publisherToString(response.getBody()); assertThat(body, CoreMatchers.nullValue()); } } @Test @Timeout(value = 60_000, unit = MILLISECONDS) void testSequentialPostRequests() throws Exception { configureServer(bootstrap -> bootstrap.register("/echo/*", () -> new ReactiveServerExchangeHandler(new ReactiveEchoProcessor()))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); for (int i = 0; i < 3; i++) { final byte[] b1 = new byte[1024]; final Random rnd = new Random(System.currentTimeMillis()); rnd.nextBytes(b1); final Flowable publisher = Flowable.just(ByteBuffer.wrap(b1)); final ReactiveResponseConsumer consumer = new ReactiveResponseConsumer(); final AsyncRequestProducer request = AsyncRequestBuilder.post(target + "/echo/") .setEntity(new ReactiveEntityProducer(publisher, -1, ContentType.APPLICATION_OCTET_STREAM, null)) .build(); client.execute(request, consumer, HttpClientContext.create(), null); final Future>> responseFuture = consumer.getResponseFuture(); final Message> responseMessage = responseFuture.get(); assertThat(responseMessage, CoreMatchers.notNullValue()); final HttpResponse response = responseMessage.getHead(); assertThat(response.getCode(), CoreMatchers.equalTo(200)); final byte[] b2 = publisherToByteArray(responseMessage.getBody()); assertThat(b1, CoreMatchers.equalTo(b2)); } } @Test @Timeout(value = 60_000, unit = MILLISECONDS) void testConcurrentPostRequests() throws Exception { configureServer(bootstrap -> bootstrap.register("/echo/*", () -> new ReactiveServerExchangeHandler(new ReactiveEchoProcessor()))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final int reqCount = 500; final int maxSize = 128 * 1024; final Map testCases = StreamingTestCase.generate(reqCount, maxSize); final BlockingQueue responses = new ArrayBlockingQueue<>(reqCount); for (final StreamingTestCase testCase : testCases.values()) { final ReactiveEntityProducer producer = new ReactiveEntityProducer(testCase.stream, testCase.length, ContentType.APPLICATION_OCTET_STREAM, null); final AsyncRequestProducer request = AsyncRequestBuilder.post(target + "/echo/") .setEntity(producer) .build(); final ReactiveResponseConsumer consumer = new ReactiveResponseConsumer(new FutureCallback>>() { @Override public void completed(final Message> result) { final Flowable flowable = Flowable.fromPublisher(result.getBody()) .observeOn(Schedulers.io()); // Stream the data on an RxJava scheduler, not a client thread Reactive3TestUtils.consumeStream(flowable).subscribe(responses::add); } @Override public void failed(final Exception ex) { } @Override public void cancelled() { } }); client.execute(request, consumer, HttpClientContext.create(), null); } for (int i = 0; i < reqCount; i++) { final StreamDescription streamDescription = responses.take(); final StreamingTestCase streamingTestCase = testCases.get(streamDescription.length); final long expectedLength = streamingTestCase.length; final long actualLength = streamDescription.length; Assertions.assertEquals(expectedLength, actualLength); final String expectedHash = streamingTestCase.expectedHash.get(); final String actualHash = TextUtils.toHexString(streamDescription.md.digest()); Assertions.assertEquals(expectedHash, actualHash); } } @Test @Timeout(value = 60_000, unit = MILLISECONDS) void testRequestExecutionFromCallback() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", () -> new ReactiveServerExchangeHandler(new ReactiveRandomProcessor()))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final int requestNum = 50; final AtomicInteger count = new AtomicInteger(requestNum); final Queue>> resultQueue = new ConcurrentLinkedQueue<>(); final CountDownLatch countDownLatch = new CountDownLatch(requestNum); final FutureCallback>> callback = new FutureCallback>>() { @Override public void completed(final Message> result) { try { resultQueue.add(result); if (count.decrementAndGet() > 0) { final ReactiveResponseConsumer consumer = new ReactiveResponseConsumer(this); client.execute(AsyncRequestBuilder.get(target + "/random/2048").build(), consumer, null); } } finally { countDownLatch.countDown(); } } @Override public void failed(final Exception ex) { countDownLatch.countDown(); } @Override public void cancelled() { countDownLatch.countDown(); } }; final int threadNum = 5; final ExecutorService executorService = Executors.newFixedThreadPool(threadNum); for (int i = 0; i < threadNum; i++) { executorService.execute(() -> { if (!Thread.currentThread().isInterrupted()) { final ReactiveResponseConsumer consumer = new ReactiveResponseConsumer(callback); client.execute(AsyncRequestBuilder.get(target + "/random/2048").build(), consumer, null); } }); } assertThat(countDownLatch.await(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()), CoreMatchers.equalTo(true)); executorService.shutdownNow(); executorService.awaitTermination(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); for (;;) { final Message> response = resultQueue.poll(); if (response == null) { break; } assertThat(response.getHead().getCode(), CoreMatchers.equalTo(200)); } } @Test void testBadRequest() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", () -> new ReactiveServerExchangeHandler(new ReactiveRandomProcessor()))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final AsyncRequestProducer request = AsyncRequestBuilder.get(target + "/random/boom").build(); final ReactiveResponseConsumer consumer = new ReactiveResponseConsumer(); client.execute(request, consumer, null); final Future>> future = consumer.getResponseFuture(); final HttpResponse response = future.get().getHead(); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getCode(), CoreMatchers.equalTo(400)); } static String publisherToString(final Publisher publisher) throws Exception { final byte[] bytes = publisherToByteArray(publisher); if (bytes == null) { return null; } return new String(bytes, StandardCharsets.UTF_8); } static byte[] publisherToByteArray(final Publisher publisher) throws Exception { final ByteArrayOutputStream baos = new ByteArrayOutputStream(); try (WritableByteChannel channel = Channels.newChannel(baos)) { final List bufs = Flowable.fromPublisher(publisher) .toList() .blockingGet(); if (bufs.isEmpty()) { return null; } for (final ByteBuffer buf : bufs) { channel.write(buf); } } return baos.toByteArray(); } private static final class StreamingTestCase { final long length; final AtomicReference expectedHash; final Flowable stream; StreamingTestCase(final long length, final AtomicReference expectedHash, final Flowable stream) { this.length = length; this.expectedHash = expectedHash; this.stream = stream; } static Map generate(final int numTestCases, final int maxSize) { final Map testCases = new LinkedHashMap<>(); int testCaseNum = 0; while (testCases.size() < numTestCases) { final long seed = 198723L * testCaseNum++; final int length = 1 + new Random(seed).nextInt(maxSize); final AtomicReference expectedHash = new AtomicReference<>(); final Flowable stream = Reactive3TestUtils.produceStream(length, expectedHash); final StreamingTestCase streamingTestCase = new StreamingTestCase(length, expectedHash, stream); testCases.put((long) length, streamingTestCase); } return testCases; } } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttp1Async.java0100664 0000000 0000000 00000022001 15063503632 030452 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import static org.hamcrest.MatcherAssert.assertThat; import java.util.Random; import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManager; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.ValueSource; abstract class TestHttp1Async extends AbstractHttpAsyncFundamentalsTest { public TestHttp1Async(final URIScheme scheme) { super(scheme, ClientProtocolLevel.STANDARD, ServerProtocolLevel.STANDARD); } @ParameterizedTest(name = "{displayName}; concurrent connections: {0}") @ValueSource(ints = {5, 1, 20}) public void testSequentialGetRequestsCloseConnection(final int concurrentConns) throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final PoolingAsyncClientConnectionManager connManager = client.getConnectionManager(); connManager.setDefaultMaxPerRoute(concurrentConns); connManager.setMaxTotal(100); for (int i = 0; i < 3; i++) { final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .addHeader(HttpHeaders.CONNECTION, HeaderElements.CLOSE) .build(), null); final SimpleHttpResponse response = future.get(); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getCode(), CoreMatchers.equalTo(200)); final String body = response.getBodyText(); assertThat(body, CoreMatchers.notNullValue()); assertThat(body.length(), CoreMatchers.equalTo(2048)); } } @Test void testSharedPool() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final PoolingAsyncClientConnectionManager connManager = client.getConnectionManager(); final Future future1 = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(), null); final SimpleHttpResponse response1 = future1.get(); assertThat(response1, CoreMatchers.notNullValue()); assertThat(response1.getCode(), CoreMatchers.equalTo(200)); final String body1 = response1.getBodyText(); assertThat(body1, CoreMatchers.notNullValue()); assertThat(body1.length(), CoreMatchers.equalTo(2048)); try (final CloseableHttpAsyncClient httpclient2 = HttpAsyncClients.custom() .setConnectionManager(connManager) .setConnectionManagerShared(true) .build()) { httpclient2.start(); final Future future2 = httpclient2.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(), null); final SimpleHttpResponse response2 = future2.get(); assertThat(response2, CoreMatchers.notNullValue()); assertThat(response2.getCode(), CoreMatchers.equalTo(200)); final String body2 = response2.getBodyText(); assertThat(body2, CoreMatchers.notNullValue()); assertThat(body2.length(), CoreMatchers.equalTo(2048)); } final Future future3 = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(), null); final SimpleHttpResponse response3 = future3.get(); assertThat(response3, CoreMatchers.notNullValue()); assertThat(response3.getCode(), CoreMatchers.equalTo(200)); final String body3 = response3.getBodyText(); assertThat(body3, CoreMatchers.notNullValue()); assertThat(body3.length(), CoreMatchers.equalTo(2048)); } @Test void testRequestCancellation() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", AsyncRandomHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final PoolingAsyncClientConnectionManager connManager = client.getConnectionManager(); connManager.setDefaultMaxPerRoute(1); connManager.setMaxTotal(1); final ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor(); try { for (int i = 0; i < 20; i++) { final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/1000") .build(), null); executorService.schedule(() -> future.cancel(true), i % 5, TimeUnit.MILLISECONDS); try { future.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); } catch (final TimeoutException ex) { throw ex; } catch (final Exception ignore) { } } final Random rnd = new Random(); for (int i = 0; i < 20; i++) { final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/1000") .build(), null); executorService.schedule(() -> future.cancel(true), rnd.nextInt(200), TimeUnit.MILLISECONDS); try { future.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); } catch (final TimeoutException ex) { throw ex; } catch (final Exception ignore) { } } for (int i = 0; i < 5; i++) { final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/random/1000") .build(), null); final SimpleHttpResponse response = future.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); assertThat(response, CoreMatchers.notNullValue()); assertThat(response.getCode(), CoreMatchers.equalTo(200)); } } finally { executorService.shutdownNow(); } } }httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestH2AsyncMinimal.java0100664 0000000 0000000 00000003164 14706640335 031250 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.URIScheme; abstract class TestH2AsyncMinimal extends AbstractH2AsyncFundamentalsTest { public TestH2AsyncMinimal(final URIScheme scheme) { super(scheme, ClientProtocolLevel.MINIMAL_H2_ONLY, ServerProtocolLevel.H2_ONLY); } }httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestH2Reactive.java0100664 0000000 0000000 00000003152 15005672016 030415 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.URIScheme; abstract class TestH2Reactive extends AbstractHttpReactiveFundamentalsTest { public TestH2Reactive(final URIScheme scheme) { super(scheme, ClientProtocolLevel.H2_ONLY, ServerProtocolLevel.H2_ONLY); } } ././@LongLink0100644 0000000 0000000 00000000154 15005672016 011635 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/ClassicOverAsyncIntegrationTests.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/ClassicOverAsyncIntegrationTes0100664 0000000 0000000 00000005025 15005672016 032775 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.URIScheme; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Nested; class ClassicOverAsyncIntegrationTests { @Nested @DisplayName("Fundamentals") class Fundamentals extends TestClassicOverAsyncHttp1 { public Fundamentals() { super(URIScheme.HTTP, ClientProtocolLevel.STANDARD, ServerProtocolLevel.STANDARD); } } @Nested @DisplayName("Fundamentals (TLS)") class FundamentalsTls extends TestClassicOverAsyncHttp1 { public FundamentalsTls() { super(URIScheme.HTTPS, ClientProtocolLevel.STANDARD, ServerProtocolLevel.STANDARD); } } @Nested @DisplayName("Fundamentals (HTTP/2)") class FundamentalsH2 extends TestClassicOverAsync { public FundamentalsH2() { super(URIScheme.HTTP, ClientProtocolLevel.H2_ONLY, ServerProtocolLevel.H2_ONLY); } } @Nested @DisplayName("Fundamentals (HTTP/2, TLS)") class FundamentalsH2Tls extends TestClassicOverAsync { public FundamentalsH2Tls() { super(URIScheme.HTTPS, ClientProtocolLevel.H2_ONLY, ServerProtocolLevel.H2_ONLY); } } }httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/ReactiveIntegrationTests.java0100664 0000000 0000000 00000004072 14704162040 032610 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.core5.http.URIScheme; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Nested; class ReactiveIntegrationTests { @Nested @DisplayName("Fundamentals (HTTP/1.1)") class Http1 extends TestHttp1Reactive { public Http1() { super(URIScheme.HTTP); } } @Nested @DisplayName("Fundamentals (HTTP/1.1, TLS)") class Http1Tls extends TestHttp1Reactive { public Http1Tls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("Fundamentals (HTTP/2)") class H2 extends TestH2Reactive { public H2() { super(URIScheme.HTTP); } } @Nested @DisplayName("Fundamentals (HTTP/2, TLS)") class H2Tls extends TestH2Reactive { public H2Tls() { super(URIScheme.HTTPS); } } }httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestH2AsyncRedirect.java0100664 0000000 0000000 00000003155 15005672016 031415 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.URIScheme; abstract class TestH2AsyncRedirect extends AbstractHttpAsyncRedirectsTest { public TestH2AsyncRedirect(final URIScheme scheme) { super(scheme, ClientProtocolLevel.H2_ONLY, ServerProtocolLevel.H2_ONLY); } }././@LongLink0100644 0000000 0000000 00000000151 15005672016 011632 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttp1ClientAuthentication.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttp1ClientAuthentication.0100664 0000000 0000000 00000010436 15005672016 032661 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.BasicTestAuthenticator; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.mockito.Mockito; abstract class TestHttp1ClientAuthentication extends AbstractHttpAsyncClientAuthenticationTest { public TestHttp1ClientAuthentication(final URIScheme scheme) { super(scheme, ClientProtocolLevel.STANDARD, ServerProtocolLevel.STANDARD); } @Test void testBasicAuthenticationSuccessNonPersistentConnection() throws Exception { configureServer(bootstrap -> bootstrap .register("*", AsyncEchoHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new AuthenticatingAsyncDecorator(exchangeHandler, new BasicTestAuthenticator("test:test", "test realm")) { @Override protected void customizeUnauthorizedResponse(final HttpResponse unauthorized) { unauthorized.addHeader(HttpHeaders.CONNECTION, HeaderElements.CLOSE); } })); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credsProvider); final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); final Future future = client.execute(request, context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } }httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestH2Async.java0100664 0000000 0000000 00000003136 14732767163 027750 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.URIScheme; abstract class TestH2Async extends AbstractH2AsyncFundamentalsTest { public TestH2Async(final URIScheme scheme) { super(scheme, ClientProtocolLevel.H2_ONLY, ServerProtocolLevel.H2_ONLY); } }././@LongLink0100644 0000000 0000000 00000000146 15005672016 011636 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestH2ClientAuthentication.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestH2ClientAuthentication.jav0100664 0000000 0000000 00000003206 15005672016 032630 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.URIScheme; abstract class TestH2ClientAuthentication extends AbstractHttpAsyncClientAuthenticationTest { public TestH2ClientAuthentication(final URIScheme scheme) { super(scheme, ClientProtocolLevel.H2_ONLY, ServerProtocolLevel.H2_ONLY); } }././@LongLink0100644 0000000 0000000 00000000154 15005672016 011635 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttpAsyncRequestMultiplexing.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttpAsyncRequestMultiplexi0100664 0000000 0000000 00000010470 15005672016 033105 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import static org.hamcrest.MatcherAssert.assertThat; import java.util.LinkedList; import java.util.Queue; import java.util.Random; import java.util.concurrent.Future; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.Message; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.entity.AsyncEntityProducers; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityConsumer; import org.apache.hc.core5.http.nio.support.BasicRequestProducer; import org.apache.hc.core5.http.nio.support.BasicResponseConsumer; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Test; abstract class TestHttpAsyncRequestMultiplexing extends AbstractIntegrationTestBase { public TestHttpAsyncRequestMultiplexing(final URIScheme uriScheme) { super(uriScheme, ClientProtocolLevel.MINIMAL, ServerProtocolLevel.H2_ONLY); } @Test void testConcurrentPostRequests() throws Exception { configureServer(bootstrap -> bootstrap.register("/echo/*", AsyncEchoHandler::new)); configureClient(custimizer -> custimizer .setDefaultTlsConfig(TlsConfig.custom() .setVersionPolicy(HttpVersionPolicy.FORCE_HTTP_2) .build()) .useMessageMultiplexing() ); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final byte[] b1 = new byte[1024]; final Random rnd = new Random(System.currentTimeMillis()); rnd.nextBytes(b1); final int reqCount = 200; final Queue>> queue = new LinkedList<>(); for (int i = 0; i < reqCount; i++) { final Future> future = client.execute( new BasicRequestProducer(Method.POST, target, "/echo/", AsyncEntityProducers.create(b1, ContentType.APPLICATION_OCTET_STREAM)), new BasicResponseConsumer<>(new BasicAsyncEntityConsumer()), HttpClientContext.create(), null); queue.add(future); } while (!queue.isEmpty()) { final Future> future = queue.remove(); final Message responseMessage = future.get(); assertThat(responseMessage, CoreMatchers.notNullValue()); final HttpResponse response = responseMessage.getHead(); assertThat(response.getCode(), CoreMatchers.equalTo(200)); final byte[] b2 = responseMessage.getBody(); assertThat(b1, CoreMatchers.equalTo(b2)); } } }httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttp1AsyncRedirects.java0100664 0000000 0000000 00000015043 15005672016 032326 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.util.ArrayList; import java.util.List; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.OldPathRedirectResolver; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.client5.testing.redirect.Redirect; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.message.BasicHeader; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Redirection test cases. */ abstract class TestHttp1AsyncRedirects extends AbstractHttpAsyncRedirectsTest { public TestHttp1AsyncRedirects(final URIScheme scheme) { super(scheme, ClientProtocolLevel.STANDARD, ServerProtocolLevel.STANDARD); } @Test void testBasicRedirect300NoKeepAlive() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MULTIPLE_CHOICES, Redirect.ConnControl.CLOSE)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_MULTIPLE_CHOICES, response.getCode()); Assertions.assertEquals("/oldlocation/", request.getRequestUri()); } @Test void testBasicRedirect301NoKeepAlive() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MOVED_PERMANENTLY, Redirect.ConnControl.CLOSE)))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/100") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/random/100", request.getRequestUri()); Assertions.assertEquals(target, new HttpHost(request.getScheme(), request.getAuthority())); } @Test void testDefaultHeadersRedirect() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", AsyncRandomHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new RedirectingAsyncDecorator( exchangeHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MOVED_PERMANENTLY, Redirect.ConnControl.CLOSE)))); final HttpHost target = startServer(); final List
defaultHeaders = new ArrayList<>(1); defaultHeaders.add(new BasicHeader(HttpHeaders.USER_AGENT, "my-test-client")); configureClient(builder -> builder .setDefaultHeaders(defaultHeaders) ); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation/123") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); final HttpRequest request = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals("/random/123", request.getRequestUri()); final Header header = request.getFirstHeader(HttpHeaders.USER_AGENT); Assertions.assertEquals("my-test-client", header.getValue()); } } ././@LongLink0100644 0000000 0000000 00000000147 15063503632 011640 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractIntegrationTestBase.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractIntegrationTestBase.ja0100664 0000000 0000000 00000006763 15063503632 032710 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.net.InetSocketAddress; import java.util.function.Consumer; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.client5.testing.extension.async.TestAsyncClientBuilder; import org.apache.hc.client5.testing.extension.async.TestAsyncResources; import org.apache.hc.client5.testing.extension.async.TestAsyncServer; import org.apache.hc.client5.testing.extension.async.TestAsyncServerBootstrap; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.extension.RegisterExtension; abstract class AbstractIntegrationTestBase { public static final Timeout TIMEOUT = Timeout.ofMinutes(1); @RegisterExtension private final TestAsyncResources testResources; protected AbstractIntegrationTestBase(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel, final ServerProtocolLevel serverProtocolLevel) { this.testResources = new TestAsyncResources(scheme, clientProtocolLevel, serverProtocolLevel, TIMEOUT); } public URIScheme scheme() { return testResources.scheme(); } public ServerProtocolLevel getServerProtocolLevel() { return testResources.getServerProtocolLevel(); } public ClientProtocolLevel getClientProtocolLevel() { return testResources.getClientProtocolLevel(); } public void configureServer(final Consumer serverCustomizer) { testResources.configureServer(serverCustomizer); } public HttpHost startServer() throws Exception { final TestAsyncServer server = testResources.server(); final InetSocketAddress inetSocketAddress = server.start(); return new HttpHost(testResources.scheme().id, "localhost", inetSocketAddress.getPort()); } public void configureClient(final Consumer clientCustomizer) { testResources.configureClient(clientCustomizer); } public TestAsyncClient startClient() throws Exception { final TestAsyncClient client = testResources.client(); client.start(); return client; } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestHttp1ReactiveMinimal.java0100664 0000000 0000000 00000011170 15005672016 032452 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import static org.hamcrest.MatcherAssert.assertThat; import java.util.LinkedList; import java.util.Queue; import java.util.Random; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import org.apache.hc.client5.http.impl.async.MinimalHttpAsyncClient; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.Message; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.AsyncClientEndpoint; import org.apache.hc.core5.http.nio.entity.AsyncEntityProducers; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityConsumer; import org.apache.hc.core5.http.nio.support.BasicRequestProducer; import org.apache.hc.core5.http.nio.support.BasicResponseConsumer; import org.apache.hc.core5.reactive.ReactiveServerExchangeHandler; import org.apache.hc.core5.testing.reactive.ReactiveEchoProcessor; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Test; abstract class TestHttp1ReactiveMinimal extends AbstractHttpReactiveFundamentalsTest { public TestHttp1ReactiveMinimal(final URIScheme scheme) { super(scheme, ClientProtocolLevel.MINIMAL, ServerProtocolLevel.STANDARD); } @Test void testConcurrentPostRequestsSameEndpoint() throws Exception { configureServer(bootstrap -> bootstrap.register("/echo/*", () -> new ReactiveServerExchangeHandler(new ReactiveEchoProcessor()))); final HttpHost target = startServer(); final MinimalHttpAsyncClient client = startClient().getImplementation(); final byte[] b1 = new byte[1024]; final Random rnd = new Random(System.currentTimeMillis()); rnd.nextBytes(b1); final int reqCount = 20; final Future endpointLease = client.lease(target, null); final AsyncClientEndpoint endpoint = endpointLease.get(5, TimeUnit.SECONDS); try { final Queue>> queue = new LinkedList<>(); for (int i = 0; i < reqCount; i++) { final Future> future = endpoint.execute( new BasicRequestProducer(Method.GET, target, "/echo/", AsyncEntityProducers.create(b1, ContentType.APPLICATION_OCTET_STREAM)), new BasicResponseConsumer<>(new BasicAsyncEntityConsumer()), HttpClientContext.create(), null); queue.add(future); } while (!queue.isEmpty()) { final Future> future = queue.remove(); final Message responseMessage = future.get(); assertThat(responseMessage, CoreMatchers.notNullValue()); final HttpResponse response = responseMessage.getHead(); assertThat(response.getCode(), CoreMatchers.equalTo(200)); final byte[] b2 = responseMessage.getBody(); assertThat(b1, CoreMatchers.equalTo(b2)); endpoint.releaseAndReuse(); } } finally { endpoint.releaseAndDiscard(); } } } ././@LongLink0100644 0000000 0000000 00000000151 15063503637 011640 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestAsyncConnectionManagement.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/TestAsyncConnectionManagement.0100664 0000000 0000000 00000043246 15063503637 032727 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.impl.ConnectionHolder; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManager; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.nio.AsyncConnectionEndpoint; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.protocol.HttpCoreContext; import org.apache.hc.core5.pool.PoolConcurrencyPolicy; import org.apache.hc.core5.pool.PoolReusePolicy; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestAsyncConnectionManagement extends AbstractIntegrationTestBase { static final Timeout TIMEOUT = Timeout.ofSeconds(30); static final Timeout LEASE_TIMEOUT = Timeout.ofSeconds(5); public TestAsyncConnectionManagement() { super(URIScheme.HTTP, ClientProtocolLevel.STANDARD, ServerProtocolLevel.STANDARD); } @BeforeEach void setup() { configureServer(bootstrap -> bootstrap.register("*", () -> new AbstractSimpleServerExchangeHandler() { @Override protected SimpleHttpResponse handle( final SimpleHttpRequest request, final HttpCoreContext context) { final SimpleHttpResponse response = new SimpleHttpResponse(HttpStatus.SC_OK); response.setBody("Whatever", ContentType.TEXT_PLAIN); return response; } })); } /** * Tests releasing and re-using a connection after a response is read. */ @Test void testReleaseConnection() throws Exception { final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final PoolingAsyncClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(1); final HttpRoute route = new HttpRoute(target, null, false); final HttpClientContext context = HttpClientContext.create(); final Future endpointFuture1 = connManager.lease("id1", route, null, TIMEOUT, null); final AsyncConnectionEndpoint endpoint1 = endpointFuture1.get(LEASE_TIMEOUT.getDuration(), LEASE_TIMEOUT.getTimeUnit()); final Future connectFuture1 = connManager.connect(endpoint1, client.getImplementation(), TIMEOUT, null, context, null); final AsyncConnectionEndpoint openEndpoint1 = connectFuture1.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .addHeader(HttpHeaders.HOST, target.toHostString()) .build(); final Future responseFuture1 = openEndpoint1.execute("ex-1", SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), null); final SimpleHttpResponse response1 = responseFuture1.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response1.getCode()); // this should fail quickly, connection has not been released final Future endpointFuture2 = connManager.lease("id2", route, null, TIMEOUT, null); Assertions.assertThrows(TimeoutException.class, () -> endpointFuture2.get(10, TimeUnit.MILLISECONDS)); endpointFuture2.cancel(true); // close and release the connection // expect the next connection obtained to be closed openEndpoint1.close(); connManager.release(openEndpoint1, null, TimeValue.NEG_ONE_MILLISECOND); final Future endpointFuture3 = connManager.lease("id3", route, null, TIMEOUT, null); final AsyncConnectionEndpoint endpoint2 = endpointFuture3.get(LEASE_TIMEOUT.getDuration(), LEASE_TIMEOUT.getTimeUnit()); Assertions.assertFalse(endpoint2.isConnected()); final Future connectFuture2 = connManager.connect(endpoint2, client.getImplementation(), TIMEOUT, null, context, null); final AsyncConnectionEndpoint openEndpoint2 = connectFuture2.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); final Future responseFuture2 = openEndpoint2.execute("ex-2", SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), null); final SimpleHttpResponse response2 = responseFuture2.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode()); // release connection keeping it open // expect the next connection obtained to be open connManager.release(openEndpoint2, null, TimeValue.NEG_ONE_MILLISECOND); final Future endpointFuture4 = connManager.lease("id4", route, null, TIMEOUT, null); final AsyncConnectionEndpoint openEndpoint3 = endpointFuture4.get(LEASE_TIMEOUT.getDuration(), LEASE_TIMEOUT.getTimeUnit()); Assertions.assertTrue(openEndpoint3.isConnected()); final Future responseFuture3 = openEndpoint3.execute("ex-3", SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), null); final SimpleHttpResponse response3 = responseFuture3.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response3.getCode()); connManager.release(openEndpoint3, null, TimeValue.NEG_ONE_MILLISECOND); connManager.close(); } /** * Tests releasing with time limits. */ @Test void testReleaseConnectionWithTimeLimits() throws Exception { final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final PoolingAsyncClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(1); final HttpRoute route = new HttpRoute(target, null, false); final HttpClientContext context = HttpClientContext.create(); final Future endpointFuture1 = connManager.lease("id1", route, null, TIMEOUT, null); final AsyncConnectionEndpoint endpoint1 = endpointFuture1.get(LEASE_TIMEOUT.getDuration(), LEASE_TIMEOUT.getTimeUnit()); final Future connectFuture1 = connManager.connect(endpoint1, client.getImplementation(), TIMEOUT, null, context, null); final AsyncConnectionEndpoint openEndpoint1 = connectFuture1.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .addHeader(HttpHeaders.HOST, target.toHostString()) .build(); final Future responseFuture1 = openEndpoint1.execute("ex-1", SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), null); final SimpleHttpResponse response1 = responseFuture1.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response1.getCode()); final Future endpointFuture2 = connManager.lease("id2", route, null, TIMEOUT, null); Assertions.assertThrows(TimeoutException.class, () -> endpointFuture2.get(10, TimeUnit.MILLISECONDS)); endpointFuture2.cancel(true); openEndpoint1.close(); connManager.release(openEndpoint1, null, TimeValue.NEG_ONE_MILLISECOND); final Future endpointFuture3 = connManager.lease("id3", route, null, TIMEOUT, null); final AsyncConnectionEndpoint endpoint2 = endpointFuture3.get(LEASE_TIMEOUT.getDuration(), LEASE_TIMEOUT.getTimeUnit()); Assertions.assertFalse(endpoint2.isConnected()); final Future connectFuture2 = connManager.connect(endpoint2, client.getImplementation(), TIMEOUT, null, context, null); final AsyncConnectionEndpoint openEndpoint2 = connectFuture2.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); final Future responseFuture2 = openEndpoint2.execute("ex-2", SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), null); final SimpleHttpResponse response2 = responseFuture2.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode()); connManager.release(openEndpoint2, null, TimeValue.ofMilliseconds(100)); Thread.sleep(150); final Future endpointFuture4 = connManager.lease("id4", route, null, TIMEOUT, null); final AsyncConnectionEndpoint openEndpoint3 = endpointFuture4.get(LEASE_TIMEOUT.getDuration(), LEASE_TIMEOUT.getTimeUnit()); Assertions.assertFalse(openEndpoint3.isConnected()); connManager.release(openEndpoint3, null, TimeValue.ofMilliseconds(100)); connManager.close(); } @Test void testCloseExpiredIdleConnections() throws Exception { final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final PoolingAsyncClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(1); final HttpRoute route = new HttpRoute(target, null, false); final HttpClientContext context = HttpClientContext.create(); final Future endpointFuture1 = connManager.lease("id1", route, null, TIMEOUT, null); final AsyncConnectionEndpoint endpoint1 = endpointFuture1.get(LEASE_TIMEOUT.getDuration(), LEASE_TIMEOUT.getTimeUnit()); connManager.connect(endpoint1, client.getImplementation(), TIMEOUT, null, context, null) .get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(1, connManager.getTotalStats().getLeased()); Assertions.assertEquals(1, connManager.getStats(route).getLeased()); connManager.release(endpoint1, null, TimeValue.ofMilliseconds(100)); // Released, still active. Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(1, connManager.getStats(route).getAvailable()); connManager.closeExpired(); // Time has not expired yet. Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(1, connManager.getStats(route).getAvailable()); Thread.sleep(150); connManager.closeExpired(); // Time expired now, connections are destroyed. Assertions.assertEquals(0, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(0, connManager.getStats(route).getAvailable()); connManager.close(); } @Test void testCloseExpiredTTLConnections() throws Exception { final HttpHost target = startServer(); final PoolingAsyncClientConnectionManager connManager = PoolingAsyncClientConnectionManagerBuilder.create() .setPoolConcurrencyPolicy(PoolConcurrencyPolicy.STRICT) .setConnPoolPolicy(PoolReusePolicy.LIFO) .setDefaultConnectionConfig(ConnectionConfig.custom() .setTimeToLive(TimeValue.ofMilliseconds(100)) .build()) .build(); configureClient(builder -> builder.setConnectionManager(connManager)); final TestAsyncClient client = startClient(); connManager.setMaxTotal(1); final HttpRoute route = new HttpRoute(target, null, false); final HttpClientContext context = HttpClientContext.create(); final Future endpointFuture1 = connManager.lease("id1", route, null, TIMEOUT, null); final AsyncConnectionEndpoint endpoint1 = endpointFuture1.get(LEASE_TIMEOUT.getDuration(), LEASE_TIMEOUT.getTimeUnit()); connManager.connect(endpoint1, client.getImplementation(), TIMEOUT, null, context, null) .get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(1, connManager.getTotalStats().getLeased()); Assertions.assertEquals(1, connManager.getStats(route).getLeased()); // Release, let remain idle for forever connManager.release(endpoint1, null, TimeValue.NEG_ONE_MILLISECOND); // Released, still active. Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(1, connManager.getStats(route).getAvailable()); connManager.closeExpired(); // Time has not expired yet. Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(1, connManager.getStats(route).getAvailable()); Thread.sleep(150); connManager.closeExpired(); // TTL expired now, connections are destroyed. Assertions.assertEquals(0, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(0, connManager.getStats(route).getAvailable()); connManager.close(); } @Test void testConnectionTimeoutSetting() throws Exception { final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final Timeout connectionSocketTimeout = Timeout.ofMinutes(5); final PoolingAsyncClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(1); connManager.setDefaultConnectionConfig(ConnectionConfig.custom() .setSocketTimeout(connectionSocketTimeout) .build()); final HttpRoute route = new HttpRoute(target, null, false); final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .addHeader(HttpHeaders.HOST, target.toHostString()) .build(); final HttpClientContext context = HttpClientContext.create(); final Future endpointFuture1 = connManager.lease("id1", route, null, TIMEOUT, null); final AsyncConnectionEndpoint endpoint1 = endpointFuture1.get(LEASE_TIMEOUT.getDuration(), LEASE_TIMEOUT.getTimeUnit()); final Future connectFuture1 = connManager.connect(endpoint1, client.getImplementation(), TIMEOUT, null, context, null); final AsyncConnectionEndpoint openEndpoint1 = connectFuture1.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); // Modify socket timeout of the endpoint endpoint1.setSocketTimeout(Timeout.ofSeconds(30)); final Future responseFuture1 = openEndpoint1.execute("ex-1", SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), null); final SimpleHttpResponse response1 = responseFuture1.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response1.getCode()); connManager.release(endpoint1, null, TimeValue.NEG_ONE_MILLISECOND); final Future endpointFuture2 = connManager.lease("id2", route, null, TIMEOUT, null); final AsyncConnectionEndpoint endpoint2 = endpointFuture2.get(LEASE_TIMEOUT.getDuration(), LEASE_TIMEOUT.getTimeUnit()); Assertions.assertTrue(endpoint2.isConnected()); final HttpConnection connection = ((ConnectionHolder) endpoint2).get(); Assertions.assertEquals(connectionSocketTimeout, connection.getSocketTimeout()); connManager.close(); } } ././@LongLink0100644 0000000 0000000 00000000153 15063503632 011635 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractH2AsyncFundamentalsTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractH2AsyncFundamentalsTes0100664 0000000 0000000 00000023304 15063503632 032654 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.io.IOException; import java.util.Queue; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.CountDownLatch; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.Result; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.RequestNotExecutedException; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.AsyncRequestConsumer; import org.apache.hc.core5.http.nio.AsyncServerRequestHandler; import org.apache.hc.core5.http.nio.entity.DiscardingEntityConsumer; import org.apache.hc.core5.http.nio.entity.StringAsyncEntityProducer; import org.apache.hc.core5.http.nio.support.AbstractAsyncPushHandler; import org.apache.hc.core5.http.nio.support.AbstractAsyncRequesterConsumer; import org.apache.hc.core5.http.nio.support.AbstractServerExchangeHandler; import org.apache.hc.core5.http.nio.support.BasicPushProducer; import org.apache.hc.core5.http.nio.support.BasicResponseProducer; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.http.support.BasicResponseBuilder; import org.apache.hc.core5.http2.config.H2Config; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; abstract class AbstractH2AsyncFundamentalsTest extends AbstractHttpAsyncFundamentalsTest { public AbstractH2AsyncFundamentalsTest(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel, final ServerProtocolLevel serverProtocolLevel) { super(scheme, clientProtocolLevel, serverProtocolLevel); } @Test void testPush() throws Exception { configureServer(bootstrap -> bootstrap .register("/pushy", () -> new AbstractServerExchangeHandler() { @Override protected AsyncRequestConsumer supplyConsumer( final HttpRequest request, final EntityDetails entityDetails, final HttpContext context) throws HttpException { return new AbstractAsyncRequesterConsumer(new DiscardingEntityConsumer<>()) { @Override protected HttpRequest buildResult(final HttpRequest request, final Void entity, final ContentType contentType) { return request; } }; } @Override protected void handle( final HttpRequest request, final AsyncServerRequestHandler.ResponseTrigger responseTrigger, final HttpContext context) throws HttpException, IOException { responseTrigger.pushPromise( BasicRequestBuilder.copy(request) .setPath("/aaa") .build(), context, new BasicPushProducer(BasicResponseBuilder.create(HttpStatus.SC_OK) .build(), new StringAsyncEntityProducer("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", ContentType.TEXT_PLAIN))); responseTrigger.pushPromise( BasicRequestBuilder.copy(request) .setPath("/bbb") .build(), context, new BasicPushProducer( BasicResponseBuilder.create(HttpStatus.SC_OK).build(), new StringAsyncEntityProducer("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", ContentType.TEXT_PLAIN))); responseTrigger.submitResponse( new BasicResponseProducer( BasicResponseBuilder.create(HttpStatus.SC_OK).build(), new StringAsyncEntityProducer("I am being very pushy") ), context); } })); configureClient(builder -> builder .setH2Config(H2Config.custom() .setPushEnabled(true) .build())); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); client.start(); final Queue> pushMessageQueue = new ConcurrentLinkedQueue<>(); final CountDownLatch latch = new CountDownLatch(3); final HttpClientContext context = HttpClientContext.create(); final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/pushy") .build(); client.execute( SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), (r, c) -> new AbstractAsyncPushHandler(SimpleResponseConsumer.create()) { @Override protected void handleResponse(final HttpRequest promise, final SimpleHttpResponse response) throws IOException, HttpException { pushMessageQueue.add(new Result<>(promise, response, response.getBodyText())); latch.countDown(); } @Override protected void handleError(final HttpRequest promise, final Exception cause) { pushMessageQueue.add(new Result<>(promise, cause)); latch.countDown(); } }, context, new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { pushMessageQueue.add(new Result<>(request, response, response.getBodyText())); latch.countDown(); } @Override public void failed(final Exception ex) { pushMessageQueue.add(new Result<>(request, ex)); latch.countDown(); } @Override public void cancelled() { pushMessageQueue.add(new Result<>(request, new RequestNotExecutedException())); latch.countDown(); } } ); Assertions.assertTrue(latch.await(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit())); Assertions.assertEquals(3, pushMessageQueue.size()); for (final Result result : pushMessageQueue) { if (result.isOK()) { Assertions.assertEquals(HttpStatus.SC_OK, result.response.getCode()); final String path = result.request.getPath(); if (path.equals("/pushy")) { Assertions.assertEquals("I am being very pushy", result.content); } else if (path.equals("/aaa")) { Assertions.assertEquals("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", result.content); } else if (path.equals("/bbb")) { Assertions.assertEquals("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", result.content); } else { Assertions.fail("Unxpected request path: " + path); } } } } }././@LongLink0100644 0000000 0000000 00000000165 15005672016 011637 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractHttpAsyncClientAuthenticationTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractHttpAsyncClientAuthent0100664 0000000 0000000 00000062012 15005672016 032772 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import static org.hamcrest.MatcherAssert.assertThat; import java.security.SecureRandom; import java.util.Arrays; import java.util.Collections; import java.util.Queue; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import java.util.concurrent.atomic.AtomicLong; import java.util.function.Consumer; import java.util.stream.Collectors; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.BearerToken; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy; import org.apache.hc.client5.http.impl.auth.BasicAuthCache; import org.apache.hc.client5.http.impl.auth.BasicScheme; import org.apache.hc.client5.http.impl.auth.CredentialsProviderBuilder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.BasicTestAuthenticator; import org.apache.hc.client5.testing.auth.Authenticator; import org.apache.hc.client5.testing.auth.BearerAuthenticationHandler; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.client5.testing.extension.async.TestAsyncServerBootstrap; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Registry; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.support.BasicResponseBuilder; import org.apache.hc.core5.net.URIAuthority; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.mockito.Mockito; abstract class AbstractHttpAsyncClientAuthenticationTest extends AbstractIntegrationTestBase { public AbstractHttpAsyncClientAuthenticationTest(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel, final ServerProtocolLevel serverProtocolLevel) { super(scheme, clientProtocolLevel, serverProtocolLevel); } public void configureServerWithBasicAuth(final Authenticator authenticator, final Consumer serverCustomizer) { configureServer(bootstrap -> { bootstrap.setExchangeHandlerDecorator(requestHandler -> new AuthenticatingAsyncDecorator(requestHandler, authenticator)); serverCustomizer.accept(bootstrap); }); } public void configureServerWithBasicAuth(final Consumer serverCustomizer) { configureServerWithBasicAuth( new BasicTestAuthenticator("test:test", "test realm"), serverCustomizer); } @Test void testBasicAuthenticationNoCreds() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap.register("*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credsProvider); final Future future = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } @Test void testBasicAuthenticationFailure() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap.register("*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "all-wrong".toCharArray())); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credsProvider); final Future future = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } @Test void testBasicAuthenticationSuccess() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap.register("*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credsProvider); final Future future = client.execute( SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } @Test void testBasicAuthenticationWithEntitySuccess() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap.register("*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credsProvider); final Future future = client.execute( SimpleRequestBuilder.put() .setHttpHost(target) .setPath("/") .setBody("Some important stuff", ContentType.TEXT_PLAIN) .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } @Test void testBasicAuthenticationExpectationFailure() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap.register("*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "all-wrong".toCharArray())); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credsProvider); context.setRequestConfig(RequestConfig.custom().setExpectContinueEnabled(true).build()); final Future future = client.execute( SimpleRequestBuilder.put() .setHttpHost(target) .setPath("/") .setBody("Some important stuff", ContentType.TEXT_PLAIN) .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); } @Test void testBasicAuthenticationExpectationSuccess() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap.register("*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credsProvider); context.setRequestConfig(RequestConfig.custom().setExpectContinueEnabled(true).build()); final Future future = client.execute( SimpleRequestBuilder.put() .setHttpHost(target) .setPath("/") .setBody("Some important stuff", ContentType.TEXT_PLAIN) .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } @Test void testBasicAuthenticationCredentialsCaching() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap.register("*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final DefaultAuthenticationStrategy authStrategy = Mockito.spy(new DefaultAuthenticationStrategy()); configureClient(builder -> builder.setTargetAuthenticationStrategy(authStrategy)); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(CredentialsProviderBuilder.create() .add(target, "test", "test".toCharArray()) .build()); for (int i = 0; i < 5; i++) { final Future future = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); } Mockito.verify(authStrategy).select(Mockito.any(), Mockito.any(), Mockito.any()); } @Test void testBasicAuthenticationCredentialsCachingByPathPrefix() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap.register("*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final DefaultAuthenticationStrategy authStrategy = Mockito.spy(new DefaultAuthenticationStrategy()); final Queue responseQueue = new ConcurrentLinkedQueue<>(); configureClient(builder -> builder .setTargetAuthenticationStrategy(authStrategy) .addResponseInterceptorFirst((response, entity, context) -> responseQueue.add(BasicResponseBuilder.copy(response).build()))); final TestAsyncClient client = startClient(); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(target, "test", "test".toCharArray()) .build(); final AuthCache authCache = new BasicAuthCache(); for (final String requestPath: new String[] {"/blah/a", "/blah/b?huh", "/blah/c", "/bl%61h/%61"}) { final HttpClientContext context = HttpClientContext.create(); context.setAuthCache(authCache); context.setCredentialsProvider(credentialsProvider); final Future future = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath(requestPath) .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); } // There should be only single auth strategy call for all successful message exchanges Mockito.verify(authStrategy).select(Mockito.any(), Mockito.any(), Mockito.any()); assertThat( responseQueue.stream().map(HttpResponse::getCode).collect(Collectors.toList()), CoreMatchers.equalTo(Arrays.asList(401, 200, 200, 200, 200))); responseQueue.clear(); authCache.clear(); Mockito.reset(authStrategy); for (final String requestPath: new String[] {"/blah/a", "/yada/a", "/blah/blah/"}) { final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credentialsProvider); context.setAuthCache(authCache); final Future future = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath(requestPath) .build(), context, null); final HttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); } // There should be an auth strategy call for all successful message exchanges Mockito.verify(authStrategy, Mockito.times(3)).select(Mockito.any(), Mockito.any(), Mockito.any()); assertThat( responseQueue.stream().map(HttpResponse::getCode).collect(Collectors.toList()), CoreMatchers.equalTo(Arrays.asList(401, 200, 401, 200, 401, 200))); } @Test void testAuthenticationUserinfoInRequestFailure() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap.register("*", AsyncEchoHandler::new)); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final HttpClientContext context = HttpClientContext.create(); final Future future = client.execute(SimpleRequestBuilder.get() .setScheme(target.getSchemeName()) .setAuthority(new URIAuthority("test:test", target.getHostName(), target.getPort())) .setPath("/") .build(), context, null); final ExecutionException exception = Assertions.assertThrows(ExecutionException.class, () -> future.get()); assertThat(exception.getCause(), CoreMatchers.instanceOf(ProtocolException.class)); } @Test void testReauthentication() throws Exception { final Authenticator authenticator = new BasicTestAuthenticator("test:test", "test realm") { private final AtomicLong count = new AtomicLong(0); @Override public boolean authenticate(final URIAuthority authority, final String requestUri, final String credentials) { final boolean authenticated = super.authenticate(authority, requestUri, credentials); if (authenticated) { return this.count.incrementAndGet() % 4 != 0; } return false; } }; configureServerWithBasicAuth(bootstrap -> bootstrap .register("*", AsyncEchoHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new AuthenticatingAsyncDecorator(exchangeHandler, authenticator) { @Override protected void customizeUnauthorizedResponse(final HttpResponse unauthorized) { unauthorized.removeHeaders(HttpHeaders.WWW_AUTHENTICATE); unauthorized.addHeader(HttpHeaders.WWW_AUTHENTICATE, "MyBasic realm=\"test realm\""); } })); final HttpHost target = startServer(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); final Registry authSchemeRegistry = RegistryBuilder.create() .register("MyBasic", context -> new BasicScheme() { private static final long serialVersionUID = 1L; @Override public String getName() { return "MyBasic"; } }) .build(); configureClient(builder -> builder.setDefaultAuthSchemeRegistry(authSchemeRegistry)); final TestAsyncClient client = startClient(); final RequestConfig config = RequestConfig.custom() .setTargetPreferredAuthSchemes(Collections.singletonList("MyBasic")) .build(); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credsProvider); for (int i = 0; i < 10; i++) { final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); request.setConfig(config); final Future future = client.execute(request, context, null); final SimpleHttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); } } @Test void testAuthenticationFallback() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap .register("*", AsyncEchoHandler::new) .setExchangeHandlerDecorator(exchangeHandler -> new AuthenticatingAsyncDecorator(exchangeHandler, new BasicTestAuthenticator("test:test", "test realm")) { @Override protected void customizeUnauthorizedResponse(final HttpResponse unauthorized) { unauthorized.addHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.DIGEST + " realm=\"test realm\" invalid"); } })); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credsProvider); final Future future = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(), context, null); final SimpleHttpResponse response = future.get(); Assertions.assertNotNull(response); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } private final static String CHARS = "0123456789abcdef"; @Test void testBearerTokenAuthentication() throws Exception { final SecureRandom secureRandom = SecureRandom.getInstanceStrong(); secureRandom.setSeed(System.currentTimeMillis()); final StringBuilder buf = new StringBuilder(); for (int i = 0; i < 16; i++) { buf.append(CHARS.charAt(secureRandom.nextInt(CHARS.length() - 1))); } final String token = buf.toString(); configureServerWithBasicAuth(bootstrap -> bootstrap .register("*", AsyncEchoHandler::new) .setExchangeHandlerDecorator(requestHandler -> new AuthenticatingAsyncDecorator( requestHandler, new BearerAuthenticationHandler(), new BasicTestAuthenticator(token, "test realm")))); final HttpHost target = startServer(); final TestAsyncClient client = startClient(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); final HttpClientContext context1 = HttpClientContext.create(); context1.setCredentialsProvider(credsProvider); final Future future1 = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(), context1, null); final SimpleHttpResponse response1 = future1.get(); Assertions.assertNotNull(response1); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response1.getCode()); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "bearer")), Mockito.any()); final HttpClientContext context2 = HttpClientContext.create(); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new BearerToken(token)); context2.setCredentialsProvider(credsProvider); final Future future2 = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(), context2, null); final SimpleHttpResponse response2 = future2.get(); Assertions.assertNotNull(response2); Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode()); final HttpClientContext context3 = HttpClientContext.create(); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new BearerToken(token + "-expired")); context3.setCredentialsProvider(credsProvider); final Future future3 = client.execute(SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(), context3, null); final SimpleHttpResponse response3 = future3.get(); Assertions.assertNotNull(response3); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response3.getCode()); } } ././@LongLink0100644 0000000 0000000 00000000167 15005672016 011641 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractClassicOverAsyncIntegrationTestBase.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/async/AbstractClassicOverAsyncIntegr0100664 0000000 0000000 00000006772 15005672016 032764 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.async; import java.net.InetSocketAddress; import java.util.function.Consumer; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.compat.ClassicToAsyncAdaptor; import org.apache.hc.client5.testing.extension.async.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.async.ServerProtocolLevel; import org.apache.hc.client5.testing.extension.async.TestAsyncClient; import org.apache.hc.client5.testing.extension.async.TestAsyncClientBuilder; import org.apache.hc.client5.testing.extension.async.TestAsyncResources; import org.apache.hc.client5.testing.extension.async.TestAsyncServer; import org.apache.hc.client5.testing.extension.async.TestAsyncServerBootstrap; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.extension.RegisterExtension; abstract class AbstractClassicOverAsyncIntegrationTestBase { public static final Timeout TIMEOUT = Timeout.ofMinutes(1); @RegisterExtension private final TestAsyncResources testResources; protected AbstractClassicOverAsyncIntegrationTestBase(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel, final ServerProtocolLevel serverProtocolLevel) { this.testResources = new TestAsyncResources(scheme, clientProtocolLevel, serverProtocolLevel, TIMEOUT); } public void configureServer(final Consumer serverCustomizer) { testResources.configureServer(serverCustomizer); } public HttpHost startServer() throws Exception { final TestAsyncServer server = testResources.server(); final InetSocketAddress inetSocketAddress = server.start(); return new HttpHost(testResources.scheme().id, "localhost", inetSocketAddress.getPort()); } public void configureClient(final Consumer clientCustomizer) { testResources.configureClient(clientCustomizer); } public CloseableHttpClient startClient() throws Exception { final TestAsyncClient client = testResources.client(); client.start(); return new ClassicToAsyncAdaptor(client, TIMEOUT); } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/0040775 0000000 0000000 00000000000 15005672016 026514 5ustar000000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/async/0040775 0000000 0000000 00000000000 15005672016 027631 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000201 15005672016 011626 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/async/CachingHttpAsyncClientCompatibilityTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/async/CachingHttpAsync0100664 0000000 0000000 00000022326 15005672016 032750 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.compatibility.async; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.cache.CacheResponseStatus; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.cache.CacheConfig; import org.apache.hc.client5.http.impl.cache.HeapResourceFactory; import org.apache.hc.client5.testing.extension.async.CachingHttpAsyncClientResource; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; public abstract class CachingHttpAsyncClientCompatibilityTest { static final Timeout TIMEOUT = Timeout.ofSeconds(5); private final HttpHost target; @RegisterExtension private final CachingHttpAsyncClientResource clientResource; public CachingHttpAsyncClientCompatibilityTest(final HttpVersionPolicy versionPolicy, final HttpHost target) throws Exception { this.target = target; this.clientResource = new CachingHttpAsyncClientResource(versionPolicy); this.clientResource.configure(builder -> builder .setCacheConfig(CacheConfig.custom() .setMaxObjectSize(10240 * 16) .build()) .setResourceFactory(HeapResourceFactory.INSTANCE)); } CloseableHttpAsyncClient client() { return clientResource.client(); } @Test @Disabled void test_options_ping() throws Exception { final CloseableHttpAsyncClient client = client(); final HttpCacheContext context = HttpCacheContext.create(); final SimpleHttpRequest options = SimpleRequestBuilder.options() .setHttpHost(target) .setPath("*") .build(); final Future future = client.execute(options, context, null); final SimpleHttpResponse response = future.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); } @Test void test_get_from_cache() throws Exception { final CloseableHttpAsyncClient client = client(); final String[] resources1 = {"/111", "/222"}; for (final String r: resources1) { final SimpleHttpRequest httpGet1 = SimpleRequestBuilder.get() .setHttpHost(target) .setPath(r) .build(); final HttpCacheContext context1 = HttpCacheContext.create(); final Future future1 = client.execute(httpGet1, context1, null); final SimpleHttpResponse response1 = future1.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response1.getCode()); Assertions.assertEquals(CacheResponseStatus.CACHE_MISS, context1.getCacheResponseStatus()); final ResponseCacheControl responseCacheControl1 = context1.getResponseCacheControl(); Assertions.assertNotNull(responseCacheControl1); if (!r.equals("/333")) { Assertions.assertEquals(600, responseCacheControl1.getMaxAge()); } final HttpCacheEntry cacheEntry1 = context1.getCacheEntry(); Assertions.assertNotNull(cacheEntry1); final SimpleHttpRequest httpGet2 = SimpleRequestBuilder.get() .setHttpHost(target) .setPath(r) .build(); final HttpCacheContext context2 = HttpCacheContext.create(); final Future future2 = client.execute(httpGet2, context2, null); final SimpleHttpResponse response2 = future2.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode()); Assertions.assertEquals(CacheResponseStatus.CACHE_HIT, context2.getCacheResponseStatus()); final ResponseCacheControl responseCacheControl2 = context2.getResponseCacheControl(); Assertions.assertNotNull(responseCacheControl2); Assertions.assertEquals(600, responseCacheControl2.getMaxAge()); final HttpCacheEntry cacheEntry2 = context2.getCacheEntry(); Assertions.assertNotNull(cacheEntry2); Assertions.assertSame(cacheEntry2, context1.getCacheEntry()); Thread.sleep(2000); final SimpleHttpRequest httpGet3 = SimpleRequestBuilder.get() .setHttpHost(target) .setPath(r) .build(); final HttpCacheContext context3 = HttpCacheContext.create(); context3.setRequestCacheControl(RequestCacheControl.builder() .setMaxAge(0) .build()); final Future future3 = client.execute(httpGet3, context3, null); final SimpleHttpResponse response3 = future3.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response3.getCode()); Assertions.assertEquals(CacheResponseStatus.VALIDATED, context3.getCacheResponseStatus()); final HttpCacheEntry cacheEntry3 = context3.getCacheEntry(); Assertions.assertNotNull(cacheEntry3); Assertions.assertNotSame(cacheEntry3, context1.getCacheEntry()); } final String[] resources2 = {"/333"}; for (final String r: resources2) { final SimpleHttpRequest httpGet1 = SimpleRequestBuilder.get() .setHttpHost(target) .setPath(r) .build(); final HttpCacheContext context1 = HttpCacheContext.create(); final Future future1 = client.execute(httpGet1, context1, null); final SimpleHttpResponse response1 = future1.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response1.getCode()); Assertions.assertEquals(CacheResponseStatus.CACHE_MISS, context1.getCacheResponseStatus()); final ResponseCacheControl responseCacheControl1 = context1.getResponseCacheControl(); Assertions.assertNotNull(responseCacheControl1); Assertions.assertEquals(-1, responseCacheControl1.getMaxAge()); final HttpCacheEntry cacheEntry1 = context1.getCacheEntry(); Assertions.assertNotNull(cacheEntry1); final SimpleHttpRequest httpGet2 = SimpleRequestBuilder.get() .setHttpHost(target) .setPath(r) .build(); final HttpCacheContext context2 = HttpCacheContext.create(); final Future future2 = client.execute(httpGet2, context2, null); final SimpleHttpResponse response2 = future2.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode()); Assertions.assertEquals(CacheResponseStatus.VALIDATED, context2.getCacheResponseStatus()); final ResponseCacheControl responseCacheControl2 = context2.getResponseCacheControl(); Assertions.assertNotNull(responseCacheControl2); Assertions.assertEquals(-1, responseCacheControl2.getMaxAge()); final HttpCacheEntry cacheEntry2 = context2.getCacheEntry(); Assertions.assertNotNull(cacheEntry2); Assertions.assertNotSame(cacheEntry2, context1.getCacheEntry()); } } } ././@LongLink0100644 0000000 0000000 00000000177 15005672016 011642 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/async/HttpAsyncClientProxyCompatibilityTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/async/HttpAsyncClientP0100664 0000000 0000000 00000010416 15005672016 032747 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.compatibility.async; import java.util.concurrent.Future; import org.apache.hc.client5.http.ContextBuilder; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.async.HttpAsyncClientResource; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; public abstract class HttpAsyncClientProxyCompatibilityTest { static final Timeout TIMEOUT = Timeout.ofSeconds(5); private final HttpHost target; private final HttpHost proxy; @RegisterExtension private final HttpAsyncClientResource clientResource; private final BasicCredentialsProvider credentialsProvider; public HttpAsyncClientProxyCompatibilityTest(final HttpHost target, final HttpHost proxy) throws Exception { this.target = target; this.proxy = proxy; this.clientResource = new HttpAsyncClientResource(HttpVersionPolicy.FORCE_HTTP_1); this.clientResource.configure(builder -> builder.setProxy(proxy)); this.credentialsProvider = new BasicCredentialsProvider(); } CloseableHttpAsyncClient client() { return clientResource.client(); } HttpClientContext context() { return ContextBuilder.create() .useCredentialsProvider(credentialsProvider) .build(); } void addCredentials(final AuthScope authScope, final Credentials credentials) { credentialsProvider.setCredentials(authScope, credentials); } @Test void test_auth_failure_wrong_proxy_credentials() throws Exception { addCredentials( new AuthScope(proxy), new UsernamePasswordCredentials("testuser", "wrong password".toCharArray())); final CloseableHttpAsyncClient client = client(); for (int i = 0; i < 10; i++) { final HttpClientContext context = context(); final SimpleHttpRequest httpGetSecret = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); final Future future = client.execute(httpGetSecret, context, null); final SimpleHttpResponse response = future.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_PROXY_AUTHENTICATION_REQUIRED, response.getCode()); } } } ././@LongLink0100644 0000000 0000000 00000000172 15005672016 011635 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/async/HttpAsyncClientCompatibilityTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/async/HttpAsyncClientC0100664 0000000 0000000 00000023466 15005672016 032743 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.compatibility.async; import java.util.Queue; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.CountDownLatch; import java.util.concurrent.Future; import org.apache.hc.client5.http.ContextBuilder; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.Result; import org.apache.hc.client5.testing.extension.async.HttpAsyncClientResource; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.RequestNotExecutedException; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; public abstract class HttpAsyncClientCompatibilityTest { static final Timeout TIMEOUT = Timeout.ofSeconds(5); static final Timeout LONG_TIMEOUT = Timeout.ofSeconds(30); private final HttpVersionPolicy versionPolicy; private final HttpHost target; @RegisterExtension private final HttpAsyncClientResource clientResource; private final BasicCredentialsProvider credentialsProvider; public HttpAsyncClientCompatibilityTest( final HttpVersionPolicy versionPolicy, final HttpHost target, final HttpHost proxy, final Credentials proxyCreds) throws Exception { this.versionPolicy = versionPolicy; this.target = target; this.clientResource = new HttpAsyncClientResource(versionPolicy); this.clientResource.configure(builder -> builder.setProxy(proxy)); this.credentialsProvider = new BasicCredentialsProvider(); if (proxy != null && proxyCreds != null) { this.credentialsProvider.setCredentials(new AuthScope(proxy), proxyCreds); } } CloseableHttpAsyncClient client() { return clientResource.client(); } HttpClientContext context() { return ContextBuilder.create() .useCredentialsProvider(credentialsProvider) .build(); } void addCredentials(final AuthScope authScope, final Credentials credentials) { credentialsProvider.setCredentials(authScope, credentials); } void assertProtocolVersion(final HttpClientContext context) { switch (versionPolicy) { case FORCE_HTTP_1: Assertions.assertEquals(HttpVersion.HTTP_1_1, context.getProtocolVersion()); break; case FORCE_HTTP_2: case NEGOTIATE: Assertions.assertEquals(HttpVersion.HTTP_2, context.getProtocolVersion()); break; default: throw new IllegalStateException("Unexpected version policy: " + versionPolicy); } } @Test void test_sequential_gets() throws Exception { final CloseableHttpAsyncClient client = client(); final HttpClientContext context = context(); final String[] requestUris = new String[] {"/111", "/222", "/333"}; for (final String requestUri: requestUris) { final SimpleHttpRequest httpGet = SimpleRequestBuilder.get() .setHttpHost(target) .setPath(requestUri) .build(); final Future future = client.execute(httpGet, context, null); final SimpleHttpResponse response = future.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); assertProtocolVersion(context); } } @Test void test_concurrent_gets() throws Exception { final CloseableHttpAsyncClient client = client(); final String[] requestUris = new String[] {"/111", "/222", "/333"}; final int n = 200; final Queue> queue = new ConcurrentLinkedQueue<>(); final CountDownLatch latch = new CountDownLatch(requestUris.length * n); for (int i = 0; i < n; i++) { for (final String requestUri: requestUris) { final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath(requestUri) .build(); final HttpClientContext context = context(); client.execute(request, context, new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { queue.add(new Result<>(request, response, null)); latch.countDown(); } @Override public void failed(final Exception ex) { queue.add(new Result<>(request, ex)); latch.countDown(); } @Override public void cancelled() { queue.add(new Result<>(request, new RequestNotExecutedException())); latch.countDown(); } }); } } Assertions.assertTrue(latch.await(LONG_TIMEOUT.getDuration(), LONG_TIMEOUT.getTimeUnit())); Assertions.assertEquals(requestUris.length * n, queue.size()); for (final Result result : queue) { if (result.isOK()) { Assertions.assertEquals(HttpStatus.SC_OK, result.response.getCode()); } } } @Test void test_auth_failure_wrong_auth_scope() throws Exception { addCredentials( new AuthScope("http", "otherhost", -1, "Restricted Files", null), new UsernamePasswordCredentials("testuser", "nopassword".toCharArray())); final CloseableHttpAsyncClient client = client(); final HttpClientContext context = context(); final SimpleHttpRequest httpGetSecret = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/private/big-secret.txt") .build(); final Future future = client.execute(httpGetSecret, context, null); final SimpleHttpResponse response = future.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); assertProtocolVersion(context); } @Test void test_auth_failure_wrong_auth_credentials() throws Exception { addCredentials( new AuthScope(target), new UsernamePasswordCredentials("testuser", "wrong password".toCharArray())); final CloseableHttpAsyncClient client = client(); final HttpClientContext context = context(); final SimpleHttpRequest httpGetSecret = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/private/big-secret.txt") .build(); final Future future = client.execute(httpGetSecret, context, null); final SimpleHttpResponse response = future.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); assertProtocolVersion(context); } @Test void test_auth_success() throws Exception { addCredentials( new AuthScope(target), new UsernamePasswordCredentials("testuser", "nopassword".toCharArray())); final CloseableHttpAsyncClient client = client(); final HttpClientContext context = context(); final SimpleHttpRequest httpGetSecret = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/private/big-secret.txt") .build(); final Future future = client.execute(httpGetSecret, context, null); final SimpleHttpResponse response = future.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); assertProtocolVersion(context); } } ././@LongLink0100644 0000000 0000000 00000000177 15005672016 011642 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/async/HttpAsyncClientHttp1CompatibilityTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/async/HttpAsyncClientH0100664 0000000 0000000 00000006566 15005672016 032752 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.compatibility.async; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; public abstract class HttpAsyncClientHttp1CompatibilityTest extends HttpAsyncClientCompatibilityTest { private final HttpHost target; public HttpAsyncClientHttp1CompatibilityTest( final HttpHost target, final HttpHost proxy, final Credentials proxyCreds) throws Exception { super(HttpVersionPolicy.FORCE_HTTP_1, target, proxy, proxyCreds); this.target = target; } @Test void test_auth_success_no_keep_alive() throws Exception { addCredentials( new AuthScope(target), new UsernamePasswordCredentials("testuser", "nopassword".toCharArray())); final CloseableHttpAsyncClient client = client(); final HttpClientContext context = context(); final SimpleHttpRequest httpGetSecret = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/private/big-secret.txt") .addHeader(HttpHeaders.CONNECTION, HeaderElements.CLOSE) .build(); final Future future = client.execute(httpGetSecret, context, null); final SimpleHttpResponse response = future.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit()); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); assertProtocolVersion(context); } } ././@LongLink0100644 0000000 0000000 00000000163 15005672016 011635 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/ApacheHTTPDSquidCompatibilityIT.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/ApacheHTTPDSquidCompat0100664 0000000 0000000 00000030725 15005672016 032602 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.compatibility; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.testing.compatibility.async.CachingHttpAsyncClientCompatibilityTest; import org.apache.hc.client5.testing.compatibility.async.HttpAsyncClientCompatibilityTest; import org.apache.hc.client5.testing.compatibility.async.HttpAsyncClientHttp1CompatibilityTest; import org.apache.hc.client5.testing.compatibility.async.HttpAsyncClientProxyCompatibilityTest; import org.apache.hc.client5.testing.compatibility.sync.CachingHttpClientCompatibilityTest; import org.apache.hc.client5.testing.compatibility.sync.HttpClientCompatibilityTest; import org.apache.hc.client5.testing.compatibility.sync.HttpClientProxyCompatibilityTest; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Nested; import org.testcontainers.containers.GenericContainer; import org.testcontainers.containers.Network; import org.testcontainers.junit.jupiter.Container; import org.testcontainers.junit.jupiter.Testcontainers; @Testcontainers(disabledWithoutDocker = true) class ApacheHTTPDSquidCompatibilityIT { private static Network NETWORK = Network.newNetwork(); @Container static final GenericContainer HTTPD_CONTAINER = ContainerImages.apacheHttpD(NETWORK); @Container static final GenericContainer SQUID = ContainerImages.squid(NETWORK); static HttpHost targetContainerHost() { return new HttpHost(URIScheme.HTTP.id, HTTPD_CONTAINER.getHost(), HTTPD_CONTAINER.getMappedPort(ContainerImages.HTTP_PORT)); } static HttpHost targetInternalHost() { return new HttpHost(URIScheme.HTTP.id, ContainerImages.WEB_SERVER, ContainerImages.HTTP_PORT); } static HttpHost targetContainerTlsHost() { return new HttpHost(URIScheme.HTTPS.id, HTTPD_CONTAINER.getHost(), HTTPD_CONTAINER.getMappedPort(ContainerImages.HTTPS_PORT)); } static HttpHost targetInternalTlsHost() { return new HttpHost(URIScheme.HTTPS.id, ContainerImages.WEB_SERVER, ContainerImages.HTTPS_PORT); } static HttpHost proxyContainerHost() { return new HttpHost(URIScheme.HTTP.id, SQUID.getHost(), SQUID.getMappedPort(ContainerImages.PROXY_PORT)); } static HttpHost proxyPwProtectedContainerHost() { return new HttpHost(URIScheme.HTTP.id, SQUID.getHost(), SQUID.getMappedPort(ContainerImages.PROXY_PW_PROTECTED_PORT)); } @AfterAll static void cleanup() { SQUID.close(); HTTPD_CONTAINER.close(); NETWORK.close(); } @Nested @DisplayName("Classic client: HTTP/1.1, plain, direct connection") class ClassicDirectHttp extends HttpClientCompatibilityTest { public ClassicDirectHttp() throws Exception { super(targetContainerHost(), null, null); } } @Nested @DisplayName("Classic client: HTTP/1.1, plain, connection via proxy") class ClassicViaProxyHttp extends HttpClientCompatibilityTest { public ClassicViaProxyHttp() throws Exception { super(targetInternalHost(), proxyContainerHost(), null); } } @Nested @DisplayName("Classic client: HTTP/1.1, plain, connection via password protected proxy") class ClassicViaPwProtectedProxyHttp extends HttpClientCompatibilityTest { public ClassicViaPwProtectedProxyHttp() throws Exception { super(targetInternalHost(), proxyPwProtectedContainerHost(), new UsernamePasswordCredentials("squid", "nopassword".toCharArray())); } } @Nested @DisplayName("Classic client: HTTP/1.1, TLS, direct connection") class ClassicDirectHttpTls extends HttpClientCompatibilityTest { public ClassicDirectHttpTls() throws Exception { super(targetContainerTlsHost(), null, null); } } @Nested @DisplayName("Classic client: HTTP/1.1, TLS, connection via proxy (tunnel)") class ClassicViaProxyHttpTls extends HttpClientCompatibilityTest { public ClassicViaProxyHttpTls() throws Exception { super(targetInternalTlsHost(), proxyContainerHost(), null); } } @Nested @DisplayName("Classic client: HTTP/1.1, TLS, connection via password protected proxy (tunnel)") class ClassicViaPwProtectedProxyHttpTls extends HttpClientCompatibilityTest { public ClassicViaPwProtectedProxyHttpTls() throws Exception { super(targetInternalTlsHost(), proxyPwProtectedContainerHost(), new UsernamePasswordCredentials("squid", "nopassword".toCharArray())); } } @Nested @DisplayName("Async client: HTTP/1.1, plain, direct connection") class AsyncDirectHttp1 extends HttpAsyncClientHttp1CompatibilityTest { public AsyncDirectHttp1() throws Exception { super(targetContainerHost(), null, null); } } @Nested @DisplayName("Async client: HTTP/1.1, plain, connection via proxy") class AsyncViaProxyHttp1 extends HttpAsyncClientHttp1CompatibilityTest { public AsyncViaProxyHttp1() throws Exception { super(targetInternalHost(), proxyContainerHost(), null); } } @Nested @DisplayName("Async client: HTTP/1.1, plain, connection via password protected proxy") class AsyncViaPwProtectedProxyHttp1 extends HttpAsyncClientHttp1CompatibilityTest { public AsyncViaPwProtectedProxyHttp1() throws Exception { super(targetInternalHost(), proxyPwProtectedContainerHost(), new UsernamePasswordCredentials("squid", "nopassword".toCharArray())); } } @Nested @DisplayName("Async client: HTTP/1.1, TLS, direct connection") class AsyncDirectHttp1Tls extends HttpAsyncClientHttp1CompatibilityTest { public AsyncDirectHttp1Tls() throws Exception { super(targetContainerTlsHost(), null, null); } } @Nested @DisplayName("Async client: HTTP/1.1, TLS, connection via proxy (tunnel)") class AsyncViaProxyHttp1Tls extends HttpAsyncClientHttp1CompatibilityTest { public AsyncViaProxyHttp1Tls() throws Exception { super(targetInternalTlsHost(), proxyContainerHost(), null); } } @Nested @DisplayName("Async client: HTTP/1.1, TLS, connection via password protected proxy (tunnel)") class AsyncViaPwProtectedProxyHttp1Tls extends HttpAsyncClientHttp1CompatibilityTest { public AsyncViaPwProtectedProxyHttp1Tls() throws Exception { super(targetInternalTlsHost(), proxyPwProtectedContainerHost(), new UsernamePasswordCredentials("squid", "nopassword".toCharArray())); } } @Nested @DisplayName("Async client: HTTP/2, plain, direct connection") class AsyncDirectHttp2 extends HttpAsyncClientCompatibilityTest { public AsyncDirectHttp2() throws Exception { super(HttpVersionPolicy.FORCE_HTTP_2, targetContainerHost(), null, null); } } @Nested @DisplayName("Async client: HTTP/2, TLS, direct connection") class AsyncDirectHttp2Tls extends HttpAsyncClientCompatibilityTest { public AsyncDirectHttp2Tls() throws Exception { super(HttpVersionPolicy.FORCE_HTTP_2, targetContainerTlsHost(), null, null); } } @Nested @DisplayName("Async client: HTTP/2, TLS, connection via proxy (tunnel)") class AsyncViaProxyHttp2Tls extends HttpAsyncClientCompatibilityTest { public AsyncViaProxyHttp2Tls() throws Exception { super(HttpVersionPolicy.FORCE_HTTP_2, targetInternalTlsHost(), proxyContainerHost(), null); } } @Nested @DisplayName("Async client: HTTP/2, TLS, connection via password protected proxy (tunnel)") class AsyncViaPwProtectedProxyHttp2Tls extends HttpAsyncClientCompatibilityTest { public AsyncViaPwProtectedProxyHttp2Tls() throws Exception { super(HttpVersionPolicy.FORCE_HTTP_2, targetInternalTlsHost(), proxyPwProtectedContainerHost(), new UsernamePasswordCredentials("squid", "nopassword".toCharArray())); } } @Nested @DisplayName("Async client: protocol negotiate, TLS, connection via proxy (tunnel)") class AsyncViaProxyHttpNegotiateTls extends HttpAsyncClientCompatibilityTest { public AsyncViaProxyHttpNegotiateTls() throws Exception { super(HttpVersionPolicy.NEGOTIATE, targetInternalTlsHost(), proxyContainerHost(), null); } } @Nested @DisplayName("Async client: protocol negotiate, TLS, connection via password protected proxy (tunnel)") class AsyncViaPwProtectedProxyHttpNegotiateTls extends HttpAsyncClientCompatibilityTest { public AsyncViaPwProtectedProxyHttpNegotiateTls() throws Exception { super(HttpVersionPolicy.NEGOTIATE, targetInternalTlsHost(), proxyPwProtectedContainerHost(), new UsernamePasswordCredentials("squid", "nopassword".toCharArray())); } } @Nested @DisplayName("Classic client: HTTP/1.1, caching, plain, direct connection") class ClassicCachingHttp extends CachingHttpClientCompatibilityTest { public ClassicCachingHttp() throws Exception { super(targetContainerHost()); } } @Nested @DisplayName("Classic client: HTTP/1.1, caching, TLS, direct connection") class ClassicCachingHttpTls extends CachingHttpClientCompatibilityTest { public ClassicCachingHttpTls() throws Exception { super(targetContainerTlsHost()); } } @Nested @DisplayName("Async client: HTTP/1.1, caching, plain, direct connection") class AsyncCachingHttp1 extends CachingHttpAsyncClientCompatibilityTest { public AsyncCachingHttp1() throws Exception { super(HttpVersionPolicy.FORCE_HTTP_1, targetContainerHost()); } } @Nested @DisplayName("Async client: HTTP/1.1, caching, TLS, direct connection") class AsyncCachingHttp1Tls extends CachingHttpAsyncClientCompatibilityTest { public AsyncCachingHttp1Tls() throws Exception { super(HttpVersionPolicy.FORCE_HTTP_1, targetContainerTlsHost()); } } @Nested @DisplayName("Async client HTTP/2, caching, plain, direct connection") class AsyncCachingHttp2 extends CachingHttpAsyncClientCompatibilityTest { public AsyncCachingHttp2() throws Exception { super(HttpVersionPolicy.FORCE_HTTP_2, targetContainerHost()); } } @Nested @DisplayName("Async client: HTTP/2, caching, TLS, direct connection") class AsyncCachingHttp2Tls extends CachingHttpAsyncClientCompatibilityTest { public AsyncCachingHttp2Tls() throws Exception { super(HttpVersionPolicy.FORCE_HTTP_2, targetContainerTlsHost()); } } @Nested @DisplayName("Classic client: HTTP/1.1, connection via password protected proxy") class HttpClientProxy extends HttpClientProxyCompatibilityTest { public HttpClientProxy() throws Exception { super(targetInternalTlsHost(), proxyPwProtectedContainerHost()); } } @Nested @DisplayName("Async client: HTTP/1.1, connection via password protected proxy") class AsyncClientProxy extends HttpAsyncClientProxyCompatibilityTest { public AsyncClientProxy() throws Exception { super(targetInternalTlsHost(), proxyPwProtectedContainerHost()); } } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/sync/0040775 0000000 0000000 00000000000 15005672016 027470 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000171 15005672016 011634 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/sync/HttpClientProxyCompatibilityTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/sync/HttpClientProxyCo0100664 0000000 0000000 00000007643 15005672016 033024 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.compatibility.sync; import org.apache.hc.client5.http.ContextBuilder; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsStore; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.sync.HttpClientResource; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; public abstract class HttpClientProxyCompatibilityTest { private final HttpHost target; private final HttpHost proxy; @RegisterExtension private final HttpClientResource clientResource; private final CredentialsStore credentialsProvider; public HttpClientProxyCompatibilityTest(final HttpHost target, final HttpHost proxy) throws Exception { this.target = target; this.proxy = proxy; this.clientResource = new HttpClientResource(); this.clientResource.configure(builder -> builder.setProxy(proxy)); this.credentialsProvider = new BasicCredentialsProvider(); } CloseableHttpClient client() { return clientResource.client(); } HttpClientContext context() { return ContextBuilder.create() .useCredentialsProvider(credentialsProvider) .build(); } void addCredentials(final AuthScope authScope, final Credentials credentials) { credentialsProvider.setCredentials(authScope, credentials); } @Test void test_auth_failure_wrong_proxy_credentials() throws Exception { addCredentials(new AuthScope(proxy), new UsernamePasswordCredentials("testuser", "wrong password".toCharArray())); final CloseableHttpClient client = client(); for (int i = 0; i < 10; i++) { final HttpClientContext context = context(); final ClassicHttpRequest request = new HttpGet("/"); try (ClassicHttpResponse response = client.executeOpen(target, request, context)) { Assertions.assertEquals(HttpStatus.SC_PROXY_AUTHENTICATION_REQUIRED, response.getCode()); EntityUtils.consume(response.getEntity()); } } } } ././@LongLink0100644 0000000 0000000 00000000164 15005672016 011636 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/sync/HttpClientCompatibilityTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/sync/HttpClientCompati0100664 0000000 0000000 00000020010 15005672016 032774 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.compatibility.sync; import org.apache.hc.client5.http.ContextBuilder; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsStore; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpOptions; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.sync.HttpClientResource; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; public abstract class HttpClientCompatibilityTest { private final HttpHost target; @RegisterExtension private final HttpClientResource clientResource; private final CredentialsStore credentialsProvider; public HttpClientCompatibilityTest(final HttpHost target, final HttpHost proxy, final Credentials proxyCreds) throws Exception { this.target = target; this.clientResource = new HttpClientResource(); this.clientResource.configure(builder -> builder.setProxy(proxy)); this.credentialsProvider = new BasicCredentialsProvider(); if (proxy != null && proxyCreds != null) { this.addCredentials(new AuthScope(proxy), proxyCreds); } } CloseableHttpClient client() { return clientResource.client(); } HttpClientContext context() { return ContextBuilder.create() .useCredentialsProvider(credentialsProvider) .build(); } void addCredentials(final AuthScope authScope, final Credentials credentials) { credentialsProvider.setCredentials(authScope, credentials); } @Test void test_options_ping() throws Exception { final CloseableHttpClient client = client(); final HttpClientContext context = context(); final HttpOptions options = new HttpOptions("*"); try (ClassicHttpResponse response = client.executeOpen(target, options, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); } } @Test void test_get() throws Exception { final CloseableHttpClient client = client(); final HttpClientContext context = context(); final String[] requestUris = new String[] { "/111", "/222", "/333" }; for (final String requestUri: requestUris) { final ClassicHttpRequest request = ClassicRequestBuilder.get(requestUri) .build(); try (ClassicHttpResponse response = client.executeOpen(target, request, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); } } } @Test void test_get_connection_close() throws Exception { final CloseableHttpClient client = client(); final HttpClientContext context = context(); final String[] requestUris = new String[] { "/111", "/222", "/333" }; for (final String requestUri: requestUris) { final ClassicHttpRequest request = ClassicRequestBuilder.get(requestUri) .addHeader(HttpHeaders.CONNECTION, "close") .build(); try (ClassicHttpResponse response = client.executeOpen(target, request, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); } } } @Test void test_wrong_target_auth_scope() throws Exception { addCredentials( new AuthScope("http", "otherhost", -1, "Restricted Files", null), new UsernamePasswordCredentials("testuser", "nopassword".toCharArray())); final CloseableHttpClient client = client(); final HttpClientContext context = context(); final ClassicHttpRequest request = new HttpGet("/private/big-secret.txt"); try (ClassicHttpResponse response = client.executeOpen(target, request, context)) { Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); EntityUtils.consume(response.getEntity()); } } @Test void test_wrong_target_credentials() throws Exception { addCredentials( new AuthScope(target), new UsernamePasswordCredentials("testuser", "wrong password".toCharArray())); final CloseableHttpClient client = client(); final HttpClientContext context = context(); final ClassicHttpRequest request = new HttpGet("/private/big-secret.txt"); try (ClassicHttpResponse response = client.executeOpen(target, request, context)) { Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); EntityUtils.consume(response.getEntity()); } } @Test void test_correct_target_credentials() throws Exception { addCredentials( new AuthScope(target), new UsernamePasswordCredentials("testuser", "nopassword".toCharArray())); final CloseableHttpClient client = client(); final HttpClientContext context = context(); final ClassicHttpRequest request = new HttpGet("/private/big-secret.txt"); try (ClassicHttpResponse response = client.executeOpen(target, request, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); } } @Test void test_correct_target_credentials_no_keep_alive() throws Exception { addCredentials( new AuthScope(target), new UsernamePasswordCredentials("testuser", "nopassword".toCharArray())); final CloseableHttpClient client = client(); final HttpClientContext context = context(); final ClassicHttpRequest request = ClassicRequestBuilder.get("/private/big-secret.txt") .addHeader(HttpHeaders.CONNECTION, "close") .build(); try (ClassicHttpResponse response = client.executeOpen(target, request, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); } } } ././@LongLink0100644 0000000 0000000 00000000173 15005672016 011636 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/sync/CachingHttpClientCompatibilityTest.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/sync/CachingHttpClient0100664 0000000 0000000 00000020063 15005672016 032744 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.compatibility.sync; import org.apache.hc.client5.http.cache.CacheResponseStatus; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpOptions; import org.apache.hc.client5.http.impl.cache.CacheConfig; import org.apache.hc.client5.http.impl.cache.HeapResourceFactory; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.testing.extension.sync.CachingHttpClientResource; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; public abstract class CachingHttpClientCompatibilityTest { private final HttpHost target; @RegisterExtension private final CachingHttpClientResource clientResource; public CachingHttpClientCompatibilityTest(final HttpHost target) throws Exception { this.target = target; this.clientResource = new CachingHttpClientResource(); this.clientResource.configure(builder -> builder .setCacheConfig(CacheConfig.custom() .setMaxObjectSize(10240 * 16) .build()) .setResourceFactory(HeapResourceFactory.INSTANCE)); } CloseableHttpClient client() { return clientResource.client(); } @Test void test_options_ping() throws Exception { final CloseableHttpClient client = client(); final HttpCacheContext context = HttpCacheContext.create(); final HttpOptions options = new HttpOptions("*"); try (ClassicHttpResponse response = client.executeOpen(target, options, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); } } @Test void test_get_from_cache() throws Exception { final CloseableHttpClient client = client(); final String[] resources1 = {"/111", "/222"}; for (final String r : resources1) { final HttpCacheContext context1 = HttpCacheContext.create(); final HttpGet httpGet1 = new HttpGet(r); try (ClassicHttpResponse response = client.executeOpen(target, httpGet1, context1)) { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals(CacheResponseStatus.CACHE_MISS, context1.getCacheResponseStatus()); final ResponseCacheControl responseCacheControl = context1.getResponseCacheControl(); Assertions.assertNotNull(responseCacheControl); Assertions.assertEquals(600, responseCacheControl.getMaxAge()); final HttpCacheEntry cacheEntry = context1.getCacheEntry(); Assertions.assertNotNull(cacheEntry); EntityUtils.consume(response.getEntity()); } final HttpCacheContext context2 = HttpCacheContext.create(); final HttpGet httpGet2 = new HttpGet(r); try (ClassicHttpResponse response = client.executeOpen(target, httpGet2, context2)) { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals(CacheResponseStatus.CACHE_HIT, context2.getCacheResponseStatus()); final ResponseCacheControl responseCacheControl = context2.getResponseCacheControl(); Assertions.assertNotNull(responseCacheControl); Assertions.assertEquals(600, responseCacheControl.getMaxAge()); final HttpCacheEntry cacheEntry = context2.getCacheEntry(); Assertions.assertNotNull(cacheEntry); Assertions.assertSame(cacheEntry, context1.getCacheEntry()); EntityUtils.consume(response.getEntity()); } Thread.sleep(2000); final HttpGet httpGet3 = new HttpGet(r); final HttpCacheContext context3 = HttpCacheContext.create(); context3.setRequestCacheControl(RequestCacheControl.builder() .setMaxAge(0) .build()); try (ClassicHttpResponse response = client.executeOpen(target, httpGet3, context3)) { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals(CacheResponseStatus.VALIDATED, context3.getCacheResponseStatus()); final HttpCacheEntry cacheEntry = context3.getCacheEntry(); Assertions.assertNotNull(cacheEntry); Assertions.assertNotSame(cacheEntry, context1.getCacheEntry()); EntityUtils.consume(response.getEntity()); } } final String[] resources2 = {"/333"}; for (final String r : resources2) { final HttpCacheContext context1 = HttpCacheContext.create(); final HttpGet httpGet1 = new HttpGet(r); try (ClassicHttpResponse response = client.executeOpen(target, httpGet1, context1)) { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals(CacheResponseStatus.CACHE_MISS, context1.getCacheResponseStatus()); final ResponseCacheControl responseCacheControl = context1.getResponseCacheControl(); Assertions.assertNotNull(responseCacheControl); Assertions.assertEquals(-1, responseCacheControl.getMaxAge()); final HttpCacheEntry cacheEntry = context1.getCacheEntry(); Assertions.assertNotNull(cacheEntry); EntityUtils.consume(response.getEntity()); } final HttpCacheContext context2 = HttpCacheContext.create(); final HttpGet httpGet2 = new HttpGet(r); try (ClassicHttpResponse response = client.executeOpen(target, httpGet2, context2)) { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertEquals(CacheResponseStatus.VALIDATED, context2.getCacheResponseStatus()); final ResponseCacheControl responseCacheControl = context2.getResponseCacheControl(); Assertions.assertNotNull(responseCacheControl); Assertions.assertEquals(-1, responseCacheControl.getMaxAge()); final HttpCacheEntry cacheEntry = context2.getCacheEntry(); Assertions.assertNotNull(cacheEntry); Assertions.assertNotSame(cacheEntry, context1.getCacheEntry()); EntityUtils.consume(response.getEntity()); } } } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/ContainerImages.java0100664 0000000 0000000 00000013553 15005672016 032433 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.compatibility; import java.nio.charset.StandardCharsets; import java.util.Random; import org.apache.hc.client5.http.utils.ByteArrayBuilder; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.testcontainers.containers.GenericContainer; import org.testcontainers.containers.Network; import org.testcontainers.containers.output.Slf4jLogConsumer; import org.testcontainers.images.builder.ImageFromDockerfile; import org.testcontainers.images.builder.Transferable; public final class ContainerImages { private static final Logger LOG = LoggerFactory.getLogger(ContainerImages.class); public final static String WEB_SERVER = "test-httpd"; public final static int HTTP_PORT = 8080; public final static int HTTPS_PORT = 8443; public final static String PROXY = "test-proxy"; public final static int PROXY_PORT = 8888; public final static int PROXY_PW_PROTECTED_PORT = 8889; static final byte[] BYTES = "0123456789ABCDEF".getBytes(StandardCharsets.UTF_8); static byte[] randomData(final int max) { final Random random = new Random(); random.setSeed(System.currentTimeMillis()); final int n = random.nextInt(max); final ByteArrayBuilder builder = new ByteArrayBuilder(); for (int i = 0; i < n; i++) { builder.append(BYTES); } return builder.toByteArray(); } public static GenericContainer apacheHttpD(final Network network) { return new GenericContainer<>(new ImageFromDockerfile() .withFileFromClasspath("server-cert.pem", "docker/server-cert.pem") .withFileFromClasspath("server-key.pem", "docker/server-key.pem") .withFileFromClasspath("httpd.conf", "docker/httpd/httpd.conf") .withFileFromClasspath("httpd-ssl.conf", "docker/httpd/httpd-ssl.conf") .withFileFromTransferable("111", Transferable.of(randomData(10240))) .withFileFromTransferable("222", Transferable.of(randomData(10240))) .withFileFromTransferable("333", Transferable.of(randomData(10240))) .withDockerfileFromBuilder(builder -> builder .from("httpd:2.4") .env("httpd_home", "/usr/local/apache2") .env("var_dir", "/var/httpd") .env("www_dir", "${var_dir}/www") .env("private_dir", "${www_dir}/private") .run("mkdir ${httpd_home}/ssl") .copy("server-cert.pem", "${httpd_home}/ssl/") .copy("server-key.pem", "${httpd_home}/ssl/") .copy("httpd.conf", "${httpd_home}/conf/") .copy("httpd-ssl.conf", "${httpd_home}/conf/extra/") .copy("111", "${www_dir}/") .copy("222", "${www_dir}/") .copy("333", "${www_dir}/") .run("mkdir -p ${private_dir}") //# user: testuser; pwd: nopassword .run("echo \"testuser:{SHA}0Ybo2sSKJNARW1aNCrLJ6Lguats=\" > ${private_dir}/.htpasswd") .run("echo \"testuser:Restricted Files:73deccd22e07066db8c405e5364335f5\" > ${private_dir}/.htpasswd_digest") .run("echo \"Big Secret\" > ${private_dir}/big-secret.txt") .build())) .withNetwork(network) .withNetworkAliases(WEB_SERVER) .withLogConsumer(new Slf4jLogConsumer(LOG)) .withExposedPorts(HTTP_PORT, HTTPS_PORT); } public static GenericContainer squid(final Network network) { return new GenericContainer<>(new ImageFromDockerfile() .withFileFromClasspath("squid.conf", "docker/squid/squid.conf") .withDockerfileFromBuilder(builder -> builder .from("ubuntu/squid:5.2-22.04_beta") .env("conf_dir", "/etc/squid") .copy("squid.conf", "${conf_dir}/") //# user: squid; pwd: nopassword .run("echo \"squid:\\$apr1\\$.5saX63T\\$cMSoCJPqEfUw9br6zBdSO0\" > ${conf_dir}/htpasswd") .build())) .withNetwork(network) .withNetworkAliases(PROXY) .withLogConsumer(new Slf4jLogConsumer(LOG)) .withExposedPorts(PROXY_PORT, PROXY_PW_PROTECTED_PORT); } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/Result.java0100664 0000000 0000000 00000005062 14740035240 025761 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; public final class Result { public final HttpRequest request; public final HttpResponse response; public final T content; public final Exception exception; public enum Status { OK, NOK } public Result(final HttpRequest request, final Exception exception) { this.request = request; this.response = null; this.content = null; this.exception = exception; } public Result(final HttpRequest request, final HttpResponse response, final T content) { this.request = request; this.response = response; this.content = content; this.exception = null; } public Status getStatus() { return exception != null ? Status.NOK : Status.OK; } public boolean isOK() { return exception == null; } @Override public String toString() { final StringBuilder buf = new StringBuilder(); buf.append(request.getMethod()).append(" ").append(request.getRequestUri()); buf.append(" -> "); if (exception != null) { buf.append("NOK: ").append(exception); } else { if (response != null) { buf.append("OK: ").append(response.getCode()); } } return buf.toString(); } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/0040775 0000000 0000000 00000000000 14704162040 025653 5ustar000000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/0040775 0000000 0000000 00000000000 15063503632 026775 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000156 15063503617 011643 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/MinimalTestClientBuilder.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/MinimalTestClientBui0100664 0000000 0000000 00000011240 15063503617 032743 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.testing.SSLTestContexts; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Timeout; final class MinimalTestClientBuilder implements TestAsyncClientBuilder { private final PoolingAsyncClientConnectionManagerBuilder connectionManagerBuilder; private AsyncClientConnectionManager connectionManager; private Timeout timeout; private TlsStrategy tlsStrategy; private Http1Config http1Config; private H2Config h2Config; public MinimalTestClientBuilder() { this.connectionManagerBuilder = PoolingAsyncClientConnectionManagerBuilder.create(); } @Override public ClientProtocolLevel getProtocolLevel() { return ClientProtocolLevel.MINIMAL; } @Override public TestAsyncClientBuilder setTimeout(final Timeout timeout) { this.timeout = timeout; return this; } @Override public TestAsyncClientBuilder setConnectionManager(final AsyncClientConnectionManager connectionManager) { this.connectionManager = connectionManager; return this; } @Override public TestAsyncClientBuilder setTlsStrategy(final TlsStrategy tlsStrategy) { this.tlsStrategy = tlsStrategy; return this; } @Override public TestAsyncClientBuilder setDefaultTlsConfig(final TlsConfig tlsConfig) { this.connectionManagerBuilder.setDefaultTlsConfig(tlsConfig); return this; } @Override public TestAsyncClientBuilder useMessageMultiplexing() { this.connectionManagerBuilder.setMessageMultiplexing(true); return this; } @Override public TestAsyncClientBuilder setHttp1Config(final Http1Config http1Config) { this.http1Config = http1Config; return this; } @Override public TestAsyncClientBuilder setH2Config(final H2Config h2Config) { this.h2Config = h2Config; return this; } @Override public TestAsyncClient build() throws Exception { final AsyncClientConnectionManager connectionManagerCopy = connectionManager == null ? connectionManagerBuilder .setTlsStrategy(tlsStrategy != null ? tlsStrategy : new DefaultClientTlsStrategy(SSLTestContexts.createClientSSLContext())) .setDefaultConnectionConfig(ConnectionConfig.custom() .setSocketTimeout(timeout) .setConnectTimeout(timeout) .build()) .build() : connectionManager; final CloseableHttpAsyncClient client = HttpAsyncClients.createMinimal( h2Config, http1Config, IOReactorConfig.custom() .setSoTimeout(timeout) .build(), connectionManagerCopy); return new TestAsyncClient(client, connectionManagerCopy); } } ././@LongLink0100644 0000000 0000000 00000000151 14704162040 011626 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/ServerProtocolLevel.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/ServerProtocolLevel.0100664 0000000 0000000 00000002425 14704162040 032751 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; public enum ServerProtocolLevel { STANDARD, H2_ONLY } ././@LongLink0100644 0000000 0000000 00000000164 15005672016 011636 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/H2OnlyMinimalTestClientBuilder.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/H2OnlyMinimalTestCli0100664 0000000 0000000 00000006023 15005672016 032627 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.testing.SSLTestContexts; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Timeout; final class H2OnlyMinimalTestClientBuilder implements TestAsyncClientBuilder { private Timeout timeout; private TlsStrategy tlsStrategy; private H2Config h2Config; public H2OnlyMinimalTestClientBuilder() { } @Override public TestAsyncClientBuilder setTimeout(final Timeout timeout) { this.timeout = timeout; return this; } @Override public TestAsyncClientBuilder setTlsStrategy(final TlsStrategy tlsStrategy) { this.tlsStrategy = tlsStrategy; return this; } @Override public ClientProtocolLevel getProtocolLevel() { return ClientProtocolLevel.MINIMAL_H2_ONLY; } @Override public TestAsyncClientBuilder setH2Config(final H2Config h2Config) { this.h2Config = h2Config; return this; } @Override public TestAsyncClientBuilder useMessageMultiplexing() { return this; } @Override public TestAsyncClient build() throws Exception { final CloseableHttpAsyncClient client = HttpAsyncClients.createHttp2Minimal( h2Config, IOReactorConfig.custom() .setSoTimeout(timeout) .build(), tlsStrategy != null ? tlsStrategy : new DefaultClientTlsStrategy(SSLTestContexts.createClientSSLContext())); return new TestAsyncClient(client, null); } } ././@LongLink0100644 0000000 0000000 00000000154 15063503632 011636 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/TestAsyncClientBuilder.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/TestAsyncClientBuild0100664 0000000 0000000 00000012555 15063503632 032761 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; import java.util.Collection; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.util.Timeout; public interface TestAsyncClientBuilder { ClientProtocolLevel getProtocolLevel(); TestAsyncClientBuilder setTimeout(Timeout soTimeout); default TestAsyncClientBuilder setConnectionManager(AsyncClientConnectionManager connManager) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder addResponseInterceptorFirst(HttpResponseInterceptor interceptor) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder addResponseInterceptorLast(HttpResponseInterceptor interceptor) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder addRequestInterceptorFirst(HttpRequestInterceptor interceptor) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder addRequestInterceptorLast(HttpRequestInterceptor interceptor) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder setTlsStrategy(TlsStrategy tlsStrategy) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder setDefaultTlsConfig(TlsConfig tlsConfig) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder useMessageMultiplexing() { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder setHttp1Config(Http1Config http1Config) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder setH2Config(H2Config http1Config) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder setUserTokenHandler(UserTokenHandler userTokenHandler) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder setDefaultHeaders(Collection defaultHeaders) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder setRetryStrategy(HttpRequestRetryStrategy retryStrategy) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder setTargetAuthenticationStrategy(AuthenticationStrategy targetAuthStrategy) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder setDefaultAuthSchemeRegistry(Lookup authSchemeRegistry) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestAsyncClientBuilder setDefaultCredentialsProvider(CredentialsProvider credentialsProvider) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } TestAsyncClient build() throws Exception; } ././@LongLink0100644 0000000 0000000 00000000145 15063503617 011641 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/TestAsyncClient.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/TestAsyncClient.java0100664 0000000 0000000 00000010315 15063503617 032714 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; import java.io.IOException; import java.util.concurrent.Future; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.IOReactorStatus; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; public class TestAsyncClient extends CloseableHttpAsyncClient { private final CloseableHttpAsyncClient client; private final AsyncClientConnectionManager connectionManager; public TestAsyncClient(final CloseableHttpAsyncClient client, final AsyncClientConnectionManager connectionManager) { this.client = Args.notNull(client, "Client"); this.connectionManager = connectionManager; } @Override public void close(final CloseMode closeMode) { client.close(closeMode); } @Override public void close() throws IOException { client.close(); } @Override public void start() { client.start(); } @Override public IOReactorStatus getStatus() { return client.getStatus(); } @Override public void awaitShutdown(final TimeValue waitTime) throws InterruptedException { client.awaitShutdown(waitTime); } @Override public void initiateShutdown() { client.initiateShutdown(); } @Override protected Future doExecute(final HttpHost target, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback) { return client.execute(target, requestProducer, responseConsumer, pushHandlerFactory, context, callback); } /** * @deprecated Do not use. */ @Deprecated @Override public void register(final String hostname, final String uriPattern, final Supplier supplier) { client.register(hostname, uriPattern, supplier); } @SuppressWarnings("unchecked") public T getImplementation() { return (T) client; } @SuppressWarnings("unchecked") public T getConnectionManager() { return (T) connectionManager; } } ././@LongLink0100644 0000000 0000000 00000000157 15063503632 011641 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/StandardTestClientBuilder.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/StandardTestClientBu0100664 0000000 0000000 00000016605 15063503632 032753 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; import java.util.Collection; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.testing.SSLTestContexts; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Timeout; final class StandardTestClientBuilder implements TestAsyncClientBuilder { private final PoolingAsyncClientConnectionManagerBuilder connectionManagerBuilder; private final HttpAsyncClientBuilder clientBuilder; private AsyncClientConnectionManager connectionManager; private Timeout timeout; private TlsStrategy tlsStrategy; public StandardTestClientBuilder() { this.connectionManagerBuilder = PoolingAsyncClientConnectionManagerBuilder.create(); this.clientBuilder = HttpAsyncClientBuilder.create(); } @Override public ClientProtocolLevel getProtocolLevel() { return ClientProtocolLevel.STANDARD; } @Override public TestAsyncClientBuilder setTimeout(final Timeout timeout) { this.timeout = timeout; return this; } @Override public TestAsyncClientBuilder setConnectionManager(final AsyncClientConnectionManager connectionManager) { this.connectionManager = connectionManager; return this; } @Override public TestAsyncClientBuilder addResponseInterceptorFirst(final HttpResponseInterceptor interceptor) { this.clientBuilder.addResponseInterceptorFirst(interceptor); return this; } @Override public TestAsyncClientBuilder addResponseInterceptorLast(final HttpResponseInterceptor interceptor) { this.clientBuilder.addResponseInterceptorLast(interceptor); return this; } @Override public TestAsyncClientBuilder addRequestInterceptorFirst(final HttpRequestInterceptor interceptor) { this.clientBuilder.addRequestInterceptorFirst(interceptor); return this; } @Override public TestAsyncClientBuilder addRequestInterceptorLast(final HttpRequestInterceptor interceptor) { this.clientBuilder.addRequestInterceptorLast(interceptor); return this; } @Override public TestAsyncClientBuilder setTlsStrategy(final TlsStrategy tlsStrategy) { this.tlsStrategy = tlsStrategy; return this; } @Override public TestAsyncClientBuilder setDefaultTlsConfig(final TlsConfig tlsConfig) { this.connectionManagerBuilder.setDefaultTlsConfig(tlsConfig); return this; } @Override public TestAsyncClientBuilder useMessageMultiplexing() { this.connectionManagerBuilder.setMessageMultiplexing(true); return this; } @Override public TestAsyncClientBuilder setHttp1Config(final Http1Config http1Config) { this.clientBuilder.setHttp1Config(http1Config); return this; } @Override public TestAsyncClientBuilder setH2Config(final H2Config h2Config) { this.clientBuilder.setH2Config(h2Config); return this; } @Override public TestAsyncClientBuilder setUserTokenHandler(final UserTokenHandler userTokenHandler) { this.clientBuilder.setUserTokenHandler(userTokenHandler); return this; } @Override public TestAsyncClientBuilder setDefaultHeaders(final Collection defaultHeaders) { this.clientBuilder.setDefaultHeaders(defaultHeaders); return this; } @Override public TestAsyncClientBuilder setRetryStrategy(final HttpRequestRetryStrategy retryStrategy) { this.clientBuilder.setRetryStrategy(retryStrategy); return this; } @Override public TestAsyncClientBuilder setTargetAuthenticationStrategy(final AuthenticationStrategy targetAuthStrategy) { this.clientBuilder.setTargetAuthenticationStrategy(targetAuthStrategy); return this; } @Override public TestAsyncClientBuilder setDefaultAuthSchemeRegistry(final Lookup authSchemeRegistry) { this.clientBuilder.setDefaultAuthSchemeRegistry(authSchemeRegistry); return this; } @Override public TestAsyncClientBuilder setDefaultCredentialsProvider(final CredentialsProvider credentialsProvider) { this.clientBuilder.setDefaultCredentialsProvider(credentialsProvider); return this; } @Override public TestAsyncClient build() throws Exception { final AsyncClientConnectionManager connectionManagerCopy = connectionManager == null ? connectionManagerBuilder .setTlsStrategy(tlsStrategy != null ? tlsStrategy : new DefaultClientTlsStrategy(SSLTestContexts.createClientSSLContext())) .setDefaultConnectionConfig(ConnectionConfig.custom() .setSocketTimeout(timeout) .setConnectTimeout(timeout) .build()) .build() : connectionManager; final CloseableHttpAsyncClient client = clientBuilder .setIOReactorConfig(IOReactorConfig.custom() .setSoTimeout(timeout) .build()) .setConnectionManager(connectionManagerCopy) .build(); return new TestAsyncClient(client, connectionManagerCopy); } } ././@LongLink0100644 0000000 0000000 00000000151 14704162040 011626 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/ClientProtocolLevel.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/ClientProtocolLevel.0100664 0000000 0000000 00000002457 14704162040 032726 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; public enum ClientProtocolLevel { STANDARD, H2_ONLY, MINIMAL, MINIMAL_H2_ONLY } ././@LongLink0100644 0000000 0000000 00000000155 15005672016 011636 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/HttpAsyncClientResource.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/HttpAsyncClientResou0100664 0000000 0000000 00000007342 15005672016 033014 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; import java.io.IOException; import java.security.KeyManagementException; import java.security.KeyStoreException; import java.security.NoSuchAlgorithmException; import java.security.cert.CertificateException; import java.util.function.Consumer; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.ssl.SSLContexts; import org.junit.jupiter.api.extension.AfterEachCallback; import org.junit.jupiter.api.extension.ExtensionContext; public class HttpAsyncClientResource implements AfterEachCallback { private final HttpAsyncClientBuilder clientBuilder; private CloseableHttpAsyncClient client; public HttpAsyncClientResource(final HttpVersionPolicy versionPolicy) throws IOException { try { this.clientBuilder = HttpAsyncClients.custom() .setConnectionManager(PoolingAsyncClientConnectionManagerBuilder.create() .setTlsStrategy(new DefaultClientTlsStrategy(SSLContexts.custom() .loadTrustMaterial(getClass().getResource("/test-ca.keystore"), "nopassword".toCharArray()) .build())) .setDefaultTlsConfig(TlsConfig.custom() .setVersionPolicy(versionPolicy) .build()) .setMessageMultiplexing(true) .build()); } catch (final CertificateException | NoSuchAlgorithmException | KeyStoreException | KeyManagementException ex) { throw new IllegalStateException(ex); } } public void configure(final Consumer customizer) { customizer.accept(clientBuilder); } @Override public void afterEach(final ExtensionContext extensionContext) { if (client != null) { client.close(CloseMode.GRACEFUL); } } public CloseableHttpAsyncClient client() { if (client == null) { client = clientBuilder.build(); client.start(); } return client; } } ././@LongLink0100644 0000000 0000000 00000000164 15005672016 011636 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/CachingHttpAsyncClientResource.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/CachingHttpAsyncClie0100664 0000000 0000000 00000007265 15005672016 032715 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; import java.io.IOException; import java.security.KeyManagementException; import java.security.KeyStoreException; import java.security.NoSuchAlgorithmException; import java.security.cert.CertificateException; import java.util.function.Consumer; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.cache.CachingHttpAsyncClientBuilder; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.ssl.SSLContexts; import org.junit.jupiter.api.extension.AfterEachCallback; import org.junit.jupiter.api.extension.ExtensionContext; public class CachingHttpAsyncClientResource implements AfterEachCallback { private final CachingHttpAsyncClientBuilder clientBuilder; private CloseableHttpAsyncClient client; public CachingHttpAsyncClientResource(final HttpVersionPolicy versionPolicy) throws IOException { this.clientBuilder = CachingHttpAsyncClientBuilder.create(); try { this.clientBuilder .setConnectionManager(PoolingAsyncClientConnectionManagerBuilder.create() .setTlsStrategy(new DefaultClientTlsStrategy(SSLContexts.custom() .loadTrustMaterial(getClass().getResource("/test-ca.keystore"), "nopassword".toCharArray()) .build())) .setDefaultTlsConfig(TlsConfig.custom() .setVersionPolicy(versionPolicy) .build()) .build()); } catch (final CertificateException | NoSuchAlgorithmException | KeyStoreException | KeyManagementException ex) { throw new IllegalStateException(ex); } } public void configure(final Consumer customizer) { customizer.accept(clientBuilder); } @Override public void afterEach(final ExtensionContext extensionContext) { if (client != null) { client.close(CloseMode.GRACEFUL); } } public CloseableHttpAsyncClient client() { if (client == null) { client = clientBuilder.build(); client.start(); } return client; } } ././@LongLink0100644 0000000 0000000 00000000145 15063503632 011636 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/TestAsyncServer.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/TestAsyncServer.java0100664 0000000 0000000 00000007016 15063503632 032745 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; import java.net.InetSocketAddress; import java.util.Set; import java.util.concurrent.Future; import org.apache.hc.core5.function.Decorator; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.nio.AsyncServerExchangeHandler; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.reactor.IOReactorStatus; import org.apache.hc.core5.reactor.ListenerEndpoint; import org.apache.hc.core5.testing.nio.H2TestServer; import org.apache.hc.core5.util.TimeValue; public class TestAsyncServer { private final H2TestServer server; private final H2Config h2Config; private final Http1Config http1Config; private final HttpProcessor httpProcessor; private final Decorator exchangeHandlerDecorator; TestAsyncServer( final H2TestServer server, final H2Config h2Config, final Http1Config http1Config, final HttpProcessor httpProcessor, final Decorator exchangeHandlerDecorator) { this.server = server; this.h2Config = h2Config; this.http1Config = http1Config; this.httpProcessor = httpProcessor; this.exchangeHandlerDecorator = exchangeHandlerDecorator; } public Future listen(final InetSocketAddress address) { return server.listen(address); } public Set getEndpoints() { return server.getEndpoints(); } public IOReactorStatus getStatus() { return server.getStatus(); } public void awaitShutdown(final TimeValue waitTime) throws InterruptedException { server.awaitShutdown(waitTime); } public void initiateShutdown() { server.initiateShutdown(); } public void shutdown(final TimeValue graceTime) { server.shutdown(graceTime); } public void close() throws Exception { server.close(); } public InetSocketAddress start() throws Exception { if (http1Config != null) { server.configure(http1Config); } else { server.configure(h2Config); } server.configure(exchangeHandlerDecorator); server.configure(httpProcessor); return server.start(); } } ././@LongLink0100644 0000000 0000000 00000000156 14742456073 011651 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/TestAsyncServerBootstrap.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/TestAsyncServerBoots0100664 0000000 0000000 00000012306 14742456073 033043 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; import java.util.ArrayList; import java.util.List; import org.apache.hc.client5.testing.SSLTestContexts; import org.apache.hc.core5.function.Decorator; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.nio.AsyncServerExchangeHandler; import org.apache.hc.core5.http.nio.AsyncServerRequestHandler; import org.apache.hc.core5.http.nio.support.BasicServerExchangeHandler; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.testing.nio.H2TestServer; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Timeout; public class TestAsyncServerBootstrap { static final class HandlerEntry { final String hostname; final String uriPattern; final T handler; public HandlerEntry(final String hostname, final String uriPattern, final T handler) { this.hostname = hostname; this.uriPattern = uriPattern; this.handler = handler; } public HandlerEntry(final String uriPattern, final T handler) { this(null, uriPattern, handler); } } private final URIScheme scheme; private final ServerProtocolLevel serverProtocolLevel; private final List>> handlerList; private Timeout timeout; private HttpProcessor httpProcessor; private Decorator exchangeHandlerDecorator; public TestAsyncServerBootstrap(final URIScheme scheme, final ServerProtocolLevel serverProtocolLevel) { this.scheme = scheme != null ? scheme : URIScheme.HTTP; this.serverProtocolLevel = serverProtocolLevel != null ? serverProtocolLevel : ServerProtocolLevel.STANDARD; this.handlerList = new ArrayList<>(); } public ServerProtocolLevel getProtocolLevel() { return serverProtocolLevel; } public TestAsyncServerBootstrap register(final String uriPattern, final Supplier supplier) { Args.notNull(uriPattern, "URI pattern"); Args.notNull(supplier, "Exchange handler supplier"); handlerList.add(new HandlerEntry<>(uriPattern, supplier)); return this; } public TestAsyncServerBootstrap register( final String uriPattern, final AsyncServerRequestHandler requestHandler) { return register(uriPattern, () -> new BasicServerExchangeHandler<>(requestHandler)); } public TestAsyncServerBootstrap setTimeout(final Timeout timeout) { this.timeout = timeout; return this; } public TestAsyncServerBootstrap setHttpProcessor(final HttpProcessor httpProcessor) { this.httpProcessor = httpProcessor; return this; } public TestAsyncServerBootstrap setExchangeHandlerDecorator(final Decorator exchangeHandlerDecorator) { this.exchangeHandlerDecorator = exchangeHandlerDecorator; return this; } public TestAsyncServer build() throws Exception { final H2TestServer server = new H2TestServer( IOReactorConfig.custom() .setSoTimeout(timeout) .build(), scheme == URIScheme.HTTPS ? SSLTestContexts.createServerSSLContext() : null, null, null); for (final HandlerEntry> entry: handlerList) { server.register(entry.uriPattern, entry.handler); } return new TestAsyncServer( server, serverProtocolLevel == ServerProtocolLevel.H2_ONLY ? H2Config.DEFAULT : null, serverProtocolLevel == ServerProtocolLevel.STANDARD ? Http1Config.DEFAULT : null, httpProcessor, exchangeHandlerDecorator); } } ././@LongLink0100644 0000000 0000000 00000000155 15005672016 011636 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/H2OnlyTestClientBuilder.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/H2OnlyTestClientBuil0100664 0000000 0000000 00000012013 15005672016 032637 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; import java.util.Collection; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.H2AsyncClientBuilder; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.testing.SSLTestContexts; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Timeout; final class H2OnlyTestClientBuilder implements TestAsyncClientBuilder { private final H2AsyncClientBuilder clientBuilder; private Timeout timeout; private TlsStrategy tlsStrategy; private H2Config h2Config; public H2OnlyTestClientBuilder() { this.clientBuilder = H2AsyncClientBuilder.create(); } @Override public ClientProtocolLevel getProtocolLevel() { return ClientProtocolLevel.H2_ONLY; } @Override public TestAsyncClientBuilder setTimeout(final Timeout timeout) { this.timeout = timeout; return this; } @Override public TestAsyncClientBuilder addResponseInterceptorFirst(final HttpResponseInterceptor interceptor) { this.clientBuilder.addResponseInterceptorFirst(interceptor); return this; } @Override public TestAsyncClientBuilder addResponseInterceptorLast(final HttpResponseInterceptor interceptor) { this.clientBuilder.addResponseInterceptorLast(interceptor); return this; } @Override public TestAsyncClientBuilder addRequestInterceptorFirst(final HttpRequestInterceptor interceptor) { this.clientBuilder.addRequestInterceptorFirst(interceptor); return this; } @Override public TestAsyncClientBuilder addRequestInterceptorLast(final HttpRequestInterceptor interceptor) { this.clientBuilder.addRequestInterceptorLast(interceptor); return this; } @Override public TestAsyncClientBuilder setTlsStrategy(final TlsStrategy tlsStrategy) { this.tlsStrategy = tlsStrategy; return this; } @Override public TestAsyncClientBuilder useMessageMultiplexing() { return this; } @Override public TestAsyncClientBuilder setH2Config(final H2Config h2Config) { this.h2Config = h2Config; return this; } @Override public TestAsyncClientBuilder setDefaultHeaders(final Collection defaultHeaders) { this.clientBuilder.setDefaultHeaders(defaultHeaders); return this; } @Override public TestAsyncClientBuilder setTargetAuthenticationStrategy(final AuthenticationStrategy targetAuthStrategy) { this.clientBuilder.setTargetAuthenticationStrategy(targetAuthStrategy); return this; } @Override public TestAsyncClientBuilder setDefaultAuthSchemeRegistry(final Lookup authSchemeRegistry) { this.clientBuilder.setDefaultAuthSchemeRegistry(authSchemeRegistry); return this; } @Override public TestAsyncClient build() throws Exception { final CloseableHttpAsyncClient client = clientBuilder .setTlsStrategy(tlsStrategy != null ? tlsStrategy : new DefaultClientTlsStrategy(SSLTestContexts.createClientSSLContext())) .setIOReactorConfig(IOReactorConfig.custom() .setSoTimeout(timeout) .build()) .setH2Config(h2Config) .build(); return new TestAsyncClient(client, null); } } ././@LongLink0100644 0000000 0000000 00000000150 15063503632 011632 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/TestAsyncResources.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/async/TestAsyncResources.j0100664 0000000 0000000 00000011503 15063503632 032755 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.async; import java.util.function.Consumer; import org.apache.hc.client5.testing.extension.sync.TestClientResources; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.extension.AfterEachCallback; import org.junit.jupiter.api.extension.ExtensionContext; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class TestAsyncResources implements AfterEachCallback { private static final Logger LOG = LoggerFactory.getLogger(TestClientResources.class); private final URIScheme scheme; private final ClientProtocolLevel clientProtocolLevel; private final ServerProtocolLevel serverProtocolLevel; private final TestAsyncServerBootstrap serverBootstrap; private final TestAsyncClientBuilder clientBuilder; private TestAsyncServer server; private TestAsyncClient client; public TestAsyncResources(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel, final ServerProtocolLevel serverProtocolLevel, final Timeout timeout) { this.scheme = scheme != null ? scheme : URIScheme.HTTP; this.clientProtocolLevel = clientProtocolLevel != null ? clientProtocolLevel : ClientProtocolLevel.STANDARD; this.serverProtocolLevel = serverProtocolLevel != null ? serverProtocolLevel : ServerProtocolLevel.STANDARD; this.serverBootstrap = new TestAsyncServerBootstrap(this.scheme, this.serverProtocolLevel) .setTimeout(timeout); switch (this.clientProtocolLevel) { case STANDARD: this.clientBuilder = new StandardTestClientBuilder(); break; case H2_ONLY: this.clientBuilder = new H2OnlyTestClientBuilder(); break; case MINIMAL_H2_ONLY: this.clientBuilder = new H2OnlyMinimalTestClientBuilder(); break; case MINIMAL: this.clientBuilder = new MinimalTestClientBuilder(); break; default: this.clientBuilder = new StandardTestClientBuilder(); } this.clientBuilder.setTimeout(timeout); } @Override public void afterEach(final ExtensionContext extensionContext) { LOG.debug("Shutting down test server"); if (client != null) { client.close(CloseMode.GRACEFUL); } if (server != null) { server.shutdown(TimeValue.ofSeconds(5)); } } public URIScheme scheme() { return this.scheme; } public ServerProtocolLevel getServerProtocolLevel() { return serverProtocolLevel; } public ClientProtocolLevel getClientProtocolLevel() { return clientProtocolLevel; } public void configureServer(final Consumer serverCustomizer) { Asserts.check(server == null, "Server is already running and cannot be changed"); serverCustomizer.accept(serverBootstrap); } public TestAsyncServer server() throws Exception { if (server == null) { server = serverBootstrap.build(); } return server; } public void configureClient(final Consumer clientCustomizer) { Asserts.check(client == null, "Client is already running and cannot be changed"); clientCustomizer.accept(clientBuilder); } public TestAsyncClient client() throws Exception { if (client == null) { client = clientBuilder.build(); } return client; } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/0040775 0000000 0000000 00000000000 15063503632 026634 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000155 14704162040 011632 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/MinimalTestClientBuilder.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/MinimalTestClientBuil0100664 0000000 0000000 00000006446 14704162040 032762 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.sync; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.impl.classic.MinimalHttpClient; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.testing.SSLTestContexts; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.util.Timeout; final class MinimalTestClientBuilder implements TestClientBuilder { private Timeout timeout; private HttpClientConnectionManager connectionManager; public MinimalTestClientBuilder() { } @Override public ClientProtocolLevel getProtocolLevel() { return ClientProtocolLevel.MINIMAL; } @Override public TestClientBuilder setTimeout(final Timeout timeout) { this.timeout = timeout; return this; } @Override public TestClientBuilder setConnectionManager(final HttpClientConnectionManager connectionManager) { this.connectionManager = connectionManager; return this; } @Override public TestClient build() throws Exception { final HttpClientConnectionManager connectionManagerCopy = connectionManager != null ? connectionManager : PoolingHttpClientConnectionManagerBuilder.create() .setTlsSocketStrategy(new DefaultClientTlsStrategy(SSLTestContexts.createClientSSLContext())) .setDefaultSocketConfig(SocketConfig.custom() .setSoTimeout(timeout) .build()) .setDefaultConnectionConfig(ConnectionConfig.custom() .setConnectTimeout(timeout) .build()) .build(); final MinimalHttpClient minimalClient = HttpClients.createMinimal(connectionManagerCopy); return new TestClient(minimalClient, connectionManagerCopy); } } ././@LongLink0100644 0000000 0000000 00000000146 15063503632 011637 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/TestClientBuilder.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/TestClientBuilder.jav0100664 0000000 0000000 00000011455 15063503632 032726 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.sync; import java.util.Collection; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.util.Timeout; public interface TestClientBuilder { ClientProtocolLevel getProtocolLevel(); TestClientBuilder setTimeout(Timeout soTimeout); TestClientBuilder setConnectionManager(HttpClientConnectionManager connManager); default TestClientBuilder addResponseInterceptorFirst(HttpResponseInterceptor interceptor) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder addResponseInterceptorLast(HttpResponseInterceptor interceptor) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder addRequestInterceptorFirst(HttpRequestInterceptor interceptor) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder addRequestInterceptorLast(HttpRequestInterceptor interceptor) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder setUserTokenHandler(UserTokenHandler userTokenHandler) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder setDefaultHeaders(Collection defaultHeaders) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder setRetryStrategy(HttpRequestRetryStrategy retryStrategy) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder setTargetAuthenticationStrategy(AuthenticationStrategy targetAuthStrategy) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder setDefaultAuthSchemeRegistry(Lookup authSchemeRegistry) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder setRequestExecutor(HttpRequestExecutor requestExec) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder addExecInterceptorFirst(String name, ExecChainHandler interceptor) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder addExecInterceptorLast(String name, ExecChainHandler interceptor) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } default TestClientBuilder setDefaultCredentialsProvider(CredentialsProvider credentialsProvider) { throw new UnsupportedOperationException("Operation not supported by " + getProtocolLevel()); } TestClient build() throws Exception; } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/TestClient.java0100664 0000000 0000000 00000005527 14704162040 031556 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.sync; import java.io.IOException; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Args; public class TestClient extends CloseableHttpClient { private final CloseableHttpClient client; private final HttpClientConnectionManager connectionManager; public TestClient(final CloseableHttpClient client, final HttpClientConnectionManager connectionManager) { this.client = Args.notNull(client, "Client"); this.connectionManager = Args.notNull(connectionManager, "Connection manager"); } @Override public void close(final CloseMode closeMode) { client.close(closeMode); } @Override public void close() throws IOException { client.close(); } @Override protected CloseableHttpResponse doExecute(final HttpHost target, final ClassicHttpRequest request, final HttpContext context) throws IOException { return CloseableHttpResponse.adapt(client.executeOpen(target, request, context)); } @SuppressWarnings("unchecked") public T getImplementation() { return (T) client; } @SuppressWarnings("unchecked") public T getConnectionManager() { return (T) connectionManager; } } ././@LongLink0100644 0000000 0000000 00000000156 15063503632 011640 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/StandardTestClientBuilder.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/StandardTestClientBui0100664 0000000 0000000 00000015427 15063503632 032764 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.sync; import java.util.Collection; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.testing.SSLTestContexts; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.util.Timeout; final class StandardTestClientBuilder implements TestClientBuilder { private final HttpClientBuilder clientBuilder; private Timeout timeout; private HttpClientConnectionManager connectionManager; public StandardTestClientBuilder() { this.clientBuilder = HttpClientBuilder.create(); } @Override public ClientProtocolLevel getProtocolLevel() { return ClientProtocolLevel.STANDARD; } @Override public TestClientBuilder setTimeout(final Timeout timeout) { this.timeout = timeout; return this; } @Override public TestClientBuilder setConnectionManager(final HttpClientConnectionManager connectionManager) { this.connectionManager = connectionManager; return this; } @Override public TestClientBuilder addResponseInterceptorFirst(final HttpResponseInterceptor interceptor) { this.clientBuilder.addResponseInterceptorFirst(interceptor); return this; } @Override public TestClientBuilder addResponseInterceptorLast(final HttpResponseInterceptor interceptor) { this.clientBuilder.addResponseInterceptorLast(interceptor); return this; } @Override public TestClientBuilder addRequestInterceptorFirst(final HttpRequestInterceptor interceptor) { this.clientBuilder.addRequestInterceptorFirst(interceptor); return this; } @Override public TestClientBuilder addRequestInterceptorLast(final HttpRequestInterceptor interceptor) { this.clientBuilder.addRequestInterceptorLast(interceptor); return this; } @Override public TestClientBuilder setUserTokenHandler(final UserTokenHandler userTokenHandler) { this.clientBuilder.setUserTokenHandler(userTokenHandler); return this; } @Override public TestClientBuilder setDefaultHeaders(final Collection defaultHeaders) { this.clientBuilder.setDefaultHeaders(defaultHeaders); return this; } @Override public TestClientBuilder setRetryStrategy(final HttpRequestRetryStrategy retryStrategy) { this.clientBuilder.setRetryStrategy(retryStrategy); return this; } @Override public TestClientBuilder setTargetAuthenticationStrategy(final AuthenticationStrategy targetAuthStrategy) { this.clientBuilder.setTargetAuthenticationStrategy(targetAuthStrategy); return this; } @Override public TestClientBuilder setDefaultAuthSchemeRegistry(final Lookup authSchemeRegistry) { this.clientBuilder.setDefaultAuthSchemeRegistry(authSchemeRegistry); return this; } @Override public TestClientBuilder setRequestExecutor(final HttpRequestExecutor requestExec) { this.clientBuilder.setRequestExecutor(requestExec); return this; } @Override public TestClientBuilder addExecInterceptorFirst(final String name, final ExecChainHandler interceptor) { this.clientBuilder.addExecInterceptorFirst(name, interceptor); return this; } @Override public TestClientBuilder addExecInterceptorLast(final String name, final ExecChainHandler interceptor) { this.clientBuilder.addExecInterceptorLast(name, interceptor); return this; } @Override public TestClientBuilder setDefaultCredentialsProvider(final CredentialsProvider credentialsProvider) { this.clientBuilder.setDefaultCredentialsProvider(credentialsProvider); return this; } @Override public TestClient build() throws Exception { final HttpClientConnectionManager connectionManagerCopy = connectionManager != null ? connectionManager : PoolingHttpClientConnectionManagerBuilder.create() .setTlsSocketStrategy(new DefaultClientTlsStrategy(SSLTestContexts.createClientSSLContext())) .setDefaultSocketConfig(SocketConfig.custom() .setSoTimeout(timeout) .build()) .setDefaultConnectionConfig(ConnectionConfig.custom() .setConnectTimeout(timeout) .build()) .build(); final CloseableHttpClient client = clientBuilder .setConnectionManager(connectionManagerCopy) .build(); return new TestClient(client, connectionManagerCopy); } } ././@LongLink0100644 0000000 0000000 00000000150 14704162040 011625 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/TestServerBootstrap.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/TestServerBootstrap.j0100664 0000000 0000000 00000011042 14704162040 033001 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.sync; import java.util.ArrayList; import java.util.List; import org.apache.hc.client5.testing.SSLTestContexts; import org.apache.hc.core5.function.Decorator; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.io.HttpRequestHandler; import org.apache.hc.core5.http.io.HttpServerRequestHandler; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.testing.classic.ClassicTestServer; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Timeout; public class TestServerBootstrap { static final class HandlerEntry { final String hostname; final String uriPattern; final T handler; public HandlerEntry(final String hostname, final String uriPattern, final T handler) { this.hostname = hostname; this.uriPattern = uriPattern; this.handler = handler; } public HandlerEntry(final String uriPattern, final T handler) { this(null, uriPattern, handler); } } private final URIScheme scheme; private final List> handlerList; private Timeout timeout; private HttpProcessor httpProcessor; private Decorator exchangeHandlerDecorator; public TestServerBootstrap(final URIScheme scheme) { this.scheme = scheme != null ? scheme : URIScheme.HTTP; this.handlerList = new ArrayList<>(); } public TestServerBootstrap register(final String uriPattern, final HttpRequestHandler requestHandler) { return register(null, uriPattern, requestHandler); } public TestServerBootstrap register(final String hostname, final String uriPattern, final HttpRequestHandler requestHandler) { Args.notNull(uriPattern, "URI pattern"); Args.notNull(requestHandler, "Exchange handler"); handlerList.add(new HandlerEntry<>(hostname, uriPattern, requestHandler)); return this; } public TestServerBootstrap setTimeout(final Timeout timeout) { this.timeout = timeout; return this; } public TestServerBootstrap setHttpProcessor(final HttpProcessor httpProcessor) { this.httpProcessor = httpProcessor; return this; } public TestServerBootstrap setExchangeHandlerDecorator(final Decorator exchangeHandlerDecorator) { this.exchangeHandlerDecorator = exchangeHandlerDecorator; return this; } public TestServer build() throws Exception { final ClassicTestServer server = new ClassicTestServer( scheme == URIScheme.HTTPS ? SSLTestContexts.createServerSSLContext() : null, SocketConfig.custom() .setSoTimeout(timeout) .build()); for (final HandlerEntry entry: handlerList) { if (entry.hostname != null) { server.register(entry.hostname, entry.uriPattern, entry.handler); } else { server.register(entry.uriPattern, entry.handler); } } return new TestServer( server, Http1Config.DEFAULT, httpProcessor, exchangeHandlerDecorator); } } ././@LongLink0100644 0000000 0000000 00000000150 14704162040 011625 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/ClientProtocolLevel.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/ClientProtocolLevel.j0100664 0000000 0000000 00000002424 14704162040 032731 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.sync; public enum ClientProtocolLevel { STANDARD, MINIMAL } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/TestServer.java0100664 0000000 0000000 00000005176 15063503632 031613 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.sync; import java.io.IOException; import java.net.InetSocketAddress; import org.apache.hc.core5.function.Decorator; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.io.HttpServerRequestHandler; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.testing.classic.ClassicTestServer; public class TestServer { private final ClassicTestServer server; private final Http1Config http1Config; private final HttpProcessor httpProcessor; private final Decorator exchangeHandlerDecorator; TestServer( final ClassicTestServer server, final Http1Config http1Config, final HttpProcessor httpProcessor, final Decorator exchangeHandlerDecorator) { this.server = server; this.http1Config = http1Config; this.httpProcessor = httpProcessor; this.exchangeHandlerDecorator = exchangeHandlerDecorator; } public void shutdown(final CloseMode closeMode) { server.shutdown(closeMode); } public InetSocketAddress start() throws IOException { server.configure(http1Config); server.configure(exchangeHandlerDecorator); server.configure(httpProcessor); server.start(); return new InetSocketAddress(server.getInetAddress(), server.getPort()); } } ././@LongLink0100644 0000000 0000000 00000000156 15005672016 011637 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/CachingHttpClientResource.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/CachingHttpClientReso0100664 0000000 0000000 00000006454 15005672016 032750 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.sync; import java.io.IOException; import java.security.KeyManagementException; import java.security.KeyStoreException; import java.security.NoSuchAlgorithmException; import java.security.cert.CertificateException; import java.util.function.Consumer; import org.apache.hc.client5.http.impl.cache.CachingHttpClientBuilder; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.ssl.SSLContexts; import org.junit.jupiter.api.extension.AfterEachCallback; import org.junit.jupiter.api.extension.ExtensionContext; public class CachingHttpClientResource implements AfterEachCallback { private final CachingHttpClientBuilder clientBuilder; private CloseableHttpClient client; public CachingHttpClientResource() throws IOException { this.clientBuilder = CachingHttpClientBuilder.create(); try { this.clientBuilder .setConnectionManager(PoolingHttpClientConnectionManagerBuilder.create() .setTlsSocketStrategy(new DefaultClientTlsStrategy(SSLContexts.custom() .loadTrustMaterial(getClass().getResource("/test-ca.keystore"), "nopassword".toCharArray()) .build())) .build()); } catch (final CertificateException | NoSuchAlgorithmException | KeyStoreException | KeyManagementException ex) { throw new IllegalStateException(ex); } } public void configure(final Consumer customizer) { customizer.accept(clientBuilder); } @Override public void afterEach(final ExtensionContext extensionContext) { if (client != null) { client.close(CloseMode.GRACEFUL); } } public CloseableHttpClient client() { if (client == null) { client = clientBuilder.build(); } return client; } } ././@LongLink0100644 0000000 0000000 00000000147 15005672016 011637 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/HttpClientResource.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/HttpClientResource.ja0100664 0000000 0000000 00000006436 15005672016 032743 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.sync; import java.io.IOException; import java.security.KeyManagementException; import java.security.KeyStoreException; import java.security.NoSuchAlgorithmException; import java.security.cert.CertificateException; import java.util.function.Consumer; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.ssl.SSLContexts; import org.junit.jupiter.api.extension.AfterEachCallback; import org.junit.jupiter.api.extension.ExtensionContext; public class HttpClientResource implements AfterEachCallback { private final HttpClientBuilder clientBuilder; private CloseableHttpClient client; public HttpClientResource() throws IOException { try { this.clientBuilder = HttpClients.custom() .setConnectionManager(PoolingHttpClientConnectionManagerBuilder.create() .setTlsSocketStrategy(new DefaultClientTlsStrategy(SSLContexts.custom() .loadTrustMaterial(getClass().getResource("/test-ca.keystore"), "nopassword".toCharArray()) .build())) .build()); } catch (final CertificateException | NoSuchAlgorithmException | KeyStoreException | KeyManagementException ex) { throw new IllegalStateException(ex); } } public void configure(final Consumer customizer) { customizer.accept(clientBuilder); } @Override public void afterEach(final ExtensionContext extensionContext) { if (client != null) { client.close(CloseMode.GRACEFUL); } } public CloseableHttpClient client() { if (client == null) { client = clientBuilder.build(); } return client; } } ././@LongLink0100644 0000000 0000000 00000000150 15063503632 011632 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/TestClientResources.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/extension/sync/TestClientResources.j0100664 0000000 0000000 00000010032 15063503632 032751 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.extension.sync; import java.util.function.Consumer; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.extension.AfterEachCallback; import org.junit.jupiter.api.extension.ExtensionContext; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class TestClientResources implements AfterEachCallback { private static final Logger LOG = LoggerFactory.getLogger(TestClientResources.class); private final URIScheme scheme; private final Timeout timeout; private final ClientProtocolLevel clientProtocolLevel; private final TestServerBootstrap serverBootstrap; private final TestClientBuilder clientBuilder; private TestServer server; private TestClient client; public TestClientResources(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel, final Timeout timeout) { this.scheme = scheme != null ? scheme : URIScheme.HTTP; this.timeout = timeout; this.clientProtocolLevel = clientProtocolLevel != null ? clientProtocolLevel : ClientProtocolLevel.STANDARD; this.serverBootstrap = new TestServerBootstrap(this.scheme) .setTimeout(this.timeout); switch (this.clientProtocolLevel) { case MINIMAL: this.clientBuilder = new MinimalTestClientBuilder(); break; default: this.clientBuilder = new StandardTestClientBuilder(); } this.clientBuilder.setTimeout(timeout); } @Override public void afterEach(final ExtensionContext extensionContext) { LOG.debug("Shutting down test server"); if (client != null) { client.close(CloseMode.GRACEFUL); } if (server != null) { server.shutdown(CloseMode.IMMEDIATE); } } public URIScheme scheme() { return this.scheme; } public ClientProtocolLevel getClientProtocolLevel() { return clientProtocolLevel; } public void configureServer(final Consumer serverCustomizer) { Asserts.check(server == null, "Server is already running and cannot be changed"); serverCustomizer.accept(serverBootstrap); } public TestServer server() throws Exception { if (server == null) { server = serverBootstrap.build(); } return server; } public void configureClient(final Consumer clientCustomizer) { Asserts.check(client == null, "Client is already running and cannot be changed"); clientCustomizer.accept(clientBuilder); } public TestClient client() throws Exception { if (client == null) { client = clientBuilder.build(); } return client; } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/fluent/0040775 0000000 0000000 00000000000 14704162040 025134 5ustar000000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/fluent/TestFluent.java0100664 0000000 0000000 00000022735 14704162040 030102 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.fluent; import java.io.File; import java.net.InetSocketAddress; import java.net.URI; import java.nio.charset.StandardCharsets; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.HttpResponseException; import org.apache.hc.client5.http.fluent.Content; import org.apache.hc.client5.http.fluent.Request; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClientResources; import org.apache.hc.client5.testing.extension.sync.TestServer; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; class TestFluent { public static final Timeout TIMEOUT = Timeout.ofMinutes(1); @RegisterExtension private final TestClientResources testResources = new TestClientResources(URIScheme.HTTP, ClientProtocolLevel.STANDARD, TIMEOUT); @BeforeEach void setUp() { testResources.configureServer(bootstrap -> bootstrap .register("/", (request, response, context) -> response.setEntity(new StringEntity("All is well", ContentType.TEXT_PLAIN))) .register("/echo", (request, response, context) -> { HttpEntity responseEntity = null; final HttpEntity requestEntity = request.getEntity(); if (requestEntity != null) { final String contentTypeStr = requestEntity.getContentType(); final ContentType contentType = contentTypeStr == null ? ContentType.DEFAULT_TEXT : ContentType.parse(contentTypeStr); if (ContentType.TEXT_PLAIN.getMimeType().equals(contentType.getMimeType())) { responseEntity = new StringEntity( EntityUtils.toString(requestEntity), ContentType.TEXT_PLAIN); } } if (responseEntity == null) { responseEntity = new StringEntity("echo", ContentType.TEXT_PLAIN); } response.setEntity(responseEntity); }) // Handler for large content large message .register("/large-message", (request, response, context) -> { final String largeContent = generateLargeString(10000); // Large content string response.setEntity(new StringEntity(largeContent, ContentType.TEXT_PLAIN)); }) // Handler for large content large message with error .register("/large-message-error", (request, response, context) -> { final String largeContent = generateLargeString(10000); // Large content string response.setCode(HttpStatus.SC_REDIRECTION); response.setEntity(new StringEntity(largeContent, ContentType.TEXT_PLAIN)); })); } public HttpHost startServer() throws Exception { final TestServer server = testResources.server(); final InetSocketAddress inetSocketAddress = server.start(); return new HttpHost(testResources.scheme().id, "localhost", inetSocketAddress.getPort()); } @Test void testGetRequest() throws Exception { final HttpHost target = startServer(); final String baseURL = "http://localhost:" + target.getPort(); final String message = Request.get(baseURL + "/").execute().returnContent().asString(); Assertions.assertEquals("All is well", message); } @Test void testGetRequestByName() throws Exception { final HttpHost target = startServer(); final String baseURL = "http://localhost:" + target.getPort(); final String message = Request.create("GET", baseURL + "/").execute().returnContent().asString(); Assertions.assertEquals("All is well", message); } @Test void testGetRequestByNameWithURI() throws Exception { final HttpHost target = startServer(); final String baseURL = "http://localhost:" + target.getPort(); final String message = Request.create("GET", new URI(baseURL + "/")).execute().returnContent().asString(); Assertions.assertEquals("All is well", message); } @Test void testGetRequestFailure() throws Exception { final HttpHost target = startServer(); final String baseURL = "http://localhost:" + target.getPort(); Assertions.assertThrows(ClientProtocolException.class, () -> Request.get(baseURL + "/boom").execute().returnContent().asString()); } @Test void testPostRequest() throws Exception { final HttpHost target = startServer(); final String baseURL = "http://localhost:" + target.getPort(); final String message1 = Request.post(baseURL + "/echo") .bodyString("what is up?", ContentType.TEXT_PLAIN) .execute().returnContent().asString(); Assertions.assertEquals("what is up?", message1); final String message2 = Request.post(baseURL + "/echo") .bodyByteArray(new byte[]{1, 2, 3}, ContentType.APPLICATION_OCTET_STREAM) .execute().returnContent().asString(); Assertions.assertEquals("echo", message2); } @Test void testContentAsStringWithCharset() throws Exception { final HttpHost target = startServer(); final String baseURL = "http://localhost:" + target.getPort(); final Content content = Request.post(baseURL + "/echo").bodyByteArray("Ü".getBytes(StandardCharsets.UTF_8)).execute() .returnContent(); Assertions.assertEquals((byte)-61, content.asBytes()[0]); Assertions.assertEquals((byte)-100, content.asBytes()[1]); Assertions.assertEquals("Ü", content.asString(StandardCharsets.UTF_8)); } @Test void testConnectionRelease() throws Exception { final HttpHost target = startServer(); final String baseURL = "http://localhost:" + target.getPort(); for (int i = 0; i < 20; i++) { Request.get(baseURL + "/").execute().returnContent(); Request.get(baseURL + "/").execute().returnResponse(); Request.get(baseURL + "/").execute().discardContent(); Request.get(baseURL + "/").execute().handleResponse(response -> null); final File tmpFile = File.createTempFile("test", ".bin"); try { Request.get(baseURL + "/").execute().saveContent(tmpFile); } finally { tmpFile.delete(); } } } private String generateLargeString(final int size) { final StringBuilder sb = new StringBuilder(size); for (int i = 0; i < size; i++) { sb.append("x"); } return sb.toString(); } @Test void testLargeResponse() throws Exception { final HttpHost target = startServer(); final String baseURL = "http://localhost:" + target.getPort(); final Content content = Request.get(baseURL + "/large-message").execute().returnContent(); Assertions.assertEquals(10000, content.asBytes().length); } @Test void testLargeResponseError() throws Exception { final HttpHost target = startServer(); final String baseURL = "http://localhost:" + target.getPort(); try { Request.get(baseURL + "/large-message-error").execute().returnContent(); Assertions.fail("Expected an HttpResponseException to be thrown"); } catch (final HttpResponseException e) { // Check if the content of the exception is less than or equal to 256 bytes final byte[] contentBytes = e.getContentBytes(); Assertions.assertNotNull(contentBytes, "Content bytes should not be null"); Assertions.assertTrue(contentBytes.length <= 256, "Content length should be less or equal to 256 bytes"); } } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/SSLTestContexts.java0100664 0000000 0000000 00000004024 14666635064 027552 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing; import javax.net.ssl.SSLContext; import org.apache.hc.core5.ssl.SSLContexts; public class SSLTestContexts { public static SSLContext createServerSSLContext() throws Exception { return SSLContexts.custom() .loadTrustMaterial(SSLTestContexts.class.getResource("/test.keystore"), "nopassword".toCharArray()) .loadKeyMaterial(SSLTestContexts.class.getResource("/test.keystore"), "nopassword".toCharArray(), "nopassword".toCharArray()) .build(); } public static SSLContext createClientSSLContext() throws Exception { return SSLContexts.custom() .loadTrustMaterial(SSLTestContexts.class.getResource("/test.keystore"), "nopassword".toCharArray()) .build(); } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/0040775 0000000 0000000 00000000000 15063503637 024625 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000146 14704162040 011632 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/HttpMinimalIntegrationTests.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/HttpMinimalIntegrationTests.jav0100664 0000000 0000000 00000003466 14704162040 033000 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import org.apache.hc.core5.http.URIScheme; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Nested; class HttpMinimalIntegrationTests { @Nested @DisplayName("Request execution (HTTP/1.1)") class RequestExecution extends TestMinimalClientRequestExecution { public RequestExecution() { super(URIScheme.HTTP); } } @Nested @DisplayName("Request execution (HTTP/1.1, TLS)") class RequestExecutionTls extends TestMinimalClientRequestExecution { public RequestExecutionTls() { super(URIScheme.HTTPS); } } }././@LongLink0100644 0000000 0000000 00000000154 15005672016 011635 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestFutureRequestExecutionService.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestFutureRequestExecutionServi0100664 0000000 0000000 00000017527 15005672016 033133 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import static org.hamcrest.MatcherAssert.assertThat; import java.util.LinkedList; import java.util.Queue; import java.util.concurrent.CancellationException; 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.FutureTask; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicBoolean; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.FutureRequestExecutionService; import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.impl.bootstrap.HttpServer; import org.apache.hc.core5.http.impl.bootstrap.ServerBootstrap; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; @SuppressWarnings("boxing") // test code class TestFutureRequestExecutionService { private HttpServer localServer; private String uri; private FutureRequestExecutionService httpAsyncClientWithFuture; private final AtomicBoolean blocked = new AtomicBoolean(false); @BeforeEach void before() throws Exception { this.localServer = ServerBootstrap.bootstrap() .setCanonicalHostName("localhost") .register("/wait", (request, response, context) -> { try { while (blocked.get()) { Thread.sleep(10); } } catch (final InterruptedException e) { throw new IllegalStateException(e); } response.setCode(200); }).create(); this.localServer.start(); uri = "http://localhost:" + this.localServer.getLocalPort() + "/wait"; final HttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create() .setMaxConnPerRoute(5) .build(); final CloseableHttpClient httpClient = HttpClientBuilder.create() .setConnectionManager(cm) .build(); final ExecutorService executorService = Executors.newFixedThreadPool(5); httpAsyncClientWithFuture = new FutureRequestExecutionService(httpClient, executorService); } @AfterEach void after() throws Exception { blocked.set(false); // any remaining requests should unblock this.localServer.stop(); httpAsyncClientWithFuture.close(); } @Test void shouldExecuteSingleCall() throws InterruptedException, ExecutionException { final FutureTask task = httpAsyncClientWithFuture.execute( new HttpGet(uri), HttpClientContext.create(), new OkidokiHandler()); Assertions.assertTrue(task.get(), "request should have returned OK"); } @Test @Disabled("Fails intermittently with GitHub Actions. Needs to be revised") void shouldCancel() { final FutureTask task = httpAsyncClientWithFuture.execute( new HttpGet(uri), HttpClientContext.create(), new OkidokiHandler()); task.cancel(true); final Exception exception = Assertions.assertThrows(Exception.class, task::get); assertThat(exception, CoreMatchers.anyOf( CoreMatchers.instanceOf(CancellationException.class), CoreMatchers.instanceOf(ExecutionException.class))); } @Test void shouldTimeout() { blocked.set(true); final FutureTask task = httpAsyncClientWithFuture.execute( new HttpGet(uri), HttpClientContext.create(), new OkidokiHandler()); Assertions.assertThrows(TimeoutException.class, () -> task.get(10, TimeUnit.MILLISECONDS)); } @Test void shouldExecuteMultipleCalls() throws Exception { final int reqNo = 100; final Queue> tasks = new LinkedList<>(); for (int i = 0; i < reqNo; i++) { final Future task = httpAsyncClientWithFuture.execute( new HttpGet(uri), HttpClientContext.create(), new OkidokiHandler()); tasks.add(task); } for (final Future task : tasks) { final Boolean b = task.get(); Assertions.assertNotNull(b); Assertions.assertTrue(b, "request should have returned OK"); } } @Test void shouldExecuteMultipleCallsAndCallback() throws Exception { final int reqNo = 100; final Queue> tasks = new LinkedList<>(); final CountDownLatch latch = new CountDownLatch(reqNo); for (int i = 0; i < reqNo; i++) { final Future task = httpAsyncClientWithFuture.execute( new HttpGet(uri), HttpClientContext.create(), new OkidokiHandler(), new CountingCallback(latch)); tasks.add(task); } Assertions.assertTrue(latch.await(5, TimeUnit.SECONDS)); for (final Future task : tasks) { final Boolean b = task.get(); Assertions.assertNotNull(b); Assertions.assertTrue(b, "request should have returned OK"); } } private static final class CountingCallback implements FutureCallback { private final CountDownLatch latch; CountingCallback(final CountDownLatch latch) { super(); this.latch = latch; } @Override public void failed(final Exception ex) { latch.countDown(); } @Override public void completed(final Boolean result) { latch.countDown(); } @Override public void cancelled() { latch.countDown(); } } private static final class OkidokiHandler implements HttpClientResponseHandler { @Override public Boolean handleResponse( final ClassicHttpResponse response) { return response.getCode() == 200; } } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/HttpIntegrationTests.java0100664 0000000 0000000 00000006634 15034167313 031637 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import org.apache.hc.core5.http.URIScheme; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Nested; class HttpIntegrationTests { @Nested @DisplayName("Request execution (HTTP/1.1)") class RequestExecution extends TestClientRequestExecution { public RequestExecution() { super(URIScheme.HTTP); } } @Nested @DisplayName("Request execution (HTTP/1.1, TLS)") class RequestExecutionTls extends TestClientRequestExecution { public RequestExecutionTls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("Authentication (HTTP/1.1)") class Authentication extends TestClientAuthentication { public Authentication() { super(URIScheme.HTTP); } } @Nested @DisplayName("Authentication (HTTP/1.1, TLS)") class AuthenticationTls extends TestClientAuthentication { public AuthenticationTls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("Content coding (HTTP/1.1)") class ContentCoding extends TestContentCodings { public ContentCoding() { super(URIScheme.HTTP); } } @Nested @DisplayName("Content coding (HTTP/1.1, TLS)") class ContentCodingTls extends TestContentCodings { public ContentCodingTls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("Redirects (HTTP/1.1)") class Redirects extends TestRedirects { public Redirects() { super(URIScheme.HTTP); } } @Nested @DisplayName("Redirects (HTTP/1.1, TLS)") class RedirectsTls extends TestRedirects { public RedirectsTls() { super(URIScheme.HTTPS); } } @Nested @DisplayName("Request re-execution (HTTP/1.1)") class RequestReExecution extends TestClientRequestReExecution { public RequestReExecution() { super(URIScheme.HTTP); } } @Nested @DisplayName("Request re-execution (HTTP/1.1)") class RequestReExecutionTls extends TestClientRequestReExecution { public RequestReExecutionTls() { super(URIScheme.HTTPS); } } }httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestConnectionManagement.java0100664 0000000 0000000 00000040610 15063503637 032422 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import java.io.IOException; import java.util.concurrent.TimeoutException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.impl.ConnectionHolder; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.io.ConnectionEndpoint; import org.apache.hc.client5.http.io.LeaseRequest; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.classic.RandomHandler; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpClientConnection; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.RequestConnControl; import org.apache.hc.core5.http.protocol.RequestContent; import org.apache.hc.core5.http.protocol.RequestTargetHost; import org.apache.hc.core5.pool.PoolConcurrencyPolicy; import org.apache.hc.core5.pool.PoolReusePolicy; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; /** * Tests for {@code PoolingHttpClientConnectionManager} that do require a server * to communicate with. */ class TestConnectionManagement extends AbstractIntegrationTestBase { public TestConnectionManagement() { super(URIScheme.HTTP, ClientProtocolLevel.STANDARD); } ConnectionEndpoint.RequestExecutor exec; @BeforeEach void setup() { exec = new ConnectionEndpoint.RequestExecutor() { final HttpRequestExecutor requestExecutor = new HttpRequestExecutor(); final HttpProcessor httpProcessor = new DefaultHttpProcessor( new RequestTargetHost(), new RequestContent(), new RequestConnControl()); @Override public ClassicHttpResponse execute(final ClassicHttpRequest request, final HttpClientConnection conn, final HttpContext context) throws IOException, HttpException { requestExecutor.preProcess(request, httpProcessor, context); final ClassicHttpResponse response = requestExecutor.execute(request, conn, context); requestExecutor.postProcess(response, httpProcessor, context); return response; } }; } /** * Tests releasing and re-using a connection after a response is read. */ @Test void testReleaseConnection() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(1); final HttpRoute route = new HttpRoute(target, null, false); final int rsplen = 8; final String uri = "/random/" + rsplen; final ClassicHttpRequest request = new BasicClassicHttpRequest("GET", target, uri); final HttpClientContext context = HttpClientContext.create(); final LeaseRequest leaseRequest1 = connManager.lease("id1", route, null); final ConnectionEndpoint endpoint1 = leaseRequest1.get(Timeout.ZERO_MILLISECONDS); connManager.connect(endpoint1, null, context); try (final ClassicHttpResponse response1 = endpoint1.execute("id1", request, exec, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response1.getCode()); } // check that there is no auto-release by default // this should fail quickly, connection has not been released final LeaseRequest leaseRequest2 = connManager.lease("id2", route, null); Assertions.assertThrows(TimeoutException.class, () -> leaseRequest2.get(Timeout.ofMilliseconds(10))); // close and release the connection // expect the next connection obtained to be closed endpoint1.close(); connManager.release(endpoint1, null, TimeValue.NEG_ONE_MILLISECOND); final LeaseRequest leaseRequest3 = connManager.lease("id2", route, null); final ConnectionEndpoint endpoint2 = leaseRequest3.get(Timeout.ZERO_MILLISECONDS); Assertions.assertFalse(endpoint2.isConnected()); connManager.connect(endpoint2, null, context); try (final ClassicHttpResponse response2 = endpoint2.execute("id2", request, exec, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode()); } // release connection keeping it open // expect the next connection obtained to be open connManager.release(endpoint2, null, TimeValue.NEG_ONE_MILLISECOND); final LeaseRequest leaseRequest4 = connManager.lease("id3", route, null); final ConnectionEndpoint endpoint3 = leaseRequest4.get(Timeout.ZERO_MILLISECONDS); Assertions.assertTrue(endpoint3.isConnected()); // repeat the communication, no need to prepare the request again try (final ClassicHttpResponse response3 = endpoint3.execute("id3", request, exec, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response3.getCode()); } connManager.release(endpoint3, null, TimeValue.NEG_ONE_MILLISECOND); connManager.close(); } /** * Tests releasing with time limits. */ @Test void testReleaseConnectionWithTimeLimits() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(1); final HttpRoute route = new HttpRoute(target, null, false); final int rsplen = 8; final String uri = "/random/" + rsplen; final ClassicHttpRequest request = new BasicClassicHttpRequest("GET", target, uri); final HttpClientContext context = HttpClientContext.create(); final LeaseRequest leaseRequest1 = connManager.lease("id1", route, null); final ConnectionEndpoint endpoint1 = leaseRequest1.get(Timeout.ZERO_MILLISECONDS); connManager.connect(endpoint1, null, context); try (final ClassicHttpResponse response1 = endpoint1.execute("id1", request, exec, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response1.getCode()); } // check that there is no auto-release by default final LeaseRequest leaseRequest2 = connManager.lease("id2", route, null); // this should fail quickly, connection has not been released Assertions.assertThrows(TimeoutException.class, () -> leaseRequest2.get(Timeout.ofMilliseconds(10))); endpoint1.close(); connManager.release(endpoint1, null, TimeValue.ofMilliseconds(100)); final LeaseRequest leaseRequest3 = connManager.lease("id2", route, null); final ConnectionEndpoint endpoint2 = leaseRequest3.get(Timeout.ZERO_MILLISECONDS); Assertions.assertFalse(endpoint2.isConnected()); connManager.connect(endpoint2, null, context); try (final ClassicHttpResponse response2 = endpoint2.execute("id2", request, exec, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode()); } connManager.release(endpoint2, null, TimeValue.ofMilliseconds(100)); final LeaseRequest leaseRequest4 = connManager.lease("id3", route, null); final ConnectionEndpoint endpoint3 = leaseRequest4.get(Timeout.ZERO_MILLISECONDS); Assertions.assertTrue(endpoint3.isConnected()); // repeat the communication, no need to prepare the request again try (final ClassicHttpResponse response3 = endpoint3.execute("id3", request, exec, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response3.getCode()); } connManager.release(endpoint3, null, TimeValue.ofMilliseconds(100)); Thread.sleep(150); final LeaseRequest leaseRequest5 = connManager.lease("id4", route, null); final ConnectionEndpoint endpoint4 = leaseRequest5.get(Timeout.ZERO_MILLISECONDS); Assertions.assertFalse(endpoint4.isConnected()); // repeat the communication, no need to prepare the request again connManager.connect(endpoint4, null, context); try (final ClassicHttpResponse response4 = endpoint4.execute("id4", request, exec, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response4.getCode()); } connManager.close(); } @Test void testCloseExpiredIdleConnections() throws Exception { final HttpHost target = startServer(); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(1); final HttpRoute route = new HttpRoute(target, null, false); final HttpClientContext context = HttpClientContext.create(); final LeaseRequest leaseRequest1 = connManager.lease("id1", route, null); final ConnectionEndpoint endpoint1 = leaseRequest1.get(Timeout.ZERO_MILLISECONDS); connManager.connect(endpoint1, null, context); Assertions.assertEquals(1, connManager.getTotalStats().getLeased()); Assertions.assertEquals(1, connManager.getStats(route).getLeased()); connManager.release(endpoint1, null, TimeValue.ofMilliseconds(100)); // Released, still active. Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(1, connManager.getStats(route).getAvailable()); connManager.closeExpired(); // Time has not expired yet. Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(1, connManager.getStats(route).getAvailable()); Thread.sleep(150); connManager.closeExpired(); // Time expired now, connections are destroyed. Assertions.assertEquals(0, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(0, connManager.getStats(route).getAvailable()); connManager.close(); } @Test void testCloseExpiredTTLConnections() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); configureClient(builder -> builder .setConnectionManager(PoolingHttpClientConnectionManagerBuilder.create() .setPoolConcurrencyPolicy(PoolConcurrencyPolicy.STRICT) .setConnPoolPolicy(PoolReusePolicy.LIFO) .setDefaultConnectionConfig(ConnectionConfig.custom() .setTimeToLive(TimeValue.ofMilliseconds(100)) .build()) .build())); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(1); final HttpRoute route = new HttpRoute(target, null, false); final HttpClientContext context = HttpClientContext.create(); final LeaseRequest leaseRequest1 = connManager.lease("id1", route, null); final ConnectionEndpoint endpoint1 = leaseRequest1.get(Timeout.ZERO_MILLISECONDS); connManager.connect(endpoint1, null, context); Assertions.assertEquals(1, connManager.getTotalStats().getLeased()); Assertions.assertEquals(1, connManager.getStats(route).getLeased()); // Release, let remain idle for forever connManager.release(endpoint1, null, TimeValue.NEG_ONE_MILLISECOND); // Released, still active. Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(1, connManager.getStats(route).getAvailable()); connManager.closeExpired(); // Time has not expired yet. Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(1, connManager.getStats(route).getAvailable()); Thread.sleep(150); connManager.closeExpired(); // TTL expired now, connections are destroyed. Assertions.assertEquals(0, connManager.getTotalStats().getAvailable()); Assertions.assertEquals(0, connManager.getStats(route).getAvailable()); connManager.close(); } @Test void testConnectionTimeoutSetting() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final Timeout connectionSocketTimeout = Timeout.ofMinutes(5); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(1); connManager.setDefaultConnectionConfig(ConnectionConfig.custom() .setSocketTimeout(connectionSocketTimeout) .build()); final HttpRoute route = new HttpRoute(target, null, false); final int rsplen = 8; final String uri = "/random/" + rsplen; final ClassicHttpRequest request = new BasicClassicHttpRequest("GET", target, uri); final HttpClientContext context = HttpClientContext.create(); final LeaseRequest leaseRequest1 = connManager.lease("id1", route, null); final ConnectionEndpoint endpoint1 = leaseRequest1.get(Timeout.ZERO_MILLISECONDS); connManager.connect(endpoint1, null, context); // Modify socket timeout of the endpoint endpoint1.setSocketTimeout(Timeout.ofSeconds(30)); try (final ClassicHttpResponse response1 = endpoint1.execute("id1", request, exec, context)) { Assertions.assertEquals(HttpStatus.SC_OK, response1.getCode()); } connManager.release(endpoint1, null, TimeValue.NEG_ONE_MILLISECOND); final LeaseRequest leaseRequest2 = connManager.lease("id2", route, null); final ConnectionEndpoint endpoint2 = leaseRequest2.get(Timeout.ZERO_MILLISECONDS); Assertions.assertTrue(endpoint2.isConnected()); final HttpConnection connection = ((ConnectionHolder) endpoint2).get(); Assertions.assertEquals(connectionSocketTimeout, connection.getSocketTimeout()); connManager.close(); } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestContentCodings.java0100664 0000000 0000000 00000041544 15063503632 031251 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.OutputStream; import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.Iterator; import java.util.List; import java.util.concurrent.CountDownLatch; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.zip.Deflater; import java.util.zip.GZIPOutputStream; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.BasicHttpClientResponseHandler; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.HttpRequestHandler; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.message.MessageSupport; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Test case for how Content Codings are processed. By default, we want to do the right thing and * require no intervention from the user of HttpClient, but we still want to let clients do their * own thing if they so wish. */ abstract class TestContentCodings extends AbstractIntegrationTestBase { protected TestContentCodings(final URIScheme scheme) { super(scheme, ClientProtocolLevel.STANDARD); } /** * Test for when we don't get an entity back; e.g. for a 204 or 304 response; nothing blows * up with the new behaviour. * * @throws Exception * if there was a problem */ @Test void testResponseWithNoContent() throws Exception { configureServer(bootstrap -> bootstrap .register("*", (request, response, context) -> response.setCode(HttpStatus.SC_NO_CONTENT))); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet request = new HttpGet("/some-resource"); client.execute(target, request, response -> { Assertions.assertEquals(HttpStatus.SC_NO_CONTENT, response.getCode()); Assertions.assertNull(response.getEntity()); return null; }); } /** * Test for when we are handling content from a server that has correctly interpreted RFC2616 * to return RFC1950 streams for {@code deflate} content coding. * * @throws Exception */ @Test void testDeflateSupportForServerReturningRfc1950Stream() throws Exception { final String entityText = "Hello, this is some plain text coming back."; configureServer(bootstrap -> bootstrap .register("*", createDeflateEncodingRequestHandler(entityText, false))); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet request = new HttpGet("/some-resource"); client.execute(target, request, response -> { Assertions.assertEquals(entityText, EntityUtils.toString(response.getEntity()), "The entity text is correctly transported"); return null; }); } /** * Test for when we are handling content from a server that has incorrectly interpreted RFC2616 * to return RFC1951 streams for {@code deflate} content coding. * * @throws Exception */ @Test void testDeflateSupportForServerReturningRfc1951Stream() throws Exception { final String entityText = "Hello, this is some plain text coming back."; configureServer(bootstrap -> bootstrap .register("*", createDeflateEncodingRequestHandler(entityText, true))); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet request = new HttpGet("/some-resource"); client.execute(target, request, response -> { Assertions.assertEquals(entityText, EntityUtils.toString(response.getEntity()), "The entity text is correctly transported"); return null; }); } /** * Test for a server returning gzipped content. * * @throws Exception */ @Test void testGzipSupport() throws Exception { final String entityText = "Hello, this is some plain text coming back."; configureServer(bootstrap -> bootstrap .register("*", createGzipEncodingRequestHandler(entityText))); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet request = new HttpGet("/some-resource"); client.execute(target, request, response -> { Assertions.assertEquals(entityText, EntityUtils.toString(response.getEntity()), "The entity text is correctly transported"); return null; }); } /** * Try with a bunch of client threads, to check that it's thread-safe. * * @throws Exception * if there was a problem */ @Test void testThreadSafetyOfContentCodings() throws Exception { final String entityText = "Hello, this is some plain text coming back."; configureServer(bootstrap -> bootstrap .register("*", createGzipEncodingRequestHandler(entityText))); final HttpHost target = startServer(); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); /* * Create a load of workers which will access the resource. Half will use the default * gzip behaviour; half will require identity entity. */ final int clients = 10; connManager.setMaxTotal(clients); final ExecutorService executor = Executors.newFixedThreadPool(clients); final CountDownLatch startGate = new CountDownLatch(1); final CountDownLatch endGate = new CountDownLatch(clients); final List workers = new ArrayList<>(); for (int i = 0; i < clients; ++i) { workers.add(new WorkerTask(client, target, i % 2 == 0, startGate, endGate)); } for (final WorkerTask workerTask : workers) { /* Set them all in motion, but they will block until we call startGate.countDown(). */ executor.execute(workerTask); } startGate.countDown(); /* Wait for the workers to complete. */ endGate.await(); for (final WorkerTask workerTask : workers) { if (workerTask.isFailed()) { Assertions.fail("A worker failed"); } Assertions.assertEquals(entityText, workerTask.getText()); } } @Test void testHttpEntityWriteToForGzip() throws Exception { final String entityText = "Hello, this is some plain text coming back."; configureServer(bootstrap -> bootstrap .register("*", createGzipEncodingRequestHandler(entityText))); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet request = new HttpGet("/some-resource"); client.execute(target, request, response -> { final ByteArrayOutputStream out = new ByteArrayOutputStream(); response.getEntity().writeTo(out); Assertions.assertEquals(entityText, out.toString("utf-8")); return null; }); } @Test void testHttpEntityWriteToForDeflate() throws Exception { final String entityText = "Hello, this is some plain text coming back."; configureServer(bootstrap -> bootstrap .register("*", createDeflateEncodingRequestHandler(entityText, true))); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet request = new HttpGet("/some-resource"); client.execute(target, request, response -> { final ByteArrayOutputStream out = new ByteArrayOutputStream(); response.getEntity().writeTo(out); Assertions.assertEquals(entityText, out.toString("utf-8")); return out; }); } @Test void gzipResponsesWorkWithBasicResponseHandler() throws Exception { final String entityText = "Hello, this is some plain text coming back."; configureServer(bootstrap -> bootstrap .register("*", createGzipEncodingRequestHandler(entityText))); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet request = new HttpGet("/some-resource"); final String response = client.execute(target, request, new BasicHttpClientResponseHandler()); Assertions.assertEquals(entityText, response, "The entity text is correctly transported"); } @Test void deflateResponsesWorkWithBasicResponseHandler() throws Exception { final String entityText = "Hello, this is some plain text coming back."; configureServer(bootstrap -> bootstrap .register("*", createDeflateEncodingRequestHandler(entityText, false))); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet request = new HttpGet("/some-resource"); final String response = client.execute(target, request, new BasicHttpClientResponseHandler()); Assertions.assertEquals(entityText, response, "The entity text is correctly transported"); } /** * Creates a new {@link HttpRequestHandler} that will attempt to provide a deflate stream * Content-Coding. * * @param entityText * the non-null String entity text to be returned by the server * @param rfc1951 * if true, then the stream returned will be a raw RFC1951 deflate stream, which * some servers return as a result of misinterpreting the HTTP 1.1 RFC. If false, * then it will return an RFC2616 compliant deflate encoded zlib stream. * @return a non-null {@link HttpRequestHandler} */ private HttpRequestHandler createDeflateEncodingRequestHandler( final String entityText, final boolean rfc1951) { return (request, response, context) -> { response.setEntity(new StringEntity(entityText)); response.addHeader("Content-Type", "text/plain"); final Iterator it = MessageSupport.iterate(request, "Accept-Encoding"); while (it.hasNext()) { final HeaderElement element = it.next(); if ("deflate".equalsIgnoreCase(element.getName())) { response.addHeader("Content-Encoding", "deflate"); /* Gack. DeflaterInputStream is Java 6. */ // response.setEntity(new InputStreamEntity(new DeflaterInputStream(new // ByteArrayInputStream( // entityText.getBytes("utf-8"))), -1)); final byte[] uncompressed = entityText.getBytes(StandardCharsets.UTF_8); final Deflater compressor = new Deflater(Deflater.DEFAULT_COMPRESSION, rfc1951); compressor.setInput(uncompressed); compressor.finish(); final byte[] output = new byte[100]; final int compressedLength = compressor.deflate(output); final byte[] compressed = new byte[compressedLength]; System.arraycopy(output, 0, compressed, 0, compressedLength); response.setEntity(new InputStreamEntity( new ByteArrayInputStream(compressed), compressedLength, null)); return; } } }; } /** * Returns an {@link HttpRequestHandler} implementation that will attempt to provide a gzip * Content-Encoding. * * @param entityText * the non-null String entity to be returned by the server * @return a non-null {@link HttpRequestHandler} */ private HttpRequestHandler createGzipEncodingRequestHandler(final String entityText) { return (request, response, context) -> { response.setEntity(new StringEntity(entityText)); response.addHeader("Content-Type", "text/plain"); response.addHeader("Content-Type", "text/plain"); final Iterator it = MessageSupport.iterate(request, "Accept-Encoding"); while (it.hasNext()) { final HeaderElement element = it.next(); if ("gzip".equalsIgnoreCase(element.getName())) { response.addHeader("Content-Encoding", "gzip"); /* * We have to do a bit more work with gzip versus deflate, since * Gzip doesn't appear to have an equivalent to DeflaterInputStream in * the JDK. * * UPDATE: DeflaterInputStream is Java 6 anyway, so we have to do a bit * of work there too! */ final ByteArrayOutputStream bytes = new ByteArrayOutputStream(); final OutputStream out = new GZIPOutputStream(bytes); final ByteArrayInputStream uncompressed = new ByteArrayInputStream( entityText.getBytes(StandardCharsets.UTF_8)); final byte[] buf = new byte[60]; int n; while ((n = uncompressed.read(buf)) != -1) { out.write(buf, 0, n); } out.close(); final byte[] arr = bytes.toByteArray(); response.setEntity(new InputStreamEntity(new ByteArrayInputStream(arr), arr.length, null)); return; } } }; } /** * Sub-ordinate task passed off to a different thread to be executed. * * @author jabley * */ class WorkerTask implements Runnable { private final CloseableHttpClient client; private final HttpHost target; private final HttpGet request; private final CountDownLatch startGate; private final CountDownLatch endGate; private boolean failed; private String text; WorkerTask(final CloseableHttpClient client, final HttpHost target, final boolean identity, final CountDownLatch startGate, final CountDownLatch endGate) { this.client = client; this.target = target; this.request = new HttpGet("/some-resource"); if (identity) { request.addHeader("Accept-Encoding", "identity"); } this.startGate = startGate; this.endGate = endGate; } /** * Returns the text of the HTTP entity. * * @return a String - may be null. */ public String getText() { return this.text; } /** * {@inheritDoc} */ @Override public void run() { try { startGate.await(); try { text = client.execute(target, request, response -> EntityUtils.toString(response.getEntity())); } catch (final Exception e) { failed = true; } finally { endGate.countDown(); } } catch (final InterruptedException ignore) { } } /** * Returns true if this task failed, otherwise false. * * @return a flag */ boolean isFailed() { return this.failed; } } } ././@LongLink0100644 0000000 0000000 00000000154 15005672016 011635 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestMinimalClientRequestExecution.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestMinimalClientRequestExecuti0100664 0000000 0000000 00000011376 15005672016 033034 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import java.util.HashSet; import java.util.Locale; import java.util.Set; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.HttpRequestHandler; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.protocol.HttpContext; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Client protocol handling tests. */ abstract class TestMinimalClientRequestExecution extends AbstractIntegrationTestBase { protected TestMinimalClientRequestExecution(final URIScheme scheme) { super(scheme, ClientProtocolLevel.MINIMAL); } private static class SimpleService implements HttpRequestHandler { public SimpleService() { super(); } @Override public void handle( final ClassicHttpRequest request, final ClassicHttpResponse response, final HttpContext context) { response.setCode(HttpStatus.SC_OK); final StringEntity entity = new StringEntity("Whatever"); response.setEntity(entity); } } @Test void testNonCompliantURIWithContext() throws Exception { configureServer(bootstrap -> bootstrap.register("*", new SimpleService())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); for (int i = 0; i < 10; i++) { final HttpGet request = new HttpGet("/"); client.execute(target, request, context, response -> { EntityUtils.consume(response.getEntity()); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertNotNull(reqWrapper); final Header[] headers = reqWrapper.getHeaders(); final Set headerSet = new HashSet<>(); for (final Header header: headers) { headerSet.add(header.getName().toLowerCase(Locale.ROOT)); } Assertions.assertEquals(3, headerSet.size()); Assertions.assertTrue(headerSet.contains("connection")); Assertions.assertTrue(headerSet.contains("host")); Assertions.assertTrue(headerSet.contains("user-agent")); } } @Test void testNonCompliantURIWithoutContext() throws Exception { configureServer(bootstrap -> bootstrap.register("*", new SimpleService())); final HttpHost target = startServer(); final TestClient client = client(); for (int i = 0; i < 10; i++) { final HttpGet request = new HttpGet("/"); client.execute(target, request, response -> { EntityUtils.consume(response.getEntity()); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); return null; }); } } } ././@LongLink0100644 0000000 0000000 00000000145 14704162040 011631 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestIdleConnectionEviction.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestIdleConnectionEviction.java0100664 0000000 0000000 00000011754 14704162040 032721 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import java.net.URI; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.IdleConnectionEvictor; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.testing.classic.RandomHandler; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.Test; class TestIdleConnectionEviction extends AbstractIntegrationTestBase { public TestIdleConnectionEviction() { super(URIScheme.HTTP, ClientProtocolLevel.STANDARD); } @Test void testIdleConnectionEviction() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setDefaultMaxPerRoute(10); connManager.setMaxTotal(50); final IdleConnectionEvictor idleConnectionMonitor = new IdleConnectionEvictor(connManager, TimeValue.ofMilliseconds(50)); idleConnectionMonitor.start(); final URI requestUri = new URI("/random/1024"); final WorkerThread[] workers = new WorkerThread[5]; for (int i = 0; i < workers.length; i++) { workers[i] = new WorkerThread(client, target, requestUri, 200); } for (final WorkerThread worker : workers) { worker.start(); } for (final WorkerThread worker : workers) { worker.join(); final Exception ex = worker.getException(); if (ex != null) { throw ex; } } idleConnectionMonitor.shutdown(); } static class WorkerThread extends Thread { private final CloseableHttpClient httpclient; private final HttpHost target; private final URI requestUri; private final int count; private volatile Exception ex; public WorkerThread( final CloseableHttpClient httpclient, final HttpHost target, final URI requestUri, final int count) { super(); this.httpclient = httpclient; this.target = target; this.requestUri = requestUri; this.count = count; } @Override public void run() { try { for (int i = 0; i < this.count; i++) { final HttpGet httpget = new HttpGet(this.requestUri); this.httpclient.execute(this.target, httpget, response -> { final int status = response.getCode(); if (status != 200) { throw new ClientProtocolException("Unexpected status code: " + status); } EntityUtils.consume(response.getEntity()); try { Thread.sleep(10); } catch (final InterruptedException ex) { Thread.currentThread().interrupt(); } return null; }); } } catch (final Exception ex) { this.ex = ex; } } public Exception getException() { return ex; } } } ././@LongLink0100644 0000000 0000000 00000000154 14704162040 011631 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestHttpClientBuilderInterceptors.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestHttpClientBuilderIntercepto0100664 0000000 0000000 00000006565 14704162040 033031 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @SuppressWarnings("boxing") // test code class TestHttpClientBuilderInterceptors extends AbstractIntegrationTestBase { public TestHttpClientBuilderInterceptors() { super(URIScheme.HTTP, ClientProtocolLevel.STANDARD); } @BeforeEach void before() { configureServer(bootstrap -> bootstrap .register("/test", (request, response, context) -> { final Header testInterceptorHeader = request.getHeader("X-Test-Interceptor"); if (testInterceptorHeader != null) { response.setHeader(testInterceptorHeader); } response.setCode(200); })); configureClient(builder -> builder .addExecInterceptorLast("test-interceptor", (request, scope, chain) -> { request.setHeader("X-Test-Interceptor", "active"); return chain.proceed(request, scope); })); } @Test void testAddExecInterceptorLastShouldBeExecuted() throws Exception { final HttpHost httpHost = startServer(); final TestClient client = client(); final ClassicHttpRequest request = new HttpPost("/test"); final HttpResponse response = client.execute(httpHost, request, httpResponse -> { EntityUtils.consume(httpResponse.getEntity()); return httpResponse; }); Assertions.assertEquals(200, response.getCode()); final Header testFilterHeader = response.getHeader("X-Test-Interceptor"); Assertions.assertNotNull(testFilterHeader); } } ././@LongLink0100644 0000000 0000000 00000000146 14704162040 011632 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestMalformedServerResponse.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestMalformedServerResponse.jav0100664 0000000 0000000 00000012266 14704162040 032775 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import java.io.IOException; import java.net.Socket; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.bootstrap.HttpServer; import org.apache.hc.core5.http.impl.bootstrap.ServerBootstrap; import org.apache.hc.core5.http.impl.io.DefaultBHttpServerConnection; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.io.CloseMode; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestMalformedServerResponse { private HttpServer server; @AfterEach void shutDown() { if (this.server != null) { this.server.close(CloseMode.GRACEFUL); } } static class BrokenServerConnection extends DefaultBHttpServerConnection { public BrokenServerConnection(final String scheme, final Http1Config h1Config) { super(scheme, h1Config); } @Override public void sendResponseHeader(final ClassicHttpResponse response) throws HttpException, IOException { super.sendResponseHeader(response); if (response.getCode() == HttpStatus.SC_NO_CONTENT) { response.setEntity(new StringEntity( "garbage\ngarbage\n" + "garbage\ngarbage\n" + "garbage\ngarbage\n" + "garbage\ngarbage\n" + "garbage\ngarbage\n" + "garbage\ngarbage\n" + "garbage\ngarbage\n" + "garbage\ngarbage\n" + "garbage\ngarbage\n")); sendResponseEntity(response); } } } static class BrokenServerConnectionFactory implements HttpConnectionFactory { @Override public DefaultBHttpServerConnection createConnection(final Socket socket) throws IOException { final BrokenServerConnection conn = new BrokenServerConnection("http", Http1Config.DEFAULT); conn.bind(socket); return conn; } } @Test void testNoContentResponseWithGarbage() throws Exception { server = ServerBootstrap.bootstrap() .setCanonicalHostName("localhost") .setConnectionFactory(new BrokenServerConnectionFactory()) .register("/nostuff", (request, response, context) -> response.setCode(HttpStatus.SC_NO_CONTENT)) .register("/stuff", (request, response, context) -> { response.setCode(HttpStatus.SC_OK); response.setEntity(new StringEntity("Some important stuff")); }) .create(); server.start(); final HttpHost target = new HttpHost("localhost", server.getLocalPort()); try (final CloseableHttpClient httpclient = HttpClientBuilder.create().build()) { final HttpGet get1 = new HttpGet("/nostuff"); httpclient.execute(target, get1, response -> { Assertions.assertEquals(HttpStatus.SC_NO_CONTENT, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpGet get2 = new HttpGet("/stuff"); httpclient.execute(target, get2, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); } } } ././@LongLink0100644 0000000 0000000 00000000145 14704162040 011631 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestBasicConnectionManager.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestBasicConnectionManager.java0100664 0000000 0000000 00000006333 14704162040 032654 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.io.BasicHttpClientConnectionManager; import org.apache.hc.client5.testing.classic.RandomHandler; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestBasicConnectionManager extends AbstractIntegrationTestBase { public TestBasicConnectionManager() { super(URIScheme.HTTP, ClientProtocolLevel.STANDARD); } @Test void testBasics() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); configureClient(builder -> builder .setConnectionManager(new BasicHttpClientConnectionManager())); final TestClient client = client(); final HttpGet get = new HttpGet("/random/1024"); client.execute(target, get, response -> { Assertions.assertEquals(200, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); } @Test void testConnectionStillInUse() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); configureClient(builder -> builder .setConnectionManager(new BasicHttpClientConnectionManager())); final TestClient client = client(); final HttpGet get1 = new HttpGet("/random/1024"); client.executeOpen(target, get1, null); final HttpGet get2 = new HttpGet("/random/1024"); Assertions.assertThrows(IllegalStateException.class, () -> client.executeOpen(target, get2, null)); } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestRedirects.java0100664 0000000 0000000 00000101772 15063503632 030254 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import static org.hamcrest.MatcherAssert.assertThat; import java.io.IOException; import java.io.InterruptedIOException; import java.net.ConnectException; import java.net.InetSocketAddress; import java.net.NoRouteToHostException; import java.net.URI; import java.net.UnknownHostException; import java.util.Arrays; import java.util.Collections; import java.util.Queue; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.atomic.AtomicLong; import org.apache.hc.client5.http.CircularRedirectException; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.RedirectException; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.DefaultHttpRequestRetryStrategy; import org.apache.hc.client5.http.impl.cookie.BasicClientCookie; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectLocations; import org.apache.hc.client5.testing.OldPathRedirectResolver; import org.apache.hc.client5.testing.classic.EchoHandler; import org.apache.hc.client5.testing.classic.RandomHandler; import org.apache.hc.client5.testing.classic.RedirectingDecorator; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.client5.testing.extension.sync.TestServer; import org.apache.hc.client5.testing.extension.sync.TestServerBootstrap; import org.apache.hc.client5.testing.redirect.Redirect; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionClosedException; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.HttpRequestHandler; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.util.TimeValue; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.ValueSource; /** * Redirection test cases. */ abstract class TestRedirects extends AbstractIntegrationTestBase { protected TestRedirects(final URIScheme scheme) { super(scheme, ClientProtocolLevel.STANDARD); } @Test void testBasicRedirect300() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MULTIPLE_CHOICES))) .register("/random/*", new RandomHandler()) ); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/100"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_MULTIPLE_CHOICES, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/oldlocation/100").build(), reqWrapper.getUri()); final RedirectLocations redirects = context.getRedirectLocations(); Assertions.assertNotNull(redirects); Assertions.assertEquals(0, redirects.size()); } @Test void testBasicRedirect300NoKeepAlive() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MULTIPLE_CHOICES, Redirect.ConnControl.CLOSE))) .register("/random/*", new RandomHandler()) ); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/100"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_MULTIPLE_CHOICES, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/oldlocation/100").build(), reqWrapper.getUri()); final RedirectLocations redirects = context.getRedirectLocations(); Assertions.assertNotNull(redirects); Assertions.assertEquals(0, redirects.size()); } @Test void testBasicRedirect301() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MOVED_PERMANENTLY))) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/100"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/random/100").build(), reqWrapper.getUri()); final RedirectLocations redirects = context.getRedirectLocations(); Assertions.assertNotNull(redirects); Assertions.assertEquals(1, redirects.size()); final URI redirect = new URIBuilder().setHttpHost(target).setPath("/random/100").build(); Assertions.assertTrue(redirects.contains(redirect)); } @Test void testBasicRedirect302() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MOVED_TEMPORARILY))) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/50"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/random/50").build(), reqWrapper.getUri()); } @Test void testBasicRedirect302NoLocation() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, requestUri -> { final String path = requestUri.getPath(); if (path.startsWith("/oldlocation")) { return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, null); } return null; })) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/100"); client.execute(target, httpget, context, response -> { final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_MOVED_TEMPORARILY, response.getCode()); Assertions.assertEquals("/oldlocation/100", reqWrapper.getRequestUri()); EntityUtils.consume(response.getEntity()); return null; }); } @Test void testBasicRedirect303() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_SEE_OTHER))) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/123"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/random/123").build(), reqWrapper.getUri()); } @Test void testBasicRedirect304() throws Exception { configureServer(bootstrap -> bootstrap .register("/oldlocation/*", (request, response, context) -> { response.setCode(HttpStatus.SC_NOT_MODIFIED); response.addHeader(HttpHeaders.LOCATION, "/random/100"); }) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/stuff"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/oldlocation/stuff").build(), reqWrapper.getUri()); final RedirectLocations redirects = context.getRedirectLocations(); Assertions.assertNotNull(redirects); Assertions.assertEquals(0, redirects.size()); } @Test void testBasicRedirect305() throws Exception { configureServer(bootstrap -> bootstrap .register("/oldlocation/*", (request, response, context) -> { response.setCode(HttpStatus.SC_USE_PROXY); response.addHeader(HttpHeaders.LOCATION, "/random/100"); }) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/stuff"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_USE_PROXY, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/oldlocation/stuff").build(), reqWrapper.getUri()); final RedirectLocations redirects = context.getRedirectLocations(); Assertions.assertNotNull(redirects); Assertions.assertEquals(0, redirects.size()); } @Test void testBasicRedirect307() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_TEMPORARY_REDIRECT))) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/123"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/random/123").build(), reqWrapper.getUri()); } @Test void testMaxRedirectCheck() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/circular-oldlocation/", "/circular-oldlocation/", HttpStatus.SC_MOVED_TEMPORARILY))) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final RequestConfig config = RequestConfig.custom() .setCircularRedirectsAllowed(true) .setMaxRedirects(5) .build(); final HttpGet httpget = new HttpGet("/circular-oldlocation/123"); httpget.setConfig(config); final ClientProtocolException exception = Assertions.assertThrows(ClientProtocolException.class, () -> client.execute(target, httpget, response -> null)); Assertions.assertTrue(exception.getCause() instanceof RedirectException); } @Test void testCircularRedirect() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/circular-oldlocation/", "/circular-oldlocation/", HttpStatus.SC_MOVED_TEMPORARILY))) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final RequestConfig config = RequestConfig.custom() .setCircularRedirectsAllowed(false) .build(); final HttpGet httpget = new HttpGet("/circular-oldlocation/123"); httpget.setConfig(config); final ClientProtocolException exception = Assertions.assertThrows(ClientProtocolException.class, () -> client.execute(target, httpget, response -> null)); Assertions.assertTrue(exception.getCause() instanceof CircularRedirectException); } @Test void testPostRedirectSeeOther() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/oldlocation", "/echo", HttpStatus.SC_SEE_OTHER))) .register("/echo/*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpPost httppost = new HttpPost("/oldlocation/stuff"); httppost.setEntity(new StringEntity("stuff")); client.execute(target, httppost, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/echo/stuff").build(), reqWrapper.getUri()); Assertions.assertEquals("GET", reqWrapper.getMethod()); } @Test void testRelativeRedirect() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, requestUri -> { final String path = requestUri.getPath(); if (path.startsWith("/oldlocation")) { return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, "/random/100"); } return null; })) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/stuff"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/random/100").build(), reqWrapper.getUri()); } @Test void testRelativeRedirect2() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, requestUri -> { final String path = requestUri.getPath(); if (path.equals("/random/oldlocation")) { return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, "100"); } return null; })) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/random/oldlocation"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/random/100").build(), reqWrapper.getUri()); } @Test void testRejectBogusRedirectLocation() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, requestUri -> { final String path = requestUri.getPath(); if (path.equals("/oldlocation")) { return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, "xxx://bogus"); } return null; })) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet httpget = new HttpGet("/oldlocation"); final ClientProtocolException exception = Assertions.assertThrows(ClientProtocolException.class, () -> client.execute(target, httpget, response -> null)); assertThat(exception.getCause(), CoreMatchers.instanceOf(HttpException.class)); } @Test void testRejectInvalidRedirectLocation() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, requestUri -> { final String path = requestUri.getPath(); if (path.equals("/oldlocation")) { return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, "/newlocation/?p=I have spaces"); } return null; })) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet httpget = new HttpGet("/oldlocation"); final ClientProtocolException exception = Assertions.assertThrows(ClientProtocolException.class, () -> client.execute(target, httpget, response -> null)); assertThat(exception.getCause(), CoreMatchers.instanceOf(ProtocolException.class)); } @Test void testRedirectWithCookie() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MOVED_TEMPORARILY))) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final CookieStore cookieStore = new BasicCookieStore(); final BasicClientCookie cookie = new BasicClientCookie("name", "value"); cookie.setDomain(target.getHostName()); cookie.setPath("/"); cookieStore.addCookie(cookie); final HttpClientContext context = HttpClientContext.create(); context.setCookieStore(cookieStore); final HttpGet httpget = new HttpGet("/oldlocation/100"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/random/100").build(), reqWrapper.getUri()); final Header[] headers = reqWrapper.getHeaders("Cookie"); Assertions.assertEquals(1, headers.length, "There can only be one (cookie)"); } @Test void testDefaultHeadersRedirect() throws Exception { configureClient(builder -> builder .setDefaultHeaders(Collections.singletonList(new BasicHeader(HttpHeaders.USER_AGENT, "my-test-client"))) ); configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MOVED_TEMPORARILY))) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/100"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/random/100").build(), reqWrapper.getUri()); final Header header = reqWrapper.getFirstHeader(HttpHeaders.USER_AGENT); Assertions.assertEquals("my-test-client", header.getValue()); } @Test void testCompressionHeaderRedirect() throws Exception { final Queue values = new ConcurrentLinkedQueue<>(); configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MOVED_TEMPORARILY)) { @Override public void handle(final ClassicHttpRequest request, final ResponseTrigger responseTrigger, final HttpContext context) throws HttpException, IOException { final Header header = request.getHeader(HttpHeaders.ACCEPT_ENCODING); if (header != null) { values.add(header.getValue()); } super.handle(request, responseTrigger, context); } }) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/100"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder().setHttpHost(target).setPath("/random/100").build(), reqWrapper.getUri()); assertThat(values.poll(), CoreMatchers.equalTo("gzip, x-gzip, deflate")); assertThat(values.poll(), CoreMatchers.equalTo("gzip, x-gzip, deflate")); assertThat(values.poll(), CoreMatchers.nullValue()); } @Test void testRetryUponRedirect() throws Exception { configureClient(builder -> builder .setRetryStrategy(new DefaultHttpRequestRetryStrategy( 3, TimeValue.ofSeconds(1), Arrays.asList( InterruptedIOException.class, UnknownHostException.class, ConnectException.class, ConnectionClosedException.class, NoRouteToHostException.class), Arrays.asList( HttpStatus.SC_TOO_MANY_REQUESTS, HttpStatus.SC_SERVICE_UNAVAILABLE)) { }) ); configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, new OldPathRedirectResolver("/oldlocation", "/random", HttpStatus.SC_MOVED_TEMPORARILY))) .register("/random/*", new HttpRequestHandler() { final AtomicLong count = new AtomicLong(); @Override public void handle(final ClassicHttpRequest request, final ClassicHttpResponse response, final HttpContext context) throws HttpException, IOException { if (count.incrementAndGet() == 1) { throw new IOException("Boom"); } response.setCode(200); response.setEntity(new StringEntity("test")); } })); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/oldlocation/50"); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(new URIBuilder() .setHttpHost(target) .setPath("/random/50") .build(), reqWrapper.getUri()); } @ParameterizedTest(name = "{displayName}; manually added header: {0}") @ValueSource(strings = {HttpHeaders.AUTHORIZATION, HttpHeaders.COOKIE}) void testCrossSiteRedirectWithSensitiveHeaders(final String headerName) throws Exception { final URIScheme scheme = scheme(); final TestServer secondServer = new TestServerBootstrap(scheme()) .register("/random/*", new RandomHandler()) .build(); try { final InetSocketAddress address2 = secondServer.start(); final HttpHost redirectTarget = new HttpHost(scheme.name(), "localhost", address2.getPort()); configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new RedirectingDecorator( requestHandler, requestUri -> { final URI location = new URIBuilder(requestUri) .setHttpHost(redirectTarget) .setPath("/random/100") .build(); return new Redirect(HttpStatus.SC_MOVED_TEMPORARILY, location.toString()); })) .register("/random/*", new RandomHandler()) ); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); client.execute(target, ClassicRequestBuilder.get() .setHttpHost(target) .setPath("/oldlocation") .setHeader(headerName, "custom header") .build(), context, response -> { Assertions.assertEquals(HttpStatus.SC_MOVED_TEMPORARILY, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final RedirectLocations redirects = context.getRedirectLocations(); Assertions.assertNotNull(redirects); Assertions.assertEquals(0, redirects.size()); } finally { secondServer.shutdown(CloseMode.GRACEFUL); } } } ././@LongLink0100644 0000000 0000000 00000000145 15063503632 011636 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestClientRequestExecution.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestClientRequestExecution.java0100664 0000000 0000000 00000033216 15063503632 033000 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import java.io.ByteArrayInputStream; import java.io.IOException; import java.net.URI; import java.util.Random; import java.util.concurrent.Executors; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.TimeUnit; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectLocations; import org.apache.hc.client5.http.utils.URIUtils; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpClientConnection; import org.apache.hc.core5.http.io.HttpRequestHandler; import org.apache.hc.core5.http.io.HttpResponseInformationCallback; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Disabled; import org.junit.jupiter.api.Test; /** * Client protocol handling tests. */ abstract class TestClientRequestExecution extends AbstractIntegrationTestBase { public TestClientRequestExecution(final URIScheme scheme) { super(scheme, ClientProtocolLevel.STANDARD); } private static class SimpleService implements HttpRequestHandler { public SimpleService() { super(); } @Override public void handle( final ClassicHttpRequest request, final ClassicHttpResponse response, final HttpContext context) { response.setCode(HttpStatus.SC_OK); final StringEntity entity = new StringEntity("Whatever"); response.setEntity(entity); } } private static class FaultyHttpRequestExecutor extends HttpRequestExecutor { private static final String MARKER = "marker"; private final String failureMsg; public FaultyHttpRequestExecutor(final String failureMsg) { this.failureMsg = failureMsg; } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final HttpClientConnection conn, final HttpContext context) throws IOException, HttpException { return execute(request, conn, null, context); } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final HttpClientConnection conn, final HttpResponseInformationCallback informationCallback, final HttpContext context) throws IOException, HttpException { final ClassicHttpResponse response = super.execute(request, conn, informationCallback, context); final Object marker = context.getAttribute(MARKER); if (marker == null) { context.setAttribute(MARKER, Boolean.TRUE); throw new IOException(failureMsg); } return response; } } @Test void testAutoGeneratedHeaders() throws Exception { configureServer(bootstrap -> bootstrap.register("*", new SimpleService())); final HttpHost target = startServer(); final HttpRequestInterceptor interceptor = (request, entityDetails, context) -> request.addHeader("my-header", "stuff"); final HttpRequestRetryStrategy requestRetryStrategy = new HttpRequestRetryStrategy() { @Override public boolean retryRequest( final HttpRequest request, final IOException exception, final int executionCount, final HttpContext context) { return true; } @Override public boolean retryRequest( final HttpResponse response, final int executionCount, final HttpContext context) { return false; } @Override public TimeValue getRetryInterval( final HttpResponse response, final int executionCount, final HttpContext context) { return TimeValue.ofSeconds(1L); } }; configureClient(builder -> builder .addRequestInterceptorFirst(interceptor) .setRequestExecutor(new FaultyHttpRequestExecutor("Oppsie")) .setRetryStrategy(requestRetryStrategy) ); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("/"); client.execute(target, httpget, context, response -> { EntityUtils.consume(response.getEntity()); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); final Header[] myheaders = reqWrapper.getHeaders("my-header"); Assertions.assertNotNull(myheaders); Assertions.assertEquals(1, myheaders.length); return null; }); } @Test void testNonRepeatableEntity() throws Exception { configureServer(bootstrap -> bootstrap.register("*", new SimpleService())); final HttpHost target = startServer(); final HttpRequestRetryStrategy requestRetryStrategy = new HttpRequestRetryStrategy() { @Override public boolean retryRequest( final HttpRequest request, final IOException exception, final int executionCount, final HttpContext context) { return true; } @Override public boolean retryRequest( final HttpResponse response, final int executionCount, final HttpContext context) { return false; } @Override public TimeValue getRetryInterval( final HttpResponse response, final int executionCount, final HttpContext context) { return TimeValue.ofSeconds(1L); } }; configureClient(builder -> builder .setRequestExecutor(new FaultyHttpRequestExecutor("a message showing that this failed")) .setRetryStrategy(requestRetryStrategy) ); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final HttpPost httppost = new HttpPost("/"); httppost.setEntity(new InputStreamEntity( new ByteArrayInputStream( new byte[] { 1, 2, 3, 4, 5, 6, 7, 8, 9 } ), -1, null)); Assertions.assertThrows(IOException.class, () -> client.execute(target, httppost, context, response -> null)); } @Test void testNonCompliantURI() throws Exception { configureServer(bootstrap -> bootstrap.register("*", new SimpleService())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new BasicClassicHttpRequest("GET", "{{|boom|}}"); client.execute(target, request, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest reqWrapper = context.getRequest(); Assertions.assertEquals("{{|boom|}}", reqWrapper.getRequestUri()); } @Test void testRelativeRequestURIWithFragment() throws Exception { configureServer(bootstrap -> bootstrap.register("*", new SimpleService())); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet httpget = new HttpGet("/stuff#blahblah"); final HttpClientContext context = HttpClientContext.create(); client.execute(target, httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); final HttpRequest request = context.getRequest(); Assertions.assertEquals("/stuff", request.getRequestUri()); } @Test void testAbsoluteRequestURIWithFragment() throws Exception { configureServer(bootstrap -> bootstrap.register("*", new SimpleService())); final HttpHost target = startServer(); final TestClient client = client(); final URI uri = new URIBuilder() .setHost(target.getHostName()) .setPort(target.getPort()) .setScheme(target.getSchemeName()) .setPath("/stuff") .setFragment("blahblah") .build(); final HttpGet httpget = new HttpGet(uri); final HttpClientContext context = HttpClientContext.create(); client.execute(httpget, context, response -> { Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); return null; }); final HttpRequest request = context.getRequest(); Assertions.assertEquals("/stuff", request.getRequestUri()); final RedirectLocations redirectLocations = context.getRedirectLocations(); final URI location = URIUtils.resolve(uri, target, redirectLocations.getAll()); Assertions.assertEquals(uri, location); } @Test @Disabled("Fails intermittently with GitHub Actions") void testRequestCancellation() throws Exception { startServer(); final HttpHost target = startServer(); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(1); connManager.setDefaultMaxPerRoute(1); final ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor(); try { for (int i = 0; i < 20; i++) { final HttpGet httpget = new HttpGet("/random/1000"); executorService.schedule(httpget::cancel, 1, TimeUnit.MILLISECONDS); try { client.execute(target, httpget, response -> { EntityUtils.consume(response.getEntity()); return null; }); } catch (final Exception ignore) { } } final Random rnd = new Random(); for (int i = 0; i < 20; i++) { final HttpGet httpget = new HttpGet("/random/1000"); executorService.schedule(httpget::cancel, rnd.nextInt(200), TimeUnit.MILLISECONDS); try { client.execute(target, httpget, response -> { EntityUtils.consume(response.getEntity()); return null; }); } catch (final Exception ignore) { } } for (int i = 0; i < 5; i++) { final HttpGet httpget = new HttpGet("/random/1000"); client.execute(target, httpget, response -> { EntityUtils.consume(response.getEntity()); return null; }); } } finally { executorService.shutdownNow(); } } } ././@LongLink0100644 0000000 0000000 00000000147 14704162040 011633 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestDefaultClientTlsStrategy.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestDefaultClientTlsStrategy.ja0100664 0000000 0000000 00000046543 14704162040 032731 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import static org.hamcrest.MatcherAssert.assertThat; import java.io.IOException; import java.net.InetAddress; import java.net.Socket; import java.util.Objects; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLException; import javax.net.ssl.SSLHandshakeException; import javax.net.ssl.SSLPeerUnverifiedException; import javax.net.ssl.SSLSession; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.http.ssl.HostnameVerificationPolicy; import org.apache.hc.client5.http.ssl.HttpsSupport; import org.apache.hc.client5.http.ssl.NoopHostnameVerifier; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.client5.testing.SSLTestContexts; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.impl.bootstrap.HttpServer; import org.apache.hc.core5.http.impl.bootstrap.ServerBootstrap; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.ssl.SSLContexts; import org.apache.hc.core5.ssl.TrustStrategy; import org.hamcrest.CoreMatchers; import org.hamcrest.MatcherAssert; import org.hamcrest.Matchers; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Unit tests for {@link DefaultClientTlsStrategy}. */ class TestDefaultClientTlsStrategy { private HttpServer server; @AfterEach void shutDown() { if (this.server != null) { this.server.close(CloseMode.GRACEFUL); } } static class TestX509HostnameVerifier implements HostnameVerifier { private boolean fired; @Override public boolean verify(final String host, final SSLSession session) { this.fired = true; return true; } public boolean isFired() { return this.fired; } } @Test void testBasicSSL() throws Exception { // @formatter:off this.server = ServerBootstrap.bootstrap() .setSslContext(SSLTestContexts.createServerSSLContext()) .setRequestRouter((r, c) -> null) .create(); // @formatter:on this.server.start(); final HttpClientContext context = HttpClientContext.create(); final TestX509HostnameVerifier hostVerifier = new TestX509HostnameVerifier(); final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy( SSLTestContexts.createClientSSLContext(), hostVerifier); final HttpHost target = new HttpHost("https", "localhost", server.getLocalPort()); try (final Socket socket = new Socket(target.getHostName(), target.getPort())) { try (final SSLSocket sslSocket = tlsStrategy.upgrade( socket, target.getHostName(), target.getPort(), null, context)) { final SSLSession sslsession = sslSocket.getSession(); Assertions.assertNotNull(sslsession); Assertions.assertTrue(hostVerifier.isFired()); } } } @Test void testBasicDefaultHostnameVerifier() throws Exception { // @formatter:off this.server = ServerBootstrap.bootstrap() .setSslContext(SSLTestContexts.createServerSSLContext()) .setRequestRouter((r, c) -> null) .create(); // @formatter:on this.server.start(); final HttpClientContext context = HttpClientContext.create(); final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy(SSLTestContexts.createClientSSLContext()); final HttpHost target = new HttpHost("https", "localhost", server.getLocalPort()); try (final Socket socket = new Socket(target.getHostName(), target.getPort())) { try (final SSLSocket sslSocket = tlsStrategy.upgrade( socket, target.getHostName(), target.getPort(), null, context)) { final SSLSession sslsession = sslSocket.getSession(); Assertions.assertNotNull(sslsession); } } } @Test void testClientAuthSSL() throws Exception { // @formatter:off this.server = ServerBootstrap.bootstrap() .setSslContext(SSLTestContexts.createServerSSLContext()) .setRequestRouter((r, c) -> null) .create(); // @formatter:on this.server.start(); final HttpClientContext context = HttpClientContext.create(); final TestX509HostnameVerifier hostVerifier = new TestX509HostnameVerifier(); final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy( SSLTestContexts.createClientSSLContext(), hostVerifier); final HttpHost target = new HttpHost("https", "localhost", server.getLocalPort()); try (final Socket socket = new Socket(target.getHostName(), target.getPort())) { try (final SSLSocket sslSocket = tlsStrategy.upgrade( socket, target.getHostName(), target.getPort(), null, context)) { final SSLSession sslsession = sslSocket.getSession(); Assertions.assertNotNull(sslsession); Assertions.assertTrue(hostVerifier.isFired()); } } } @Test void testClientAuthSSLFailure() throws Exception { // @formatter:off this.server = ServerBootstrap.bootstrap() .setSslContext(SSLTestContexts.createServerSSLContext()) .setSslSetupHandler(sslParameters -> sslParameters.setNeedClientAuth(true)) .setRequestRouter((r, c) -> null) .create(); // @formatter:on this.server.start(); final HttpClientContext context = HttpClientContext.create(); final TestX509HostnameVerifier hostVerifier = new TestX509HostnameVerifier(); final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy( SSLTestContexts.createClientSSLContext(), hostVerifier); final HttpHost target = new HttpHost("https", "localhost", server.getLocalPort()); try (final Socket socket = new Socket(target.getHostName(), target.getPort())) { Assertions.assertThrows(IOException.class, () -> { try (final SSLSocket sslSocket = tlsStrategy.upgrade( socket, target.getHostName(), target.getPort(), null, context)) { final SSLSession sslsession = sslSocket.getSession(); Assertions.assertNotNull(sslsession); Assertions.assertTrue(hostVerifier.isFired()); sslSocket.getInputStream().read(); } }); } } @Test void testSSLTrustVerification() throws Exception { // @formatter:off this.server = ServerBootstrap.bootstrap() .setSslContext(SSLTestContexts.createServerSSLContext()) .setRequestRouter((r, c) -> null) .create(); // @formatter:on this.server.start(); final HttpClientContext context = HttpClientContext.create(); // Use default SSL context final SSLContext defaultSslContext = SSLContexts.createDefault(); final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy(defaultSslContext, NoopHostnameVerifier.INSTANCE); final HttpHost target = new HttpHost("https", "localhost", server.getLocalPort()); try (final Socket socket = new Socket(target.getHostName(), target.getPort())) { Assertions.assertThrows(SSLException.class, () -> { try (final SSLSocket sslSocket = tlsStrategy.upgrade( socket, target.getHostName(), target.getPort(), null, context)) { // empty for now } }); } } @Test void testSSLTrustVerificationOverrideWithCustom() throws Exception { final TrustStrategy trustStrategy = (chain, authType) -> chain.length == 1; testSSLTrustVerificationOverride(trustStrategy); } private void testSSLTrustVerificationOverride(final TrustStrategy trustStrategy) throws Exception { // @formatter:off this.server = ServerBootstrap.bootstrap() .setSslContext(SSLTestContexts.createServerSSLContext()) .setRequestRouter((r, c) -> null) .create(); // @formatter:on this.server.start(); final HttpClientContext context = HttpClientContext.create(); // @formatter:off final SSLContext sslContext = SSLContexts.custom() .loadTrustMaterial(null, trustStrategy) .build(); // @formatter:on final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy(sslContext, NoopHostnameVerifier.INSTANCE); final HttpHost target = new HttpHost("https", "localhost", server.getLocalPort()); try (final Socket socket = new Socket(target.getHostName(), target.getPort())) { try (final SSLSocket sslSocket = tlsStrategy.upgrade( socket, target.getHostName(), target.getPort(), null, context)) { // empty for now } } } @Test void testSSLDisabledByDefault() throws Exception { // @formatter:off this.server = ServerBootstrap.bootstrap() .setSslContext(SSLTestContexts.createServerSSLContext()) .setSslSetupHandler(sslParameters -> sslParameters.setProtocols(new String[] {"SSLv3"})) .setRequestRouter((r, c) -> null) .create(); // @formatter:on this.server.start(); final HttpClientContext context = HttpClientContext.create(); final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy( SSLTestContexts.createClientSSLContext()); final HttpHost target = new HttpHost("https", "localhost", server.getLocalPort()); try (final Socket socket = new Socket(target.getHostName(), target.getPort())) { Assertions.assertThrows(IOException.class, () -> tlsStrategy.upgrade( socket, target.getHostName(), target.getPort(), null, context)); } } @Test void testWeakCiphersDisabledByDefault() { final String[] weakCiphersSuites = { "SSL_RSA_WITH_RC4_128_SHA", "SSL_RSA_WITH_3DES_EDE_CBC_SHA", "TLS_DH_anon_WITH_AES_128_CBC_SHA", "SSL_RSA_EXPORT_WITH_DES40_CBC_SHA", "SSL_RSA_WITH_NULL_SHA", "SSL_RSA_WITH_3DES_EDE_CBC_SHA", "TLS_ECDHE_ECDSA_WITH_RC4_128_SHA", "TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA", "TLS_DH_anon_WITH_AES_256_GCM_SHA384", "TLS_ECDH_anon_WITH_AES_256_CBC_SHA", "TLS_RSA_WITH_NULL_SHA256", "SSL_RSA_EXPORT_WITH_RC4_40_MD5", "SSL_DH_anon_EXPORT_WITH_RC4_40_MD5", "TLS_KRB5_EXPORT_WITH_RC4_40_SHA", "SSL_RSA_EXPORT_WITH_RC2_CBC_40_MD5" }; for (final String cipherSuite : weakCiphersSuites) { final Exception exception = Assertions.assertThrows(Exception.class, () -> testWeakCipherDisabledByDefault(cipherSuite)); assertThat(exception, CoreMatchers.anyOf( CoreMatchers.instanceOf(IOException.class), CoreMatchers.instanceOf(IllegalArgumentException.class))); } } private void testWeakCipherDisabledByDefault(final String cipherSuite) throws Exception { // @formatter:off this.server = ServerBootstrap.bootstrap() .setSslContext(SSLTestContexts.createServerSSLContext()) .setSslSetupHandler(sslParameters -> sslParameters.setProtocols(new String[] {cipherSuite})) .setRequestRouter((r, c) -> null) .create(); // @formatter:on this.server.start(); final HttpClientContext context = HttpClientContext.create(); final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy( SSLTestContexts.createClientSSLContext()); final HttpHost target = new HttpHost("https", "localhost", server.getLocalPort()); try (final Socket socket = new Socket(target.getHostName(), target.getPort())) { tlsStrategy.upgrade( socket, target.getHostName(), target.getPort(), null, context); } } @Test void testHostnameVerificationClient() throws Exception { // @formatter:off this.server = ServerBootstrap.bootstrap() .setSslContext(SSLTestContexts.createServerSSLContext()) .setRequestRouter((r, c) -> null) .create(); // @formatter:on this.server.start(); final HttpHost target1 = new HttpHost("https", "localhost", server.getLocalPort()); try (final Socket socket = new Socket(InetAddress.getLocalHost(), server.getLocalPort())) { final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy( SSLTestContexts.createClientSSLContext(), HostnameVerificationPolicy.CLIENT, HttpsSupport.getDefaultHostnameVerifier()); final HttpClientContext context = HttpClientContext.create(); final SSLSocket upgradedSocket = tlsStrategy.upgrade( socket, target1.getHostName(), target1.getPort(), null, context); final SSLSession session = upgradedSocket.getSession(); MatcherAssert.assertThat(Objects.toString(session.getPeerPrincipal()), Matchers.startsWith("CN=localhost")); } final HttpHost target2 = new HttpHost("https", "some-other-host", server.getLocalPort()); try (final Socket socket = new Socket(InetAddress.getLocalHost(), server.getLocalPort())) { final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy( SSLTestContexts.createClientSSLContext(), HostnameVerificationPolicy.CLIENT, HttpsSupport.getDefaultHostnameVerifier()); final HttpClientContext context = HttpClientContext.create(); Assertions.assertThrows(SSLPeerUnverifiedException.class, () -> tlsStrategy.upgrade( socket, target2.getHostName(), target2.getPort(), null, context)); } try (final Socket socket = new Socket(InetAddress.getLocalHost(), server.getLocalPort())) { final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy( SSLTestContexts.createClientSSLContext(), HostnameVerificationPolicy.CLIENT, NoopHostnameVerifier.INSTANCE); final HttpClientContext context = HttpClientContext.create(); final SSLSocket upgradedSocket = tlsStrategy.upgrade( socket, target1.getHostName(), target1.getPort(), null, context); final SSLSession session = upgradedSocket.getSession(); MatcherAssert.assertThat(Objects.toString(session.getPeerPrincipal()), Matchers.startsWith("CN=localhost")); } } @Test void testHostnameVerificationBuiltIn() throws Exception { // @formatter:off this.server = ServerBootstrap.bootstrap() .setSslContext(SSLTestContexts.createServerSSLContext()) .setRequestRouter((r, c) -> null) .create(); // @formatter:on this.server.start(); final HttpHost target1 = new HttpHost("https", "localhost", server.getLocalPort()); try (final Socket socket = new Socket(InetAddress.getLocalHost(), server.getLocalPort())) { final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy( SSLTestContexts.createClientSSLContext(), HostnameVerificationPolicy.BUILTIN, NoopHostnameVerifier.INSTANCE); final HttpClientContext context = HttpClientContext.create(); final SSLSocket upgradedSocket = tlsStrategy.upgrade( socket, target1.getHostName(), target1.getPort(), null, context); final SSLSession session = upgradedSocket.getSession(); MatcherAssert.assertThat(Objects.toString(session.getPeerPrincipal()), Matchers.startsWith("CN=localhost")); } final HttpHost target2 = new HttpHost("https", "some-other-host", server.getLocalPort()); try (final Socket socket = new Socket(InetAddress.getLocalHost(), server.getLocalPort())) { final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy( SSLTestContexts.createClientSSLContext(), HostnameVerificationPolicy.BUILTIN, NoopHostnameVerifier.INSTANCE); final HttpClientContext context = HttpClientContext.create(); Assertions.assertThrows(SSLHandshakeException.class, () -> tlsStrategy.upgrade( socket, target2.getHostName(), target2.getPort(), null, context)); } } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestCookieVirtualHost.java0100664 0000000 0000000 00000014553 14704162040 031741 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import java.net.URI; import java.util.List; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.impl.bootstrap.HttpServer; import org.apache.hc.core5.http.impl.bootstrap.ServerBootstrap; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.io.CloseMode; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * This class tests cookie matching when using Virtual Host. */ class TestCookieVirtualHost { private HttpServer server; @AfterEach void shutDown() { if (this.server != null) { this.server.close(CloseMode.GRACEFUL); } } @Test void testCookieMatchingWithVirtualHosts() throws Exception { server = ServerBootstrap.bootstrap() .register("app.mydomain.fr", "*", (request, response, context) -> { final int n = Integer.parseInt(request.getFirstHeader("X-Request").getValue()); switch (n) { case 1: // Assert Host is forwarded from URI Assertions.assertEquals("app.mydomain.fr", request .getFirstHeader("Host").getValue()); response.setCode(HttpStatus.SC_OK); // Respond with Set-Cookie on virtual host domain. This // should be valid. response.addHeader(new BasicHeader("Set-Cookie", "name1=value1; domain=mydomain.fr; path=/")); break; case 2: // Assert Host is still forwarded from URI Assertions.assertEquals("app.mydomain.fr", request .getFirstHeader("Host").getValue()); // We should get our cookie back. Assertions.assertNotNull(request.getFirstHeader("Cookie"), "We must get a cookie header"); response.setCode(HttpStatus.SC_OK); break; case 3: // Assert Host is forwarded from URI Assertions.assertEquals("app.mydomain.fr", request .getFirstHeader("Host").getValue()); response.setCode(HttpStatus.SC_OK); break; default: Assertions.fail("Unexpected value: " + n); break; } }) .create(); server.start(); final HttpHost target = new HttpHost("localhost", server.getLocalPort()); try (final CloseableHttpClient client = HttpClientBuilder.create().build()) { final CookieStore cookieStore = new BasicCookieStore(); final HttpClientContext context = HttpClientContext.create(); context.setCookieStore(cookieStore); // First request : retrieve a domain cookie from remote server. final HttpGet request1 = new HttpGet(new URI("http://app.mydomain.fr")); request1.addHeader("X-Request", "1"); client.execute(target, request1, context, response -> { Assertions.assertEquals(200, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); // We should have one cookie set on domain. final List cookies = cookieStore.getCookies(); Assertions.assertNotNull(cookies); Assertions.assertEquals(1, cookies.size()); Assertions.assertEquals("name1", cookies.get(0).getName()); // Second request : send the cookie back. final HttpGet request2 = new HttpGet(new URI("http://app.mydomain.fr")); request2.addHeader("X-Request", "2"); client.execute(target, request2, context, response -> { Assertions.assertEquals(200, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); // Third request : Host header final HttpGet request3 = new HttpGet(new URI("http://app.mydomain.fr")); request3.addHeader("X-Request", "3"); client.execute(target, request3, context, response -> { Assertions.assertEquals(200, response.getCode()); EntityUtils.consume(response.getEntity()); return null; }); } } } ././@LongLink0100644 0000000 0000000 00000000146 15063503632 011637 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/AbstractIntegrationTestBase.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/AbstractIntegrationTestBase.jav0100664 0000000 0000000 00000006165 15063503632 032731 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import java.net.InetSocketAddress; import java.util.function.Consumer; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.client5.testing.extension.sync.TestClientBuilder; import org.apache.hc.client5.testing.extension.sync.TestClientResources; import org.apache.hc.client5.testing.extension.sync.TestServer; import org.apache.hc.client5.testing.extension.sync.TestServerBootstrap; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.extension.RegisterExtension; abstract class AbstractIntegrationTestBase { public static final Timeout TIMEOUT = Timeout.ofMinutes(1); @RegisterExtension private final TestClientResources testResources; protected AbstractIntegrationTestBase(final URIScheme scheme, final ClientProtocolLevel clientProtocolLevel) { this.testResources = new TestClientResources(scheme, clientProtocolLevel, TIMEOUT); } public URIScheme scheme() { return testResources.scheme(); } public ClientProtocolLevel getClientProtocolLevel() { return testResources.getClientProtocolLevel(); } public void configureServer(final Consumer serverCustomizer) { testResources.configureServer(serverCustomizer); } public HttpHost startServer() throws Exception { final TestServer server = testResources.server(); final InetSocketAddress inetSocketAddress = server.start(); return new HttpHost(testResources.scheme().id, "localhost", inetSocketAddress.getPort()); } public void configureClient(final Consumer clientCustomizer) { testResources.configureClient(clientCustomizer); } public TestClient client() throws Exception { return testResources.client(); } } ././@LongLink0100644 0000000 0000000 00000000145 14704162040 011631 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestStatefulConnManagement.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestStatefulConnManagement.java0100664 0000000 0000000 00000023433 14704162040 032722 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.EndpointDetails; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.HttpRequestHandler; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Test cases for state-ful connections. */ class TestStatefulConnManagement extends AbstractIntegrationTestBase { public static final Timeout LONG_TIMEOUT = Timeout.ofMinutes(3); public TestStatefulConnManagement() { super(URIScheme.HTTP, ClientProtocolLevel.STANDARD); } private static class SimpleService implements HttpRequestHandler { public SimpleService() { super(); } @Override public void handle( final ClassicHttpRequest request, final ClassicHttpResponse response, final HttpContext context) { response.setCode(HttpStatus.SC_OK); final StringEntity entity = new StringEntity("Whatever"); response.setEntity(entity); } } @Test void testStatefulConnections() throws Exception { configureServer(bootstrap -> bootstrap .register("*", new SimpleService())); final HttpHost target = startServer(); final int workerCount = 5; final int requestCount = 5; final UserTokenHandler userTokenHandler = (route, context) -> { final String id = (String) context.getAttribute("user"); return id; }; configureClient(builder -> builder .setUserTokenHandler(userTokenHandler)); final TestClient client = client(); final PoolingHttpClientConnectionManager connectionManager = client.getConnectionManager(); connectionManager.setMaxTotal(workerCount); connectionManager.setDefaultMaxPerRoute(workerCount); final HttpClientContext[] contexts = new HttpClientContext[workerCount]; final HttpWorker[] workers = new HttpWorker[workerCount]; for (int i = 0; i < contexts.length; i++) { final HttpClientContext context = HttpClientContext.create(); contexts[i] = context; workers[i] = new HttpWorker( "user" + i, context, requestCount, target, client); } for (final HttpWorker worker : workers) { worker.start(); } for (final HttpWorker worker : workers) { worker.join(LONG_TIMEOUT.toMilliseconds()); } for (final HttpWorker worker : workers) { final Exception ex = worker.getException(); if (ex != null) { throw ex; } Assertions.assertEquals(requestCount, worker.getCount()); } for (final HttpContext context : contexts) { final String state0 = (String) context.getAttribute("r0"); Assertions.assertNotNull(state0); for (int r = 1; r < requestCount; r++) { Assertions.assertEquals(state0, context.getAttribute("r" + r)); } } } static class HttpWorker extends Thread { private final String uid; private final HttpClientContext context; private final int requestCount; private final HttpHost target; private final CloseableHttpClient httpclient; private volatile Exception exception; private volatile int count; public HttpWorker( final String uid, final HttpClientContext context, final int requestCount, final HttpHost target, final CloseableHttpClient httpclient) { super(); this.uid = uid; this.context = context; this.requestCount = requestCount; this.target = target; this.httpclient = httpclient; this.count = 0; } public int getCount() { return this.count; } public Exception getException() { return this.exception; } @Override public void run() { try { this.context.setAttribute("user", this.uid); for (int r = 0; r < this.requestCount; r++) { final HttpGet httpget = new HttpGet("/"); this.httpclient.execute(this.target, httpget, this.context, response -> { EntityUtils.consume(response.getEntity()); return null; }); this.count++; final EndpointDetails endpointDetails = this.context.getEndpointDetails(); final String connuid = Integer.toHexString(System.identityHashCode(endpointDetails)); this.context.setAttribute("r" + r, connuid); } } catch (final Exception ex) { this.exception = ex; } } } @Test void testRouteSpecificPoolRecylcing() throws Exception { configureServer(bootstrap -> bootstrap.register("*", new SimpleService())); final HttpHost target = startServer(); // This tests what happens when a maxed connection pool needs // to kill the last idle connection to a route to build a new // one to the same route. final int maxConn = 2; configureClient(builder -> builder .setUserTokenHandler((route, context) -> context.getAttribute("user"))); final TestClient client = client(); final PoolingHttpClientConnectionManager connectionManager = client.getConnectionManager(); connectionManager.setMaxTotal(maxConn); connectionManager.setDefaultMaxPerRoute(maxConn); // Bottom of the pool : a *keep alive* connection to Route 1. final HttpContext context1 = HttpClientContext.create(); context1.setAttribute("user", "stuff"); client.execute(target, new HttpGet("/"), context1, response -> { EntityUtils.consume(response.getEntity()); return null; }); // The ConnPoolByRoute now has 1 free connection, out of 2 max // The ConnPoolByRoute has one RouteSpcfcPool, that has one free connection // for [localhost][stuff] Thread.sleep(100); // Send a very simple HTTP get (it MUST be simple, no auth, no proxy, no 302, no 401, ...) // Send it to another route. Must be a keepalive. final HttpContext context2 = HttpClientContext.create(); client.execute(new HttpHost("127.0.0.1", target.getPort()), new HttpGet("/"), context2, response -> { EntityUtils.consume(response.getEntity()); return null; }); // ConnPoolByRoute now has 2 free connexions, out of its 2 max. // The [localhost][stuff] RouteSpcfcPool is the same as earlier // And there is a [127.0.0.1][null] pool with 1 free connection Thread.sleep(100); // This will put the ConnPoolByRoute to the targeted state : // [localhost][stuff] will not get reused because this call is [localhost][null] // So the ConnPoolByRoute will need to kill one connection (it is maxed out globally). // The killed conn is the oldest, which means the first HTTPGet ([localhost][stuff]). // When this happens, the RouteSpecificPool becomes empty. final HttpContext context3 = HttpClientContext.create(); client.execute(target, new HttpGet("/"), context3, response -> { EntityUtils.consume(response.getEntity()); return null; }); // If the ConnPoolByRoute did not behave coherently with the RouteSpecificPool // this may fail. Ex : if the ConnPool discared the route pool because it was empty, // but still used it to build the request3 connection. } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestClientAuthentication.java0100664 0000000 0000000 00000107064 15005672016 032445 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import static org.hamcrest.MatcherAssert.assertThat; import java.io.ByteArrayInputStream; import java.nio.charset.StandardCharsets; import java.security.SecureRandom; import java.util.Arrays; import java.util.Collections; import java.util.Queue; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.atomic.AtomicLong; import java.util.function.Consumer; import java.util.stream.Collectors; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.BearerToken; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.classic.methods.HttpPut; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy; import org.apache.hc.client5.http.impl.auth.BasicAuthCache; import org.apache.hc.client5.http.impl.auth.BasicScheme; import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory; import org.apache.hc.client5.http.impl.auth.CredentialsProviderBuilder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.BasicTestAuthenticator; import org.apache.hc.client5.testing.auth.Authenticator; import org.apache.hc.client5.testing.auth.BearerAuthenticationHandler; import org.apache.hc.client5.testing.classic.AuthenticatingDecorator; import org.apache.hc.client5.testing.classic.EchoHandler; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.client5.testing.extension.sync.TestServerBootstrap; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Registry; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.io.HttpRequestHandler; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.support.BasicResponseBuilder; import org.apache.hc.core5.net.URIAuthority; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.mockito.Mockito; /** * Unit tests for automatic client authentication. */ abstract class TestClientAuthentication extends AbstractIntegrationTestBase { protected TestClientAuthentication(final URIScheme scheme) { super(scheme, ClientProtocolLevel.STANDARD); } public void configureServerWithBasicAuth(final Authenticator authenticator, final Consumer serverCustomizer) { configureServer(bootstrap -> { bootstrap.setExchangeHandlerDecorator(requestHandler -> new AuthenticatingDecorator(requestHandler, authenticator)); serverCustomizer.accept(bootstrap); }); } public void configureServerWithBasicAuth(final Consumer serverCustomizer) { configureServerWithBasicAuth( new BasicTestAuthenticator("test:test", "test realm"), serverCustomizer); } @Test void testBasicAuthenticationNoCreds() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); context.setCredentialsProvider(credsProvider); final HttpGet httpget = new HttpGet("/"); client.execute(target, httpget, context, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); Assertions.assertNotNull(entity); EntityUtils.consume(entity); return null; }); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } @Test void testBasicAuthenticationFailure() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "all-wrong".toCharArray())); context.setCredentialsProvider(credsProvider); final HttpGet httpget = new HttpGet("/"); client.execute(target, httpget, context, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); Assertions.assertNotNull(entity); EntityUtils.consume(entity); return null; }); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } @Test void testBasicAuthenticationSuccess() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet httpget = new HttpGet("/"); final HttpClientContext context = HttpClientContext.create(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); context.setCredentialsProvider(credsProvider); client.execute(target, httpget, context, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity); EntityUtils.consume(entity); return null; }); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } @Test void testBasicAuthenticationSuccessOnNonRepeatablePutExpectContinue() throws Exception { configureServer(bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final RequestConfig config = RequestConfig.custom() .setExpectContinueEnabled(true) .build(); final HttpPut httpput = new HttpPut("/"); httpput.setConfig(config); httpput.setEntity(new InputStreamEntity( new ByteArrayInputStream( new byte[]{1, 2, 3, 4, 5, 6, 7, 8, 9}), -1, null)); final HttpClientContext context = HttpClientContext.create(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); context.setCredentialsProvider(credsProvider); client.execute(target, httpput, context, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity); return null; }); } @Test void testBasicAuthenticationFailureOnNonRepeatablePutDontExpectContinue() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final RequestConfig config = RequestConfig.custom().setExpectContinueEnabled(false).build(); final HttpPut httpput = new HttpPut("/"); httpput.setConfig(config); httpput.setEntity(new InputStreamEntity( new ByteArrayInputStream( new byte[]{1, 2, 3, 4, 5, 6, 7, 8, 9}), -1, null)); final HttpClientContext context = HttpClientContext.create(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "boom".toCharArray())); context.setCredentialsProvider(credsProvider); client.execute(target, httpput, context, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(401, response.getCode()); Assertions.assertNotNull(entity); EntityUtils.consume(entity); return null; }); } @Test void testBasicAuthenticationSuccessOnRepeatablePost() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpPost httppost = new HttpPost("/"); httppost.setEntity(new StringEntity("some important stuff", StandardCharsets.US_ASCII)); final HttpClientContext context = HttpClientContext.create(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); context.setCredentialsProvider(credsProvider); client.execute(target, httppost, context, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity); EntityUtils.consume(entity); return null; }); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } @Test void testBasicAuthenticationFailureOnNonRepeatablePost() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpPost httppost = new HttpPost("/"); httppost.setEntity(new InputStreamEntity( new ByteArrayInputStream( new byte[]{0, 1, 2, 3, 4, 5, 6, 7, 8, 9}), -1, null)); final HttpClientContext context = HttpClientContext.create(); context.setRequestConfig(RequestConfig.custom() .setExpectContinueEnabled(false) .build()); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); context.setCredentialsProvider(credsProvider); client.execute(target, httppost, context, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(401, response.getCode()); Assertions.assertNotNull(entity); EntityUtils.consume(entity); return null; }); } @Test void testBasicAuthenticationCredentialsCaching() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final DefaultAuthenticationStrategy authStrategy = Mockito.spy(new DefaultAuthenticationStrategy()); final Queue responseQueue = new ConcurrentLinkedQueue<>(); configureClient(builder -> builder .setTargetAuthenticationStrategy(authStrategy) .addResponseInterceptorLast((response, entity, context) -> responseQueue.add(BasicResponseBuilder.copy(response).build()))); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(CredentialsProviderBuilder.create() .add(target, "test", "test".toCharArray()) .build()); for (int i = 0; i < 5; i++) { final HttpGet httpget = new HttpGet("/"); client.execute(target, httpget, context, response -> { final HttpEntity entity1 = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity1); EntityUtils.consume(entity1); return null; }); } Mockito.verify(authStrategy).select(Mockito.any(), Mockito.any(), Mockito.any()); assertThat( responseQueue.stream().map(HttpResponse::getCode).collect(Collectors.toList()), CoreMatchers.equalTo(Arrays.asList(401, 200, 200, 200, 200, 200))); } @Test void testBasicAuthenticationCredentialsCachingByPathPrefix() throws Exception { configureServerWithBasicAuth(bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final DefaultAuthenticationStrategy authStrategy = Mockito.spy(new DefaultAuthenticationStrategy()); final Queue responseQueue = new ConcurrentLinkedQueue<>(); configureClient(builder -> builder .setTargetAuthenticationStrategy(authStrategy) .addResponseInterceptorLast((response, entity, context) -> responseQueue.add(BasicResponseBuilder.copy(response).build()))); final TestClient client = client(); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(target, "test", "test".toCharArray()) .build(); final AuthCache authCache = new BasicAuthCache(); final HttpClientContext context = HttpClientContext.create(); context.setAuthCache(authCache); context.setCredentialsProvider(credentialsProvider); for (final String requestPath : new String[]{"/blah/a", "/blah/b?huh", "/blah/c", "/bl%61h/%61"}) { final HttpGet httpget = new HttpGet(requestPath); client.execute(target, httpget, context, response -> { final HttpEntity entity1 = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity1); EntityUtils.consume(entity1); return null; }); } // There should be only single auth strategy call for all successful message exchanges Mockito.verify(authStrategy).select(Mockito.any(), Mockito.any(), Mockito.any()); assertThat( responseQueue.stream().map(HttpResponse::getCode).collect(Collectors.toList()), CoreMatchers.equalTo(Arrays.asList(401, 200, 200, 200, 200))); responseQueue.clear(); authCache.clear(); Mockito.reset(authStrategy); for (final String requestPath : new String[]{"/blah/a", "/yada/a", "/blah/blah/", "/buh/a"}) { final HttpGet httpget = new HttpGet(requestPath); client.execute(target, httpget, context, response -> { final HttpEntity entity1 = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity1); EntityUtils.consume(entity1); return null; }); } // There should be an auth strategy call for all successful message exchanges Mockito.verify(authStrategy, Mockito.times(2)).select(Mockito.any(), Mockito.any(), Mockito.any()); assertThat( responseQueue.stream().map(HttpResponse::getCode).collect(Collectors.toList()), CoreMatchers.equalTo(Arrays.asList(200, 401, 200, 200, 401, 200))); } @Test void testAuthenticationCredentialsCachingReAuthenticationOnDifferentRealm() throws Exception { configureServerWithBasicAuth(new Authenticator() { @Override public boolean authenticate(final URIAuthority authority, final String requestUri, final String credentials) { if (requestUri.equals("/this")) { return "test:this".equals(credentials); } else if (requestUri.equals("/that")) { return "test:that".equals(credentials); } else { return "test:test".equals(credentials); } } @Override public String getRealm(final URIAuthority authority, final String requestUri) { if (requestUri.equals("/this")) { return "this realm"; } else if (requestUri.equals("/that")) { return "that realm"; } else { return "test realm"; } } }, bootstrap -> bootstrap.register("*", new EchoHandler())); final HttpHost target = startServer(); final DefaultAuthenticationStrategy authStrategy = Mockito.spy(new DefaultAuthenticationStrategy()); configureClient(builder -> builder .setTargetAuthenticationStrategy(authStrategy) ); final TestClient client = client(); final CredentialsProvider credsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(target, "this realm", null), "test", "this".toCharArray()) .add(new AuthScope(target, "that realm", null), "test", "that".toCharArray()) .build(); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credsProvider); final HttpGet httpget1 = new HttpGet("/this"); client.execute(target, httpget1, context, response -> { final HttpEntity entity1 = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity1); EntityUtils.consume(entity1); return null; }); final HttpGet httpget2 = new HttpGet("/this"); client.execute(target, httpget2, context, response -> { final HttpEntity entity2 = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity2); EntityUtils.consume(entity2); return null; }); final HttpGet httpget3 = new HttpGet("/that"); client.execute(target, httpget3, context, response -> { final HttpEntity entity3 = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity3); EntityUtils.consume(entity3); return null; }); Mockito.verify(authStrategy, Mockito.times(2)).select(Mockito.any(), Mockito.any(), Mockito.any()); } @Test void testAuthenticationUserinfoInRequest() throws Exception { configureServer(bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpGet httpget = new HttpGet("http://test:test@" + target.toHostString() + "/"); final HttpClientContext context = HttpClientContext.create(); Assertions.assertThrows(ClientProtocolException.class, () -> client.execute(target, httpget, context, response -> null)); } @Test void testPreemptiveAuthentication() throws Exception { final Authenticator authenticator = Mockito.spy(new BasicTestAuthenticator("test:test", "test realm")); configureServerWithBasicAuth(authenticator, bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final BasicScheme basicScheme = new BasicScheme(); basicScheme.initPreemptive(new UsernamePasswordCredentials("test", "test".toCharArray())); final HttpClientContext context = HttpClientContext.create(); final AuthCache authCache = new BasicAuthCache(); authCache.put(target, basicScheme); context.setAuthCache(authCache); final HttpGet httpget = new HttpGet("/"); client.execute(target, httpget, context, response -> { final HttpEntity entity1 = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity1); EntityUtils.consume(entity1); return null; }); Mockito.verify(authenticator).authenticate(Mockito.any(), Mockito.any(), Mockito.any()); } @Test void testPreemptiveAuthenticationFailure() throws Exception { final Authenticator authenticator = Mockito.spy(new BasicTestAuthenticator("test:test", "test realm")); configureServerWithBasicAuth(authenticator, bootstrap -> bootstrap .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final AuthCache authCache = new BasicAuthCache(); authCache.put(target, new BasicScheme()); context.setAuthCache(authCache); context.setCredentialsProvider(CredentialsProviderBuilder.create() .add(target, "test", "stuff".toCharArray()) .build()); final HttpGet httpget = new HttpGet("/"); client.execute(target, httpget, context, response -> { final HttpEntity entity1 = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); Assertions.assertNotNull(entity1); EntityUtils.consume(entity1); return null; }); Mockito.verify(authenticator).authenticate(Mockito.any(), Mockito.any(), Mockito.any()); } static class ProxyAuthHandler implements HttpRequestHandler { @Override public void handle( final ClassicHttpRequest request, final ClassicHttpResponse response, final HttpContext context) { final String creds = (String) context.getAttribute("creds"); if (creds == null || !creds.equals("test:test")) { response.setCode(HttpStatus.SC_PROXY_AUTHENTICATION_REQUIRED); } else { response.setCode(HttpStatus.SC_OK); final StringEntity entity = new StringEntity("success", StandardCharsets.US_ASCII); response.setEntity(entity); } } } @Test void testAuthenticationTargetAsProxy() throws Exception { configureServer(bootstrap -> bootstrap .register("*", new ProxyAuthHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); context.setCredentialsProvider(credsProvider); final HttpGet httpget = new HttpGet("/"); client.execute(target, httpget, context, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_PROXY_AUTHENTICATION_REQUIRED, response.getCode()); EntityUtils.consume(entity); return null; }); } @Test void testConnectionCloseAfterAuthenticationSuccess() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new AuthenticatingDecorator(requestHandler, new BasicTestAuthenticator("test:test", "test realm")) { @Override protected void customizeUnauthorizedResponse(final ClassicHttpResponse unauthorized) { unauthorized.addHeader(HttpHeaders.CONNECTION, HeaderElements.CLOSE); } } ) .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final CredentialsProvider credsProvider = CredentialsProviderBuilder.create() .add(target, "test", "test".toCharArray()) .build(); context.setCredentialsProvider(credsProvider); for (int i = 0; i < 2; i++) { final HttpGet httpget = new HttpGet("/"); client.execute(target, httpget, context, response -> { EntityUtils.consume(response.getEntity()); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); return null; }); } } @Test void testReauthentication() throws Exception { final BasicSchemeFactory myBasicAuthSchemeFactory = new BasicSchemeFactory() { @Override public AuthScheme create(final HttpContext context) { return new BasicScheme() { private static final long serialVersionUID = 1L; @Override public String getName() { return "MyBasic"; } }; } }; final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); final RequestConfig config = RequestConfig.custom() .setTargetPreferredAuthSchemes(Collections.singletonList("MyBasic")) .build(); final Registry authSchemeRegistry = RegistryBuilder.create() .register("MyBasic", myBasicAuthSchemeFactory) .build(); final Authenticator authenticator = new BasicTestAuthenticator("test:test", "test realm") { private final AtomicLong count = new AtomicLong(0); @Override public boolean authenticate(final URIAuthority authority, final String requestUri, final String credentials) { final boolean authenticated = super.authenticate(authority, requestUri, credentials); if (authenticated) { return this.count.incrementAndGet() % 4 != 0; } return false; } }; configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new AuthenticatingDecorator(requestHandler, authenticator) { @Override protected void customizeUnauthorizedResponse(final ClassicHttpResponse unauthorized) { unauthorized.removeHeaders(HttpHeaders.WWW_AUTHENTICATE); unauthorized.addHeader(HttpHeaders.WWW_AUTHENTICATE, "MyBasic realm=\"test realm\""); } } ) .register("*", new EchoHandler())); final HttpHost target = startServer(); configureClient(builder -> builder .setDefaultAuthSchemeRegistry(authSchemeRegistry) ); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); context.setCredentialsProvider(credsProvider); for (int i = 0; i < 10; i++) { final HttpGet httpget = new HttpGet("/"); httpget.setConfig(config); client.execute(target, httpget, context, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity); EntityUtils.consume(entity); return null; }); } } @Test void testAuthenticationFallback() throws Exception { configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new AuthenticatingDecorator(requestHandler, new BasicTestAuthenticator("test:test", "test realm")) { @Override protected void customizeUnauthorizedResponse(final ClassicHttpResponse unauthorized) { unauthorized.addHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.DIGEST + " realm=\"test realm\" invalid"); } } ) .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new UsernamePasswordCredentials("test", "test".toCharArray())); context.setCredentialsProvider(credsProvider); final HttpGet httpget = new HttpGet("/"); client.execute(target, httpget, context, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity); EntityUtils.consume(entity); return null; }); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "basic")), Mockito.any()); } private final static String CHARS = "0123456789abcdef"; @Test void testBearerTokenAuthentication() throws Exception { final SecureRandom secureRandom = SecureRandom.getInstanceStrong(); secureRandom.setSeed(System.currentTimeMillis()); final StringBuilder buf = new StringBuilder(); for (int i = 0; i < 16; i++) { buf.append(CHARS.charAt(secureRandom.nextInt(CHARS.length() - 1))); } final String token = buf.toString(); configureServer(bootstrap -> bootstrap .setExchangeHandlerDecorator(requestHandler -> new AuthenticatingDecorator( requestHandler, new BearerAuthenticationHandler(), new BasicTestAuthenticator(token, "test realm")) ) .register("*", new EchoHandler())); final HttpHost target = startServer(); final TestClient client = client(); final CredentialsProvider credsProvider = Mockito.mock(CredentialsProvider.class); final HttpClientContext context1 = HttpClientContext.create(); context1.setCredentialsProvider(credsProvider); final HttpGet httpget1 = new HttpGet("/"); client.execute(target, httpget1, context1, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); Assertions.assertNotNull(entity); EntityUtils.consume(entity); return null; }); Mockito.verify(credsProvider).getCredentials( Mockito.eq(new AuthScope(target, "test realm", "bearer")), Mockito.any()); final HttpClientContext context2 = HttpClientContext.create(); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new BearerToken(token)); context2.setCredentialsProvider(credsProvider); final HttpGet httpget2 = new HttpGet("/"); client.execute(target, httpget2, context2, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_OK, response.getCode()); Assertions.assertNotNull(entity); EntityUtils.consume(entity); return null; }); final HttpClientContext context3 = HttpClientContext.create(); Mockito.when(credsProvider.getCredentials(Mockito.any(), Mockito.any())) .thenReturn(new BearerToken(token + "-expired")); context3.setCredentialsProvider(credsProvider); final HttpGet httpget3 = new HttpGet("/"); client.execute(target, httpget3, context3, response -> { final HttpEntity entity = response.getEntity(); Assertions.assertEquals(HttpStatus.SC_UNAUTHORIZED, response.getCode()); Assertions.assertNotNull(entity); EntityUtils.consume(entity); return null; }); } } httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestConnectionReuse.java0100664 0000000 0000000 00000032450 15063503632 031427 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import java.io.ByteArrayInputStream; import java.net.URI; import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.List; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.testing.classic.RandomHandler; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.impl.HttpProcessors; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.protocol.HttpContext; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestConnectionReuse extends AbstractIntegrationTestBase { public TestConnectionReuse() { super(URIScheme.HTTP, ClientProtocolLevel.STANDARD); } @Test void testReuseOfPersistentConnections() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(5); connManager.setDefaultMaxPerRoute(5); final WorkerThread[] workers = new WorkerThread[10]; for (int i = 0; i < workers.length; i++) { workers[i] = new WorkerThread( client, target, new URI("/random/2000"), 10, false); } for (final WorkerThread worker : workers) { worker.start(); } for (final WorkerThread worker : workers) { worker.join(10000); final Exception ex = worker.getException(); if (ex != null) { throw ex; } } // Expect leased connections to be returned Assertions.assertEquals(0, connManager.getTotalStats().getLeased()); // Expect some connection in the pool Assertions.assertTrue(connManager.getTotalStats().getAvailable() > 0); } @Test void testReuseOfPersistentConnectionsWithStreamedRequestAndResponse() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(5); connManager.setDefaultMaxPerRoute(5); final WorkerThread[] workers = new WorkerThread[10]; for (int i = 0; i < workers.length; i++) { final List requests = new ArrayList<>(); for (int j = 0; j < 10; j++) { final HttpPost post = new HttpPost(new URI("/random/2000")); // non-repeatable post.setEntity(new InputStreamEntity( new ByteArrayInputStream("test".getBytes(StandardCharsets.UTF_8)), ContentType.APPLICATION_OCTET_STREAM)); requests.add(post); } workers[i] = new WorkerThread(client, target, false, requests); } for (final WorkerThread worker : workers) { worker.start(); } for (final WorkerThread worker : workers) { worker.join(10000); final Exception ex = worker.getException(); if (ex != null) { throw ex; } } // Expect leased connections to be returned Assertions.assertEquals(0, connManager.getTotalStats().getLeased()); // Expect some connection in the pool Assertions.assertTrue(connManager.getTotalStats().getAvailable() > 0); } private static class AlwaysCloseConn implements HttpResponseInterceptor { @Override public void process( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) { response.setHeader(HttpHeaders.CONNECTION, HeaderElements.CLOSE); } } @Test void testReuseOfClosedConnections() throws Exception { configureServer(bootstrap -> bootstrap .setHttpProcessor(HttpProcessors.customServer(null) .add(new AlwaysCloseConn()) .build())); final HttpHost target = startServer(); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(5); connManager.setDefaultMaxPerRoute(5); final WorkerThread[] workers = new WorkerThread[10]; for (int i = 0; i < workers.length; i++) { workers[i] = new WorkerThread( client, target, new URI("/random/2000"), 10, false); } for (final WorkerThread worker : workers) { worker.start(); } for (final WorkerThread worker : workers) { worker.join(10000); final Exception ex = worker.getException(); if (ex != null) { throw ex; } } // Expect leased connections to be returned Assertions.assertEquals(0, connManager.getTotalStats().getLeased()); // Expect zero connections in the pool Assertions.assertEquals(0, connManager.getTotalStats().getAvailable()); } @Test void testReuseOfAbortedConnections() throws Exception { configureServer(bootstrap -> bootstrap .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(5); connManager.setDefaultMaxPerRoute(5); final WorkerThread[] workers = new WorkerThread[10]; for (int i = 0; i < workers.length; i++) { workers[i] = new WorkerThread( client, target, new URI("/random/2000"), 10, true); } for (final WorkerThread worker : workers) { worker.start(); } for (final WorkerThread worker : workers) { worker.join(10000); final Exception ex = worker.getException(); if (ex != null) { throw ex; } } // Expect leased connections to be returned Assertions.assertEquals(0, connManager.getTotalStats().getLeased()); // Expect some connections in the pool Assertions.assertTrue(connManager.getTotalStats().getAvailable() > 0); } @Test void testKeepAliveHeaderRespected() throws Exception { configureServer(bootstrap -> bootstrap .setHttpProcessor(HttpProcessors.customServer(null) .add(new ResponseKeepAlive()) .build()) .register("/random/*", new RandomHandler())); final HttpHost target = startServer(); final TestClient client = client(); final PoolingHttpClientConnectionManager connManager = client.getConnectionManager(); connManager.setMaxTotal(1); connManager.setDefaultMaxPerRoute(1); client.execute(target, new HttpGet("/random/2000"), response -> { EntityUtils.consume(response.getEntity()); return null; }); Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); client.execute(target, new HttpGet("/random/2000"), response -> { EntityUtils.consume(response.getEntity()); return null; }); Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); // Now sleep for 1.1 seconds and let the timeout do its work Thread.sleep(1100); client.execute(target, new HttpGet("/random/2000"), response -> { EntityUtils.consume(response.getEntity()); return null; }); Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); // Do another request just under the 1 second limit & make // sure we reuse that connection. Thread.sleep(500); client.execute(target, new HttpGet("/random/2000"), response -> { EntityUtils.consume(response.getEntity()); return null; }); // Expect leased connections to be returned Assertions.assertEquals(0, connManager.getTotalStats().getLeased()); Assertions.assertEquals(1, connManager.getTotalStats().getAvailable()); } private static class WorkerThread extends Thread { private final HttpHost target; private final CloseableHttpClient httpclient; private final boolean forceClose; private final List requests; private volatile Exception exception; public WorkerThread( final CloseableHttpClient httpclient, final HttpHost target, final URI requestURI, final int repetitions, final boolean forceClose) { super(); this.httpclient = httpclient; this.target = target; this.forceClose = forceClose; this.requests = new ArrayList<>(repetitions); for (int i = 0; i < repetitions; i++) { requests.add(new HttpGet(requestURI)); } } public WorkerThread( final CloseableHttpClient httpclient, final HttpHost target, final boolean forceClose, final List requests) { super(); this.httpclient = httpclient; this.target = target; this.forceClose = forceClose; this.requests = requests; } @Override public void run() { try { for (final ClassicHttpRequest request : requests) { this.httpclient.execute(this.target, request, response -> { if (this.forceClose) { response.close(); } else { EntityUtils.consume(response.getEntity()); } return null; }); } } catch (final Exception ex) { this.exception = ex; } } public Exception getException() { return exception; } } // A very basic keep-alive header interceptor, to add Keep-Alive: timeout=1 // if there is no Connection: close header. private static class ResponseKeepAlive implements HttpResponseInterceptor { @Override public void process( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) { final Header connection = response.getFirstHeader(HttpHeaders.CONNECTION); if (connection != null) { if (!connection.getValue().equalsIgnoreCase("Close")) { response.addHeader(HeaderElements.KEEP_ALIVE, "timeout=1"); } } } } } ././@LongLink0100644 0000000 0000000 00000000147 15036651120 011634 Lustar 0000000 0000000 httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestClientRequestReExecution.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestClientRequestReExecution.ja0100664 0000000 0000000 00000011565 15036651120 032737 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.testing.sync; import static org.hamcrest.MatcherAssert.assertThat; import java.util.concurrent.atomic.AtomicInteger; import org.apache.hc.client5.http.impl.DefaultHttpRequestRetryStrategy; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.testing.classic.RandomHandler; import org.apache.hc.client5.testing.classic.ServiceUnavailableDecorator; import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel; import org.apache.hc.client5.testing.extension.sync.TestClient; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.util.TimeValue; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; abstract class TestClientRequestReExecution extends AbstractIntegrationTestBase { public TestClientRequestReExecution(final URIScheme scheme) { super(scheme, ClientProtocolLevel.STANDARD); } @BeforeEach void setup() { final Resolver serviceAvailabilityResolver = new Resolver() { private final AtomicInteger count = new AtomicInteger(0); @Override public TimeValue resolve(final HttpRequest request) { final int n = count.incrementAndGet(); return n <= 3 ? TimeValue.ofSeconds(1) : null; } }; configureServer(bootstrap -> bootstrap.setExchangeHandlerDecorator(handler -> new ServiceUnavailableDecorator(handler, serviceAvailabilityResolver))); } @Test void testGiveUpAfterOneRetry() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", new RandomHandler())); final HttpHost target = startServer(); configureClient(builder -> builder .setRetryStrategy(new DefaultHttpRequestRetryStrategy(1, TimeValue.ofSeconds(1)))); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = ClassicRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(); final HttpResponse response = client.execute(target, request, context, r -> { EntityUtils.consume(r.getEntity()); return r; }); assertThat(response.getCode(), CoreMatchers.equalTo(HttpStatus.SC_SERVICE_UNAVAILABLE)); } @Test void testDoNotGiveUpEasily() throws Exception { configureServer(bootstrap -> bootstrap.register("/random/*", new RandomHandler())); final HttpHost target = startServer(); configureClient(builder -> builder .setRetryStrategy(new DefaultHttpRequestRetryStrategy(5, TimeValue.ofSeconds(1)))); final TestClient client = client(); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = ClassicRequestBuilder.get() .setHttpHost(target) .setPath("/random/2048") .build(); final HttpResponse response = client.execute(target, request, context, r -> { EntityUtils.consume(r.getEntity()); return r; }); assertThat(response.getCode(), CoreMatchers.equalTo(HttpStatus.SC_OK)); } } httpclient5-testing/pom.xml0100664 0000000 0000000 00000012070 15064565770 015061 0ustar000000000 0000000 4.0.0 org.apache.httpcomponents.client5 httpclient5-parent 5.5.1 httpclient5-testing Apache HttpClient Integration Tests Apache HttpClient integration tests jar org.apache.httpcomponents.client5.httpclient5.testing org.apache.httpcomponents.core5 httpcore5-testing org.apache.httpcomponents.core5 httpcore5-reactive test org.apache.httpcomponents.client5 httpclient5 org.slf4j slf4j-api org.apache.logging.log4j log4j-slf4j-impl true org.apache.logging.log4j log4j-core true org.apache.httpcomponents.client5 httpclient5-cache test org.apache.httpcomponents.client5 httpclient5-fluent test org.junit.jupiter junit-jupiter test org.hamcrest hamcrest test org.mockito mockito-core test io.reactivex.rxjava2 rxjava test org.testcontainers testcontainers test org.testcontainers junit-jupiter test docker org.apache.maven.plugins maven-failsafe-plugin ${hc.surefire.version} integration-test verify maven-project-info-reports-plugin false index dependencies dependency-info summary src/0040775 0000000 0000000 00000000000 14666635064 010421 5ustar000000000 0000000 src/site/0040775 0000000 0000000 00000000000 14666635064 011365 5ustar000000000 0000000 src/site/resources/0040775 0000000 0000000 00000000000 14666635064 013377 5ustar000000000 0000000 src/site/resources/css/0040775 0000000 0000000 00000000000 14666635064 014167 5ustar000000000 0000000 src/site/resources/css/site.css0100664 0000000 0000000 00000001514 14666635064 015643 0ustar000000000 0000000 /* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ @import url("/css/hc-maven.css"); src/site/site.xml0100664 0000000 0000000 00000006423 14666635064 013055 0ustar000000000 0000000 org.apache.httpcomponents maven-site-skin 1.1 Apache http://www.apache.org/images/asf_logo_wide.gif http://www.apache.org/ HttpComponents http://hc.apache.org/images/logos/httpcomponents.png http://hc.apache.org/
Apache HttpComponents, Commons HttpClient, Apache, the Apache feather logo, and the Apache HttpComponents project logo are trademarks of The Apache Software Foundation.

All other marks mentioned may be trademarks or registered trademarks of their respective owners.
 NOTICE.txt0100664 0000000 0000000 00000001043 15012321542 011322 0ustar000000000 0000000 Apache HttpComponents Client Copyright 1999-2025 The Apache Software Foundation This product includes software developed at The Apache Software Foundation (http://www.apache.org/). This product includes a copy of in https://publicsuffix.org/list/effective_tld_names.dat in httpclient5/src/test/resources/org/publicsuffix/list/effective_tld_names.dat This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/. LICENSE.txt0100664 0000000 0000000 00000065075 14246155574 011464 0ustar000000000 0000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS ========================================================================= This project includes Public Suffix List copied from licensed under the terms of the Mozilla Public License, v. 2.0 Full license text: Mozilla Public License Version 2.0 ================================== 1. Definitions -------------- 1.1. "Contributor" means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. 1.2. "Contributor Version" means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor's Contribution. 1.3. "Contribution" means Covered Software of a particular Contributor. 1.4. "Covered Software" means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. 1.5. "Incompatible With Secondary Licenses" means (a) that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or (b) that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. 1.6. "Executable Form" means any form of the work other than Source Code Form. 1.7. "Larger Work" means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. 1.8. "License" means this document. 1.9. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. 1.10. "Modifications" means any of the following: (a) any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or (b) any new file in Source Code Form that contains any Covered Software. 1.11. "Patent Claims" of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. 1.12. "Secondary License" means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. 1.13. "Source Code Form" means the form of the work preferred for making modifications. 1.14. "You" (or "Your") means an individual or a legal entity exercising rights under this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. 2. License Grants and Conditions -------------------------------- 2.1. Grants Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: (a) under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and (b) under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. 2.2. Effective Date The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. 2.3. Limitations on Grant Scope The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: (a) for any code that a Contributor has removed from Covered Software; or (b) for infringements caused by: (i) Your and any other third party's modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or (c) under Patent Claims infringed by Covered Software in the absence of its Contributions. This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). 2.4. Subsequent Licenses No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). 2.5. Representation Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. 2.6. Fair Use This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. 2.7. Conditions Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. 3. Responsibilities ------------------- 3.1. Distribution of Source Form All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients' rights in the Source Code Form. 3.2. Distribution of Executable Form If You distribute Covered Software in Executable Form then: (a) such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and (b) You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients' rights in the Source Code Form under this License. 3.3. Distribution of a Larger Work You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). 3.4. Notices You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. 3.5. Application of Additional Terms You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. 4. Inability to Comply Due to Statute or Regulation --------------------------------------------------- If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. 5. Termination -------------- 5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. 5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. ************************************************************************ * * * 6. Disclaimer of Warranty * * ------------------------- * * * * Covered Software is provided under this License on an "as is" * * basis, without warranty of any kind, either expressed, implied, or * * statutory, including, without limitation, warranties that the * * Covered Software is free of defects, merchantable, fit for a * * particular purpose or non-infringing. The entire risk as to the * * quality and performance of the Covered Software is with You. * * Should any Covered Software prove defective in any respect, You * * (not any Contributor) assume the cost of any necessary servicing, * * repair, or correction. This disclaimer of warranty constitutes an * * essential part of this License. No use of any Covered Software is * * authorized under this License except under this disclaimer. * * * ************************************************************************ ************************************************************************ * * * 7. Limitation of Liability * * -------------------------- * * * * Under no circumstances and under no legal theory, whether tort * * (including negligence), contract, or otherwise, shall any * * Contributor, or anyone who distributes Covered Software as * * permitted above, be liable to You for any direct, indirect, * * special, incidental, or consequential damages of any character * * including, without limitation, damages for lost profits, loss of * * goodwill, work stoppage, computer failure or malfunction, or any * * and all other commercial damages or losses, even if such party * * shall have been informed of the possibility of such damages. This * * limitation of liability shall not apply to liability for death or * * personal injury resulting from such party's negligence to the * * extent applicable law prohibits such limitation. Some * * jurisdictions do not allow the exclusion or limitation of * * incidental or consequential damages, so this exclusion and * * limitation may not apply to You. * * * ************************************************************************ 8. Litigation ------------- Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party's ability to bring cross-claims or counter-claims. 9. Miscellaneous ---------------- This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. 10. Versions of the License --------------------------- 10.1. New Versions Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. 10.2. Effect of New Versions You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. 10.3. Modified Versions If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. Exhibit A - Source Code Form License Notice ------------------------------------------- This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. Exhibit B - "Incompatible With Secondary Licenses" Notice --------------------------------------------------------- This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0. httpclient5-cache/0040775 0000000 0000000 00000000000 15063503632 013121 5ustar000000000 0000000 httpclient5-cache/src/0040775 0000000 0000000 00000000000 14666635064 013725 5ustar000000000 0000000 httpclient5-cache/src/main/0040775 0000000 0000000 00000000000 14666635064 014651 5ustar000000000 0000000 httpclient5-cache/src/main/java/0040775 0000000 0000000 00000000000 14666635064 015572 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/0040775 0000000 0000000 00000000000 14666635064 016361 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/0040775 0000000 0000000 00000000000 14666635064 017602 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/0040775 0000000 0000000 00000000000 14666635064 020174 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/0040775 0000000 0000000 00000000000 14666635064 021537 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/0040775 0000000 0000000 00000000000 14666635064 022516 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/0040775 0000000 0000000 00000000000 15005672016 023543 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/package-info.java0100664 0000000 0000000 00000002441 14666635064 026746 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Caching APIs for both the classic and the asynchronous * HTTP transports. */ package org.apache.hc.client5.http.cache; httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpCacheContext.java0100664 0000000 0000000 00000037250 14704162037 027624 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.util.Map; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectLocations; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.EndpointDetails; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.protocol.HttpContext; /** * Cache execution {@link HttpContext}. This class can be re-used for * multiple consecutive logically related request executions that represent * a single communication session. This context may not be used concurrently. *

* IMPORTANT: This class is NOT thread-safe and MUST NOT be used concurrently by * multiple message exchanges. * * @since 4.3 */ public class HttpCacheContext extends HttpClientContext { /** * @deprecated Use getter methods */ @Deprecated public static final String CACHE_RESPONSE_STATUS = "http.cache.response.status"; static final String REQUEST_CACHE_CONTROL = "http.cache.request-control"; static final String RESPONSE_CACHE_CONTROL = "http.cache.response-control"; static final String CACHE_ENTRY = "http.cache.entry"; /** * @deprecated Use {@link #castOrCreate(HttpContext)}. */ @Deprecated public static HttpCacheContext adapt(final HttpContext context) { if (context instanceof HttpCacheContext) { return (HttpCacheContext) context; } return new Delegate(HttpClientContext.castOrCreate(context)); } /** * Casts the given generic {@link HttpContext} as {@link HttpCacheContext} or * throws an {@link IllegalStateException} if the given context is not suitable. * * @since 5.4 */ public static HttpCacheContext cast(final HttpContext context) { if (context == null) { return null; } if (context instanceof HttpCacheContext) { return (HttpCacheContext) context; } else if (context instanceof HttpClientContext) { return new Delegate((HttpClientContext) context); } else { return new Delegate(HttpClientContext.cast(context)); } } /** * Casts the given generic {@link HttpContext} as {@link HttpCacheContext} or * creates new {@link HttpCacheContext} if the given context is null.. * * @since 5.4 */ public static HttpCacheContext castOrCreate(final HttpContext context) { return context != null ? cast(context) : create(); } public static HttpCacheContext create() { return new HttpCacheContext(); } private CacheResponseStatus responseStatus; private RequestCacheControl requestCacheControl; private ResponseCacheControl responseCacheControl; private HttpCacheEntry cacheEntry; public HttpCacheContext(final HttpContext context) { super(context); } public HttpCacheContext() { super(); } /** * Represents an outcome of the cache operation and the way the response has been * generated. *

* This context attribute is expected to be populated by the protocol handler. */ public CacheResponseStatus getCacheResponseStatus() { return responseStatus; } /** * @since 5.4 */ @Internal public void setCacheResponseStatus(final CacheResponseStatus responseStatus) { this.responseStatus = responseStatus; } /** * Represents cache control requested by the client. *

* This context attribute is expected to be set by the caller. * * @since 5.4 */ public RequestCacheControl getRequestCacheControl() { return requestCacheControl; } /** * Returns cache control requested by the client or {@link RequestCacheControl#DEFAULT} * if not explicitly set in the context. * * @since 5.4 */ public final RequestCacheControl getRequestCacheControlOrDefault() { final RequestCacheControl cacheControl = getRequestCacheControl(); return cacheControl != null ? cacheControl : RequestCacheControl.DEFAULT; } /** * @since 5.4 */ @Internal public void setRequestCacheControl(final RequestCacheControl requestCacheControl) { this.requestCacheControl = requestCacheControl; } /** * Represents cache control enforced by the server. *

* This context attribute is expected to be populated by the protocol handler. * * @since 5.4 */ public ResponseCacheControl getResponseCacheControl() { return responseCacheControl; } /** * Represents cache control enforced by the server or {@link ResponseCacheControl#DEFAULT} * if not explicitly set in the context. * * @since 5.4 */ public final ResponseCacheControl getResponseCacheControlOrDefault() { final ResponseCacheControl cacheControl = getResponseCacheControl(); return cacheControl != null ? cacheControl : ResponseCacheControl.DEFAULT; } /** * @since 5.4 */ @Internal public void setResponseCacheControl(final ResponseCacheControl responseCacheControl) { this.responseCacheControl = responseCacheControl; } /** * Represents the cache entry the resource of which has been used to generate the response. *

* This context attribute is expected to be populated by the protocol handler. * * @since 5.4 */ public HttpCacheEntry getCacheEntry() { return cacheEntry; } /** * @since 5.4 */ @Internal public void setCacheEntry(final HttpCacheEntry cacheEntry) { this.cacheEntry = cacheEntry; } /** * Internal adaptor class that delegates all its method calls to {@link HttpClientContext}. * To be removed in the future. */ @SuppressWarnings("deprecation") @Internal static class Delegate extends HttpCacheContext { private final HttpClientContext clientContext; Delegate(final HttpClientContext clientContext) { super(null); this.clientContext = clientContext; } @Override public CacheResponseStatus getCacheResponseStatus() { return clientContext.getAttribute(CACHE_RESPONSE_STATUS, CacheResponseStatus.class); } @Override public void setCacheResponseStatus(final CacheResponseStatus responseStatus) { clientContext.setAttribute(CACHE_RESPONSE_STATUS, responseStatus); } @Override public RequestCacheControl getRequestCacheControl() { return clientContext.getAttribute(REQUEST_CACHE_CONTROL, RequestCacheControl.class); } @Override public void setRequestCacheControl(final RequestCacheControl requestCacheControl) { clientContext.setAttribute(REQUEST_CACHE_CONTROL, requestCacheControl); } @Override public ResponseCacheControl getResponseCacheControl() { return clientContext.getAttribute(RESPONSE_CACHE_CONTROL, ResponseCacheControl.class); } @Override public void setResponseCacheControl(final ResponseCacheControl responseCacheControl) { clientContext.setAttribute(RESPONSE_CACHE_CONTROL, responseCacheControl); } @Override public HttpCacheEntry getCacheEntry() { return clientContext.getAttribute(CACHE_ENTRY, HttpCacheEntry.class); } @Override public void setCacheEntry(final HttpCacheEntry cacheEntry) { clientContext.setAttribute(CACHE_ENTRY, cacheEntry); } @Override public RouteInfo getHttpRoute() { return clientContext.getHttpRoute(); } @Override @Internal public void setRoute(final HttpRoute route) { clientContext.setRoute(route); } @Override public RedirectLocations getRedirectLocations() { return clientContext.getRedirectLocations(); } @Override @Internal public void setRedirectLocations(final RedirectLocations redirectLocations) { clientContext.setRedirectLocations(redirectLocations); } @Override public CookieStore getCookieStore() { return clientContext.getCookieStore(); } @Override public void setCookieStore(final CookieStore cookieStore) { clientContext.setCookieStore(cookieStore); } @Override public CookieSpec getCookieSpec() { return clientContext.getCookieSpec(); } @Override @Internal public void setCookieSpec(final CookieSpec cookieSpec) { clientContext.setCookieSpec(cookieSpec); } @Override public CookieOrigin getCookieOrigin() { return clientContext.getCookieOrigin(); } @Override @Internal public void setCookieOrigin(final CookieOrigin cookieOrigin) { clientContext.setCookieOrigin(cookieOrigin); } @Override public Lookup getCookieSpecRegistry() { return clientContext.getCookieSpecRegistry(); } @Override public void setCookieSpecRegistry(final Lookup lookup) { clientContext.setCookieSpecRegistry(lookup); } @Override public Lookup getAuthSchemeRegistry() { return clientContext.getAuthSchemeRegistry(); } @Override public void setAuthSchemeRegistry(final Lookup lookup) { clientContext.setAuthSchemeRegistry(lookup); } @Override public CredentialsProvider getCredentialsProvider() { return clientContext.getCredentialsProvider(); } @Override public void setCredentialsProvider(final CredentialsProvider credentialsProvider) { clientContext.setCredentialsProvider(credentialsProvider); } @Override public AuthCache getAuthCache() { return clientContext.getAuthCache(); } @Override public void setAuthCache(final AuthCache authCache) { clientContext.setAuthCache(authCache); } @Override public Map getAuthExchanges() { return clientContext.getAuthExchanges(); } @Override public AuthExchange getAuthExchange(final HttpHost host) { return clientContext.getAuthExchange(host); } @Override public void setAuthExchange(final HttpHost host, final AuthExchange authExchange) { clientContext.setAuthExchange(host, authExchange); } @Override public void resetAuthExchange(final HttpHost host, final AuthScheme authScheme) { clientContext.resetAuthExchange(host, authScheme); } @Override public Object getUserToken() { return clientContext.getUserToken(); } @Override public void setUserToken(final Object userToken) { clientContext.setUserToken(userToken); } @Override public RequestConfig getRequestConfig() { return clientContext.getRequestConfig(); } @Override public void setRequestConfig(final RequestConfig requestConfig) { clientContext.setRequestConfig(requestConfig); } @Override public String getExchangeId() { return clientContext.getExchangeId(); } @Override public void setExchangeId(final String exchangeId) { clientContext.setExchangeId(exchangeId); } @Override public HttpRequest getRequest() { return clientContext.getRequest(); } @Override public void setRequest(final HttpRequest request) { clientContext.setRequest(request); } @Override public HttpResponse getResponse() { return clientContext.getResponse(); } @Override public void setResponse(final HttpResponse response) { clientContext.setResponse(response); } @Override public EndpointDetails getEndpointDetails() { return clientContext.getEndpointDetails(); } @Override public void setEndpointDetails(final EndpointDetails endpointDetails) { clientContext.setEndpointDetails(endpointDetails); } @Override public SSLSession getSSLSession() { return clientContext.getSSLSession(); } @Override public void setSSLSession(final SSLSession sslSession) { clientContext.setSSLSession(sslSession); } @Override public ProtocolVersion getProtocolVersion() { return clientContext.getProtocolVersion(); } @Override public void setProtocolVersion(final ProtocolVersion version) { clientContext.setProtocolVersion(version); } @Override public Object getAttribute(final String id) { return clientContext.getAttribute(id); } @Override public Object setAttribute(final String id, final Object obj) { return clientContext.setAttribute(id, obj); } @Override public Object removeAttribute(final String id) { return clientContext.removeAttribute(id); } @Override public T getAttribute(final String id, final Class clazz) { return clientContext.getAttribute(id, clazz); } @Override public String toString() { return clientContext.toString(); } } }httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpCacheStorageEntry.java0100664 0000000 0000000 00000004210 14704162040 030606 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.io.Serializable; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * This class contains a {@link HttpCacheEntry} along with its key. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class HttpCacheStorageEntry implements Serializable { private static final long serialVersionUID = 1L; private final String key; private final HttpCacheEntry content; public HttpCacheStorageEntry(final String key, final HttpCacheEntry content) { this.key = Args.notNull(key, "Cache key"); this.content = Args.notNull(content, "Cache entry"); } public String getKey() { return key; } public HttpCacheEntry getContent() { return content; } @Override public String toString() { return "[key=" + key + "; content=" + content + "]"; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/CacheContextBuilder.java0100664 0000000 0000000 00000010243 15005672016 030262 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import org.apache.hc.client5.http.AbstractClientContextBuilder; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.config.Lookup; public class CacheContextBuilder extends AbstractClientContextBuilder { public static CacheContextBuilder create(final SchemePortResolver schemePortResolver) { return new CacheContextBuilder(schemePortResolver); } public static CacheContextBuilder create() { return new CacheContextBuilder(DefaultSchemePortResolver.INSTANCE); } private RequestCacheControl cacheControl; protected CacheContextBuilder(final SchemePortResolver schemePortResolver) { super(schemePortResolver); } @Override public CacheContextBuilder useCookieSpecRegistry(final Lookup cookieSpecRegistry) { super.useCookieSpecRegistry(cookieSpecRegistry); return this; } @Override public CacheContextBuilder useAuthSchemeRegistry(final Lookup authSchemeRegistry) { super.useAuthSchemeRegistry(authSchemeRegistry); return this; } @Override public CacheContextBuilder useCookieStore(final CookieStore cookieStore) { super.useCookieStore(cookieStore); return this; } @Override public CacheContextBuilder useCredentialsProvider(final CredentialsProvider credentialsProvider) { super.useCredentialsProvider(credentialsProvider); return this; } @Override public CacheContextBuilder useAuthCache(final AuthCache authCache) { super.useAuthCache(authCache); return this; } @Override public CacheContextBuilder preemptiveAuth(final HttpHost host, final AuthScheme authScheme) { super.preemptiveAuth(host, authScheme); return this; } @Override public CacheContextBuilder preemptiveBasicAuth(final HttpHost host, final UsernamePasswordCredentials credentials) { super.preemptiveBasicAuth(host, credentials); return this; } public CacheContextBuilder setCacheControl(final RequestCacheControl cacheControl) { this.cacheControl = cacheControl; return this; } @Override protected HttpCacheContext createContext() { return HttpCacheContext.create(); } @Override public HttpCacheContext build() { final HttpCacheContext context = super.build(); context.setRequestCacheControl(cacheControl); return context; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/ResponseCacheControl.java0100664 0000000 0000000 00000040157 14704162040 030471 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.util.Arrays; import java.util.Collections; import java.util.HashSet; import java.util.Set; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Represents the value of the Cache-Control header in an HTTP response, which indicate whether and for how long * the response can be cached by the client and intermediary proxies. *

* The class provides methods to retrieve the maximum age of the response and the maximum age that applies to shared * caches. The values are expressed in seconds, with -1 indicating that the value was not specified in the header. *

* Instances of this class are immutable, meaning that their values cannot be changed once they are set. To create an * instance, use one of the constructors that take the desired values as arguments. Alternatively, use the default * constructor to create an instance with both values set to -1, indicating that the header was not present in the * response. * * @since 5.4 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class ResponseCacheControl implements CacheControl { /** * The max-age directive value. */ private final long maxAge; /** * The shared-max-age directive value. */ private final long sharedMaxAge; /** * The isNoCache flag indicates whether the Cache-Control header includes the no-cache directive. */ private final boolean noCache; /** * The isNoStore flag indicates whether the Cache-Control header includes the no-store directive. */ private final boolean noStore; /** * The isPrivate flag indicates whether the Cache-Control header includes the private directive. */ private final boolean cachePrivate; /** * Indicates whether the Cache-Control header includes the "must-revalidate" directive. */ private final boolean mustRevalidate; /** * Indicates whether the Cache-Control header includes the "proxy-revalidate" directive. */ private final boolean proxyRevalidate; /** * Indicates whether the Cache-Control header includes the "public" directive. */ private final boolean cachePublic; /** * Indicates whether the Cache-Control header includes the "must-understand" directive. */ private final boolean mustUnderstand; /** * The number of seconds that a stale response is considered fresh for the purpose * of serving a response while a revalidation request is made to the origin server. */ private final long staleWhileRevalidate; /** * The number of seconds that a cached stale response MAY be used to satisfy the request, * regardless of other freshness information.. */ private final long staleIfError; /** * A set of field names specified in the "no-cache" directive of the Cache-Control header. */ private final Set noCacheFields; private final boolean undefined; /** * Flag for the 'immutable' Cache-Control directive. * If this field is true, then the 'immutable' directive is present in the Cache-Control header. * The 'immutable' directive is meant to inform a cache or user agent that the response body will not * change over time, even though it may be requested multiple times. */ private final boolean immutable; /** * Creates a new instance of {@code CacheControl} with the specified values. * * @param maxAge The max-age value from the Cache-Control header. * @param sharedMaxAge The shared-max-age value from the Cache-Control header. * @param mustRevalidate The must-revalidate value from the Cache-Control header. * @param noCache The no-cache value from the Cache-Control header. * @param noStore The no-store value from the Cache-Control header. * @param cachePrivate The private value from the Cache-Control header. * @param proxyRevalidate The proxy-revalidate value from the Cache-Control header. * @param cachePublic The public value from the Cache-Control header. * @param staleWhileRevalidate The stale-while-revalidate value from the Cache-Control header. * @param staleIfError The stale-if-error value from the Cache-Control header. * @param noCacheFields The set of field names specified in the "no-cache" directive of the Cache-Control header. * @param mustUnderstand The must-understand value from the Cache-Control header. * @param immutable The immutable value from the Cache-Control header. */ ResponseCacheControl(final long maxAge, final long sharedMaxAge, final boolean mustRevalidate, final boolean noCache, final boolean noStore, final boolean cachePrivate, final boolean proxyRevalidate, final boolean cachePublic, final long staleWhileRevalidate, final long staleIfError, final Set noCacheFields, final boolean mustUnderstand, final boolean immutable) { this.maxAge = maxAge; this.sharedMaxAge = sharedMaxAge; this.noCache = noCache; this.noStore = noStore; this.cachePrivate = cachePrivate; this.mustRevalidate = mustRevalidate; this.proxyRevalidate = proxyRevalidate; this.cachePublic = cachePublic; this.staleWhileRevalidate = staleWhileRevalidate; this.staleIfError = staleIfError; this.noCacheFields = noCacheFields != null ? Collections.unmodifiableSet(noCacheFields) : Collections.emptySet(); this.undefined = maxAge == -1 && sharedMaxAge == -1 && !noCache && !noStore && !cachePrivate && !mustRevalidate && !proxyRevalidate && !cachePublic && staleWhileRevalidate == -1 && staleIfError == -1; this.mustUnderstand = mustUnderstand; this.immutable = immutable; } /** * Returns the max-age value from the Cache-Control header. * * @return The max-age value. */ @Override public long getMaxAge() { return maxAge; } /** * Returns the shared-max-age value from the Cache-Control header. * * @return The shared-max-age value. */ public long getSharedMaxAge() { return sharedMaxAge; } /** * Returns the no-cache flag from the Cache-Control header. * * @return The no-cache flag. */ @Override public boolean isNoCache() { return noCache; } /** * Returns the no-store flag from the Cache-Control header. * * @return The no-store flag. */ @Override public boolean isNoStore() { return noStore; } /** * Returns the private flag from the Cache-Control header. * * @return The private flag. */ public boolean isCachePrivate() { return cachePrivate; } /** * Returns the must-understand directive from the Cache-Control header. * * @return The must-understand directive. */ public boolean isMustUnderstand() { return mustUnderstand; } /** * Returns whether the must-revalidate directive is present in the Cache-Control header. * * @return {@code true} if the must-revalidate directive is present, otherwise {@code false} */ public boolean isMustRevalidate() { return mustRevalidate; } /** * Returns whether the proxy-revalidate value is set in the Cache-Control header. * * @return {@code true} if proxy-revalidate is set, {@code false} otherwise. */ public boolean isProxyRevalidate() { return proxyRevalidate; } /** * Returns whether the public value is set in the Cache-Control header. * * @return {@code true} if public is set, {@code false} otherwise. */ public boolean isPublic() { return cachePublic; } /** * Returns the stale-while-revalidate value from the Cache-Control header. * * @return The stale-while-revalidate value. */ public long getStaleWhileRevalidate() { return staleWhileRevalidate; } /** * Returns the stale-if-error value from the Cache-Control header. * * @return The stale-if-error value. */ @Override public long getStaleIfError() { return staleIfError; } /** * Returns an unmodifiable set of field names specified in the "no-cache" directive of the Cache-Control header. * * @return The set of field names specified in the "no-cache" directive. */ public Set getNoCacheFields() { return noCacheFields; } /** * Returns the 'immutable' Cache-Control directive status. * * @return true if the 'immutable' directive is present in the Cache-Control header. */ public boolean isUndefined() { return undefined; } /** * Returns the 'immutable' Cache-Control directive status. * * @return true if the 'immutable' directive is present in the Cache-Control header. */ public boolean isImmutable() { return immutable; } @Override public String toString() { final StringBuilder buf = new StringBuilder(); buf.append("["); if (maxAge >= 0) { buf.append("max-age=").append(maxAge).append(","); } if (sharedMaxAge >= 0) { buf.append("shared-max-age=").append(sharedMaxAge).append(","); } if (noCache) { buf.append("no-cache").append(","); } if (noStore) { buf.append("no-store").append(","); } if (cachePrivate) { buf.append("private").append(","); } if (cachePublic) { buf.append("public").append(","); } if (mustRevalidate) { buf.append("must-revalidate").append(","); } if (proxyRevalidate) { buf.append("proxy-revalidate").append(","); } if (staleWhileRevalidate >= 0) { buf.append("state-while-revalidate=").append(staleWhileRevalidate).append(","); } if (staleIfError >= 0) { buf.append("stale-if-error").append(staleIfError).append(","); } if (mustUnderstand) { buf.append("must-understand").append(","); } if (immutable) { buf.append("immutable").append(","); } if (buf.charAt(buf.length() - 1) == ',') { buf.setLength(buf.length() - 1); } buf.append("]"); return buf.toString(); } public static Builder builder() { return new Builder(); } public static final ResponseCacheControl DEFAULT = builder().build(); public static class Builder { private long maxAge = -1; private long sharedMaxAge = -1; private boolean noCache; private boolean noStore; private boolean cachePrivate; private boolean mustRevalidate; private boolean proxyRevalidate; private boolean cachePublic; private long staleWhileRevalidate = -1; private long staleIfError = -1; private Set noCacheFields; private boolean mustUnderstand; private boolean immutable; Builder() { } public long getMaxAge() { return maxAge; } public Builder setMaxAge(final long maxAge) { this.maxAge = maxAge; return this; } public long getSharedMaxAge() { return sharedMaxAge; } public Builder setSharedMaxAge(final long sharedMaxAge) { this.sharedMaxAge = sharedMaxAge; return this; } public boolean isNoCache() { return noCache; } public Builder setNoCache(final boolean noCache) { this.noCache = noCache; return this; } public boolean isNoStore() { return noStore; } public Builder setNoStore(final boolean noStore) { this.noStore = noStore; return this; } public boolean isCachePrivate() { return cachePrivate; } public Builder setCachePrivate(final boolean cachePrivate) { this.cachePrivate = cachePrivate; return this; } public boolean isMustRevalidate() { return mustRevalidate; } public Builder setMustRevalidate(final boolean mustRevalidate) { this.mustRevalidate = mustRevalidate; return this; } public boolean isProxyRevalidate() { return proxyRevalidate; } public Builder setProxyRevalidate(final boolean proxyRevalidate) { this.proxyRevalidate = proxyRevalidate; return this; } public boolean isCachePublic() { return cachePublic; } public Builder setCachePublic(final boolean cachePublic) { this.cachePublic = cachePublic; return this; } public long getStaleWhileRevalidate() { return staleWhileRevalidate; } public Builder setStaleWhileRevalidate(final long staleWhileRevalidate) { this.staleWhileRevalidate = staleWhileRevalidate; return this; } public long getStaleIfError() { return staleIfError; } public Builder setStaleIfError(final long staleIfError) { this.staleIfError = staleIfError; return this; } public Set getNoCacheFields() { return noCacheFields; } public Builder setNoCacheFields(final Set noCacheFields) { this.noCacheFields = noCacheFields; return this; } public Builder setNoCacheFields(final String... noCacheFields) { this.noCacheFields = new HashSet<>(); this.noCacheFields.addAll(Arrays.asList(noCacheFields)); return this; } public boolean isMustUnderstand() { return mustUnderstand; } public Builder setMustUnderstand(final boolean mustUnderstand) { this.mustUnderstand = mustUnderstand; return this; } public boolean isImmutable() { return immutable; } public Builder setImmutable(final boolean immutable) { this.immutable = immutable; return this; } public ResponseCacheControl build() { return new ResponseCacheControl(maxAge, sharedMaxAge, mustRevalidate, noCache, noStore, cachePrivate, proxyRevalidate, cachePublic, staleWhileRevalidate, staleIfError, noCacheFields, mustUnderstand, immutable); } } }httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpCacheStorage.java0100664 0000000 0000000 00000006553 14666635064 027622 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.util.Collection; import java.util.Map; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * {@literal HttpCacheStorage} represents an abstract HTTP cache * storage backend that can then be plugged into the classic * (blocking) request execution pipeline. *

* Implementations of this interface are expected to be threading-safe. *

* * @since 4.1 */ @Contract(threading = ThreadingBehavior.SAFE) public interface HttpCacheStorage { /** * Store a given cache entry under the given key. * @param key where in the cache to store the entry * @param entry cached response to store * @throws ResourceIOException */ void putEntry(String key, HttpCacheEntry entry) throws ResourceIOException; /** * Retrieves the cache entry stored under the given key * or null if no entry exists under that key. * @param key cache key * @return an {@link HttpCacheEntry} or {@code null} if no * entry exists * @throws ResourceIOException */ HttpCacheEntry getEntry(String key) throws ResourceIOException; /** * Deletes/invalidates/removes any cache entries currently * stored under the given key. * @param key * @throws ResourceIOException */ void removeEntry(String key) throws ResourceIOException; /** * Atomically applies the given callback to processChallenge an existing cache * entry under a given key. * @param key indicates which entry to modify * @param casOperation the CAS operation to perform. * @throws ResourceIOException * @throws HttpCacheUpdateException */ void updateEntry( String key, HttpCacheCASOperation casOperation) throws ResourceIOException, HttpCacheUpdateException; /** * Retrieves multiple cache entries stored under the given keys. Some implementations * may use a single bulk operation to do the retrieval. * * @param keys cache keys * @return an map of {@link HttpCacheEntry}s. * * @since 5.0 */ Map getEntries(Collection keys) throws ResourceIOException; } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpCacheEntryFactory.java0100664 0000000 0000000 00000024351 14704162040 030621 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.net.URI; import java.time.Instant; import java.util.Collection; import java.util.HashSet; import java.util.Iterator; import java.util.Locale; import java.util.Set; import org.apache.hc.client5.http.impl.cache.CacheKeyGenerator; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpMessage; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.HeaderGroup; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.util.Args; /** * {@link HttpCacheEntry} factory. * * @since 5.4 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class HttpCacheEntryFactory { /** * Default instance of {@link HttpCacheEntryFactory}. */ public static final HttpCacheEntryFactory INSTANCE = new HttpCacheEntryFactory(); private static HeaderGroup headers(final Iterator
it) { final HeaderGroup headerGroup = new HeaderGroup(); while (it.hasNext()) { headerGroup.addHeader(it.next()); } return headerGroup; } HeaderGroup mergeHeaders(final HttpCacheEntry entry, final HttpResponse response) { final HeaderGroup headerGroup = new HeaderGroup(); for (final Iterator
it = entry.headerIterator(); it.hasNext(); ) { final Header entryHeader = it.next(); final String headerName = entryHeader.getName(); if (!response.containsHeader(headerName)) { headerGroup.addHeader(entryHeader); } } final Set responseHopByHop = MessageSupport.hopByHopConnectionSpecific(response); for (final Iterator
it = response.headerIterator(); it.hasNext(); ) { final Header responseHeader = it.next(); final String headerName = responseHeader.getName(); if (!responseHopByHop.contains(headerName.toLowerCase(Locale.ROOT))) { headerGroup.addHeader(responseHeader); } } return headerGroup; } /** * This method should be provided by the core */ static HeaderGroup filterHopByHopHeaders(final HttpMessage message) { final Set hopByHop = MessageSupport.hopByHopConnectionSpecific(message); final HeaderGroup headerGroup = new HeaderGroup(); for (final Iterator
it = message.headerIterator(); it.hasNext(); ) { final Header header = it.next(); if (!hopByHop.contains(header.getName())) { headerGroup.addHeader(header); } } return headerGroup; } static void ensureDate(final HeaderGroup headers, final Instant instant) { if (!headers.containsHeader(HttpHeaders.DATE)) { headers.addHeader(new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(instant))); } } /** * Creates a new root {@link HttpCacheEntry} (parent of multiple variants). * * @param latestVariant The most recently created variant entry * @param variants describing cache entries that are variants of this parent entry; this * maps a "variant key" (derived from the varying request headers) to a * "cache key" (where in the cache storage the particular variant is * located) */ public HttpCacheEntry createRoot(final HttpCacheEntry latestVariant, final Collection variants) { Args.notNull(latestVariant, "Request"); Args.notNull(variants, "Variants"); return new HttpCacheEntry( latestVariant.getRequestInstant(), latestVariant.getResponseInstant(), latestVariant.getRequestMethod(), latestVariant.getRequestURI(), headers(latestVariant.requestHeaderIterator()), latestVariant.getStatus(), headers(latestVariant.headerIterator()), null, variants); } /** * Create a new {@link HttpCacheEntry} with the given {@link Resource}. * * @param requestInstant Date/time when the request was made (Used for age calculations) * @param responseInstant Date/time that the response came back (Used for age calculations) * @param host Target host * @param request Original client request (a deep copy of this object is made) * @param response Origin response (a deep copy of this object is made) * @param resource Resource representing origin response body */ public HttpCacheEntry create(final Instant requestInstant, final Instant responseInstant, final HttpHost host, final HttpRequest request, final HttpResponse response, final Resource resource) { Args.notNull(requestInstant, "Request instant"); Args.notNull(responseInstant, "Response instant"); Args.notNull(host, "Host"); Args.notNull(request, "Request"); Args.notNull(response, "Origin response"); final String s = CacheKeyGenerator.getRequestUri(host, request); final URI uri = CacheKeyGenerator.normalize(s); final HeaderGroup requestHeaders = filterHopByHopHeaders(request); // Strip AUTHORIZATION from request headers requestHeaders.removeHeaders(HttpHeaders.AUTHORIZATION); final HeaderGroup responseHeaders = filterHopByHopHeaders(response); ensureDate(responseHeaders, responseInstant); return new HttpCacheEntry( requestInstant, responseInstant, request.getMethod(), uri.toASCIIString(), requestHeaders, response.getCode(), responseHeaders, resource, null); } /** * Creates updated entry with the new information from the response. Should only be used for * 304 responses. * * @param requestInstant Date/time when the request was made (Used for age calculations) * @param responseInstant Date/time that the response came back (Used for age calculations) * @param host Target host * @param request Original client request (a deep copy of this object is made) * @param response Origin response (a deep copy of this object is made) * @param entry Existing cache entry. */ public HttpCacheEntry createUpdated( final Instant requestInstant, final Instant responseInstant, final HttpHost host, final HttpRequest request, final HttpResponse response, final HttpCacheEntry entry) { Args.notNull(requestInstant, "Request instant"); Args.notNull(responseInstant, "Response instant"); Args.notNull(response, "Origin response"); Args.check(response.getCode() == HttpStatus.SC_NOT_MODIFIED, "Response must have 304 status code"); Args.notNull(entry, "Cache entry"); if (HttpCacheEntry.isNewer(entry, response)) { return entry; } final String s = CacheKeyGenerator.getRequestUri(host, request); final URI uri = CacheKeyGenerator.normalize(s); final HeaderGroup requestHeaders = filterHopByHopHeaders(request); // Strip AUTHORIZATION from request headers requestHeaders.removeHeaders(HttpHeaders.AUTHORIZATION); final HeaderGroup mergedHeaders = mergeHeaders(entry, response); return new HttpCacheEntry( requestInstant, responseInstant, request.getMethod(), uri.toASCIIString(), requestHeaders, entry.getStatus(), mergedHeaders, entry.getResource(), null); } /** * Creates a copy of the given {@link HttpCacheEntry}. Please note the underlying * {@link Resource} is copied by reference. */ public HttpCacheEntry copy(final HttpCacheEntry entry) { if (entry == null) { return null; } return new HttpCacheEntry( entry.getRequestInstant(), entry.getResponseInstant(), entry.getRequestMethod(), entry.getRequestURI(), headers(entry.requestHeaderIterator()), entry.getStatus(), headers(entry.headerIterator()), entry.getResource(), entry.hasVariants() ? new HashSet<>(entry.getVariants()) : null); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpCacheUpdateException.java0100664 0000000 0000000 00000003260 14666635064 031307 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; /** * Signals that {@link HttpCacheStorage} encountered an error performing * an update operation. * * @since 4.1 */ public class HttpCacheUpdateException extends Exception { private static final long serialVersionUID = 823573584868632876L; public HttpCacheUpdateException(final String message) { super(message); } public HttpCacheUpdateException(final String message, final Throwable cause) { super(message); initCause(cause); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpAsyncCacheInvalidator.java0100664 0000000 0000000 00000006014 14704162037 031444 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.net.URI; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; /** * Given a particular HTTP request / response pair, flush any cache entries * that this exchange would invalidate. * * @since 5.0 * * @deprecated Do not use. */ @Deprecated @Internal public interface HttpAsyncCacheInvalidator { /** * Flush {@link HttpCacheEntry}s invalidated by the given request. * * @param host backend host * @param request request message * @param cacheKeyResolver cache key resolver used by cache storage * @param cacheStorage internal cache storage * @param callback result callback */ Cancellable flushCacheEntriesInvalidatedByRequest( HttpHost host, HttpRequest request, Resolver cacheKeyResolver, HttpAsyncCacheStorage cacheStorage, FutureCallback callback); /** * Flush {@link HttpCacheEntry}s invalidated by the given message exchange. * * @param host backend host * @param request request message * @param response response message * @param cacheKeyResolver cache key resolver used by cache storage * @param cacheStorage internal cache storage * @param callback result callback */ Cancellable flushCacheEntriesInvalidatedByExchange( HttpHost host, HttpRequest request, HttpResponse response, Resolver cacheKeyResolver, HttpAsyncCacheStorage cacheStorage, FutureCallback callback); } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpAsyncCacheStorage.java0100664 0000000 0000000 00000006775 14666635064 030626 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.util.Collection; import java.util.Map; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.FutureCallback; /** * {@literal HttpAsyncCacheStorage} represents an abstract HTTP cache * storage backend that can then be plugged into the asynchronous * (non-blocking ) request execution * pipeline. *

* Implementations of this interface are expected to be threading-safe. *

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE) public interface HttpAsyncCacheStorage { /** * Store a given cache entry under the given key. * @param key where in the cache to store the entry * @param entry cached response to store * @param callback result callback */ Cancellable putEntry( String key, HttpCacheEntry entry, FutureCallback callback); /** * Retrieves the cache entry stored under the given key * or null if no entry exists under that key. * @param key cache key * @param callback result callback * @return an {@link HttpCacheEntry} or {@code null} if no * entry exists */ Cancellable getEntry( String key, FutureCallback callback); /** * Deletes/invalidates/removes any cache entries currently * stored under the given key. * @param key * @param callback result callback */ Cancellable removeEntry( String key, FutureCallback callback); /** * Atomically applies the given callback to processChallenge an existing cache * entry under a given key. * @param key indicates which entry to modify * @param casOperation the CAS operation to perform. * @param callback result callback */ Cancellable updateEntry( String key, HttpCacheCASOperation casOperation, FutureCallback callback); /** * Retrieves multiple cache entries stored under the given keys. Some implementations * may use a single bulk operation to do the retrieval. * * @param keys cache keys * @param callback result callback */ Cancellable getEntries(Collection keys, FutureCallback> callback); } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/RequestCacheControl.java0100664 0000000 0000000 00000015245 14704162040 030323 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Represents the value of the Cache-Control header in an HTTP request containing cache * control directives. * * @since 5.4 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class RequestCacheControl implements CacheControl { private final long maxAge; private final long maxStale; private final long minFresh; private final boolean noCache; private final boolean noStore; private final boolean onlyIfCached; private final long staleIfError; RequestCacheControl(final long maxAge, final long maxStale, final long minFresh, final boolean noCache, final boolean noStore, final boolean onlyIfCached, final long staleIfError) { this.maxAge = maxAge; this.maxStale = maxStale; this.minFresh = minFresh; this.noCache = noCache; this.noStore = noStore; this.onlyIfCached = onlyIfCached; this.staleIfError = staleIfError; } /** * Returns the max-age value from the Cache-Control header. * * @return The max-age value. */ @Override public long getMaxAge() { return maxAge; } /** * Returns the max-stale value from the Cache-Control header. * * @return The max-stale value. */ public long getMaxStale() { return maxStale; } /** * Returns the min-fresh value from the Cache-Control header. * * @return The min-fresh value. */ public long getMinFresh() { return minFresh; } /** * Returns the no-cache flag from the Cache-Control header. * * @return The no-cache flag. */ @Override public boolean isNoCache() { return noCache; } /** * Returns the no-store flag from the Cache-Control header. * * @return The no-store flag. */ @Override public boolean isNoStore() { return noStore; } /** * Returns the only-if-cached flag from the Cache-Control header. * * @return The only-if-cached flag. */ public boolean isOnlyIfCached() { return onlyIfCached; } /** * Returns the stale-if-error value from the Cache-Control header. * * @return The stale-if-error value. */ @Override public long getStaleIfError() { return staleIfError; } @Override public String toString() { final StringBuilder buf = new StringBuilder(); buf.append("["); if (maxAge >= 0) { buf.append("max-age=").append(maxAge).append(","); } if (maxStale >= 0) { buf.append("max-stale=").append(maxStale).append(","); } if (minFresh >= 0) { buf.append("min-fresh=").append(minFresh).append(","); } if (noCache) { buf.append("no-cache").append(","); } if (noStore) { buf.append("no-store").append(","); } if (onlyIfCached) { buf.append("only-if-cached").append(","); } if (staleIfError >= 0) { buf.append("stale-if-error").append(staleIfError).append(","); } if (buf.charAt(buf.length() - 1) == ',') { buf.setLength(buf.length() - 1); } buf.append("]"); return buf.toString(); } public static Builder builder() { return new Builder(); } public static final RequestCacheControl DEFAULT = builder().build(); public static class Builder { private long maxAge = -1; private long maxStale = -1; private long minFresh = -1; private boolean noCache; private boolean noStore; private boolean onlyIfCached; private long staleIfError = -1; Builder() { } public long getMaxAge() { return maxAge; } public Builder setMaxAge(final long maxAge) { this.maxAge = maxAge; return this; } public long getMaxStale() { return maxStale; } public Builder setMaxStale(final long maxStale) { this.maxStale = maxStale; return this; } public long getMinFresh() { return minFresh; } public Builder setMinFresh(final long minFresh) { this.minFresh = minFresh; return this; } public boolean isNoCache() { return noCache; } public Builder setNoCache(final boolean noCache) { this.noCache = noCache; return this; } public boolean isNoStore() { return noStore; } public Builder setNoStore(final boolean noStore) { this.noStore = noStore; return this; } public boolean isOnlyIfCached() { return onlyIfCached; } public Builder setOnlyIfCached(final boolean onlyIfCached) { this.onlyIfCached = onlyIfCached; return this; } public long getStaleIfError() { return staleIfError; } public Builder setStaleIfError(final long staleIfError) { this.staleIfError = staleIfError; return this; } public RequestCacheControl build() { return new RequestCacheControl(maxAge, maxStale, minFresh, noCache, noStore, onlyIfCached, staleIfError); } } }httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/CacheResponseStatus.java0100664 0000000 0000000 00000003515 14704162037 030337 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; /** * This enumeration represents the various ways a response can be generated * by an HTTP cache. */ public enum CacheResponseStatus { /** The response was generated directly by the caching module. */ CACHE_MODULE_RESPONSE, /** A response was generated from the cache with no requests sent * upstream. */ CACHE_HIT, /** The response came from an upstream server. */ CACHE_MISS, /** The response was generated from the cache after validating the * entry with the origin server. */ VALIDATED, /** The response came from an upstream server after a cache failure */ FAILURE } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HeaderConstants.java0100664 0000000 0000000 00000016241 15005672016 027474 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; /** * Records static constants for caching directives. * * @since 4.1 */ public class HeaderConstants { /** * @deprecated Use {@link org.apache.hc.core5.http.Method} */ @Deprecated public static final String GET_METHOD = "GET"; /** * @deprecated Use {@link org.apache.hc.core5.http.Method} */ @Deprecated public static final String HEAD_METHOD = "HEAD"; /** * @deprecated Use {@link org.apache.hc.core5.http.Method} */ @Deprecated public static final String OPTIONS_METHOD = "OPTIONS"; /** * @deprecated Use {@link org.apache.hc.core5.http.Method} */ @Deprecated public static final String PUT_METHOD = "PUT"; /** * @deprecated Use {@link org.apache.hc.core5.http.Method} */ @Deprecated public static final String DELETE_METHOD = "DELETE"; /** * @deprecated Use {@link org.apache.hc.core5.http.Method} */ @Deprecated public static final String TRACE_METHOD = "TRACE"; /** * @deprecated Use {@link org.apache.hc.core5.http.Method} */ @Deprecated public static final String POST_METHOD = "POST"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String LAST_MODIFIED = "Last-Modified"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String IF_MATCH = "If-Match"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String IF_RANGE = "If-Range"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String IF_UNMODIFIED_SINCE = "If-Unmodified-Since"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String IF_MODIFIED_SINCE = "If-Modified-Since"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String IF_NONE_MATCH = "If-None-Match"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String PRAGMA = "Pragma"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String MAX_FORWARDS = "Max-Forwards"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String ETAG = "ETag"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String EXPIRES = "Expires"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String AGE = "Age"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String VARY = "Vary"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String ALLOW = "Allow"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String VIA = "Via"; /** * @deprecated Use {@link #CACHE_CONTROL_PUBLIC} */ @Deprecated public static final String PUBLIC = "public"; /** * @deprecated Use {@link #CACHE_CONTROL_PRIVATE} */ @Deprecated public static final String PRIVATE = "private"; public static final String CACHE_CONTROL = "Cache-Control"; public static final String CACHE_CONTROL_PUBLIC = "public"; public static final String CACHE_CONTROL_PRIVATE = "private"; public static final String CACHE_CONTROL_NO_STORE = "no-store"; public static final String CACHE_CONTROL_NO_CACHE = "no-cache"; public static final String CACHE_CONTROL_MAX_AGE = "max-age"; public static final String CACHE_CONTROL_S_MAX_AGE = "s-maxage"; public static final String CACHE_CONTROL_MAX_STALE = "max-stale"; public static final String CACHE_CONTROL_MIN_FRESH = "min-fresh"; public static final String CACHE_CONTROL_MUST_REVALIDATE = "must-revalidate"; public static final String CACHE_CONTROL_PROXY_REVALIDATE = "proxy-revalidate"; public static final String CACHE_CONTROL_STALE_IF_ERROR = "stale-if-error"; public static final String CACHE_CONTROL_STALE_WHILE_REVALIDATE = "stale-while-revalidate"; public static final String CACHE_CONTROL_ONLY_IF_CACHED = "only-if-cached"; public static final String CACHE_CONTROL_MUST_UNDERSTAND = "must-understand"; public static final String CACHE_CONTROL_IMMUTABLE = "immutable"; /** * @deprecated Use {@link #CACHE_CONTROL_STALE_IF_ERROR} */ @Deprecated public static final String STALE_IF_ERROR = "stale-if-error"; /** * @deprecated Use {@link #CACHE_CONTROL_STALE_WHILE_REVALIDATE} */ @Deprecated public static final String STALE_WHILE_REVALIDATE = "stale-while-revalidate"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String WARNING = "Warning"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String RANGE = "Range"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String CONTENT_RANGE = "Content-Range"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String WWW_AUTHENTICATE = "WWW-Authenticate"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String PROXY_AUTHENTICATE = "Proxy-Authenticate"; /** * @deprecated Use {@link org.apache.hc.core5.http.HttpHeaders} */ @Deprecated public static final String AUTHORIZATION = "Authorization"; } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/Resource.java0100664 0000000 0000000 00000005254 14666635064 026216 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.io.ByteArrayInputStream; import java.io.InputStream; import java.io.Serializable; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Represents a disposable system resource used for handling * cached response bodies. *

* Implementations of this interface are expected to be threading-safe. *

* * @since 4.1 */ @Contract(threading = ThreadingBehavior.SAFE) public abstract class Resource implements Serializable { private static final long serialVersionUID = 1L; /** * Returns resource content as an {@link InputStream}. * * @throws ResourceIOException */ public InputStream getInputStream() throws ResourceIOException { return new ByteArrayInputStream(get()); } /** * Returns resource content as a byte array. *

* Please note for memory efficiency some resource implementations * may return a reference to the underlying byte array. The returned * value should be treated as immutable. * * @throws ResourceIOException * * @since 5.0 */ public abstract byte[] get() throws ResourceIOException; /** * Returns the length in bytes of the response body. */ public abstract long length(); /** * Indicates the system no longer needs to keep this * response body and any system resources associated with * it may be reclaimed. */ public abstract void dispose(); } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/CacheControl.java0100664 0000000 0000000 00000004264 14704162037 026757 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Represents the values of the Cache-Control header in an HTTP message, which indicate whether and for how long * the response can be cached by the client and intermediary proxies. * * @since 5.4 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public interface CacheControl { /** * Returns the max-age value from the Cache-Control header. * * @return The max-age value. */ long getMaxAge(); /** * Returns the no-cache flag from the Cache-Control header. * * @return The no-cache flag. */ boolean isNoCache(); /** * Returns the no-store flag from the Cache-Control header. * * @return The no-store flag. */ boolean isNoStore(); /** * Returns the stale-if-error value from the Cache-Control header. * * @return The stale-if-error value. */ long getStaleIfError(); }httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpCacheEntrySerializer.java0100664 0000000 0000000 00000004065 14666635064 031345 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Serializer / deserializer for {@link HttpCacheStorageEntry} entries. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface HttpCacheEntrySerializer { /** * Serializes the given entry. * * @param entry cache entry * @return serialized representation of the cache entry * @throws ResourceIOException */ T serialize(HttpCacheStorageEntry entry) throws ResourceIOException; /** * Deserializes a cache entry from its serialized representation. * @param serializedObject serialized representation of the cache entry * @return cache entry * @throws ResourceIOException */ HttpCacheStorageEntry deserialize(T serializedObject) throws ResourceIOException; } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/ResourceFactory.java0100664 0000000 0000000 00000007053 14704162040 027523 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Generates {@link Resource} instances for handling cached * HTTP response bodies. * * @since 4.1 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface ResourceFactory { /** * Creates a {@link Resource} from a given response body. * @param requestId a unique identifier for this particular response body. * @param content byte array that represents the origin HTTP response body. * @return a {@code Resource} containing however much of * the response body was successfully read. * @throws ResourceIOException */ Resource generate(String requestId, byte[] content) throws ResourceIOException; /** * Creates a {@link Resource} from a given response body. * @param requestId a unique identifier for this particular response body. * @param content byte array that represents the origin HTTP response body. * @param off the start offset in the array. * @param len the number of bytes to read from the array. * @return a {@code Resource} containing however much of * the response body was successfully read. * @throws ResourceIOException */ Resource generate(String requestId, byte[] content, int off, int len) throws ResourceIOException; /** * Creates a {@link Resource} from a given response body. * @param requestId a unique identifier for this particular response body. * @param eTag eTag Strong (unique) identifier for the resource entity * with the given requestId, or {@code null} when not given * or is weak (non-unique). * @param content byte array that represents the origin HTTP response body. * @param off the start offset in the array. * @param len the number of bytes to read from the array. * @return a {@code Resource} containing however much of * the response body was successfully read. * @throws ResourceIOException */ default Resource generate(String requestId, String eTag, byte[] content, int off, int len) throws ResourceIOException { return generate(requestId, content, off, len); } /** * @deprecated Do not use. */ @Deprecated Resource copy(String requestId, Resource resource) throws ResourceIOException; } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpAsyncCacheStorageAdaptor.java0100664 0000000 0000000 00000010533 14666635064 032124 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.util.Collection; import java.util.Map; import org.apache.hc.client5.http.impl.Operations; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.util.Args; /** * {@link HttpAsyncCacheStorage} implementation that emulates asynchronous * behavior using an instance of classic {@link HttpCacheStorage}. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public final class HttpAsyncCacheStorageAdaptor implements HttpAsyncCacheStorage { private final HttpCacheStorage cacheStorage; public HttpAsyncCacheStorageAdaptor(final HttpCacheStorage cacheStorage) { this.cacheStorage = Args.notNull(cacheStorage, "Cache storage"); } @Override public Cancellable putEntry(final String key, final HttpCacheEntry entry, final FutureCallback callback) { Args.notEmpty(key, "Key"); Args.notNull(entry, "Cache entry"); Args.notNull(callback, "Callback"); try { cacheStorage.putEntry(key, entry); callback.completed(Boolean.TRUE); } catch (final Exception ex) { callback.failed(ex); } return Operations.nonCancellable(); } @Override public Cancellable getEntry(final String key, final FutureCallback callback) { Args.notEmpty(key, "Key"); Args.notNull(callback, "Callback"); try { final HttpCacheEntry entry = cacheStorage.getEntry(key); callback.completed(entry); } catch (final Exception ex) { callback.failed(ex); } return Operations.nonCancellable(); } @Override public Cancellable removeEntry(final String key, final FutureCallback callback) { Args.notEmpty(key, "Key"); Args.notNull(callback, "Callback"); try { cacheStorage.removeEntry(key); callback.completed(Boolean.TRUE); } catch (final Exception ex) { callback.failed(ex); } return Operations.nonCancellable(); } @Override public Cancellable updateEntry( final String key, final HttpCacheCASOperation casOperation, final FutureCallback callback) { Args.notEmpty(key, "Key"); Args.notNull(casOperation, "CAS operation"); Args.notNull(callback, "Callback"); try { cacheStorage.updateEntry(key, casOperation); callback.completed(Boolean.TRUE); } catch (final Exception ex) { callback.failed(ex); } return Operations.nonCancellable(); } @Override public Cancellable getEntries(final Collection keys, final FutureCallback> callback) { Args.notNull(keys, "Key"); Args.notNull(callback, "Callback"); try { callback.completed(cacheStorage.getEntries(keys)); } catch (final Exception ex) { callback.failed(ex); } return Operations.nonCancellable(); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpCacheEntry.java0100664 0000000 0000000 00000042033 15005672016 027272 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.io.Serializable; import java.time.Instant; import java.util.Collection; import java.util.Collections; import java.util.Date; import java.util.HashMap; import java.util.HashSet; import java.util.Iterator; import java.util.Map; import java.util.Set; import java.util.concurrent.atomic.AtomicReference; import java.util.function.Function; import java.util.stream.Collectors; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.MessageHeaders; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.message.HeaderGroup; import org.apache.hc.core5.util.Args; /** * Structure used to store an {@link org.apache.hc.core5.http.HttpResponse} in a cache. * Some entries can optionally depend on system resources that may require * explicit deallocation. In such a case {@link #getResource()} should return * a non null instance of {@link Resource} that must be deallocated by calling * {@link Resource#dispose()} method when no longer used. * * @since 4.1 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class HttpCacheEntry implements MessageHeaders, Serializable { private static final long serialVersionUID = -6300496422359477413L; private final Instant requestDate; private final Instant responseDate; private final String method; private final String requestURI; private final HeaderGroup requestHeaders; private final int status; private final HeaderGroup responseHeaders; private final Resource resource; private final Set variants; private final AtomicReference dateRef; private final AtomicReference expiresRef; private final AtomicReference lastModifiedRef; private final AtomicReference eTagRef; /** * Internal constructor that makes no validation of the input parameters and makes * no copies of the original client request and the origin response. */ @Internal public HttpCacheEntry( final Instant requestDate, final Instant responseDate, final String method, final String requestURI, final HeaderGroup requestHeaders, final int status, final HeaderGroup responseHeaders, final Resource resource, final Collection variants) { super(); this.requestDate = requestDate; this.responseDate = responseDate; this.method = method; this.requestURI = requestURI; this.requestHeaders = requestHeaders; this.status = status; this.responseHeaders = responseHeaders; this.resource = resource; this.variants = variants != null ? Collections.unmodifiableSet(new HashSet<>(variants)) : null; this.dateRef = new AtomicReference<>(); this.expiresRef = new AtomicReference<>(); this.lastModifiedRef = new AtomicReference<>(); this.eTagRef = new AtomicReference<>(); } /** * Create a new {@link HttpCacheEntry} with variants. * @param requestDate * Date/time when the request was made (Used for age * calculations) * @param responseDate * Date/time that the response came back (Used for age * calculations) * @param status * HTTP status from origin response * @param responseHeaders * Header[] from original HTTP Response * @param resource representing origin response body * @param variantMap describing cache entries that are variants * of this parent entry; this maps a "variant key" (derived * from the varying request headers) to a "cache key" (where * in the cache storage the particular variant is located) * @deprecated Use {{@link HttpCacheEntryFactory} */ @Deprecated public HttpCacheEntry( final Date requestDate, final Date responseDate, final int status, final Header[] responseHeaders, final Resource resource, final Map variantMap) { this(DateUtils.toInstant(requestDate), DateUtils.toInstant(responseDate), status, responseHeaders, resource, variantMap); } /** * Create a new {@link HttpCacheEntry} with variants. * * @param requestDate Date/time when the request was made (Used for age calculations) * @param responseDate Date/time that the response came back (Used for age calculations) * @param status HTTP status from origin response * @param responseHeaders Header[] from original HTTP Response * @param resource representing origin response body * @param variantMap describing cache entries that are variants of this parent entry; this * maps a "variant key" (derived from the varying request headers) to a * "cache key" (where in the cache storage the particular variant is * located) * @deprecated Use {{@link HttpCacheEntryFactory} */ @Deprecated public HttpCacheEntry( final Instant requestDate, final Instant responseDate, final int status, final Header[] responseHeaders, final Resource resource, final Map variantMap) { super(); Args.notNull(requestDate, "Request date"); Args.notNull(responseDate, "Response date"); Args.check(status >= HttpStatus.SC_SUCCESS, "Status code"); Args.notNull(responseHeaders, "Response headers"); this.requestDate = requestDate; this.responseDate = responseDate; this.method = Method.GET.name(); this.requestURI = "/"; this.requestHeaders = new HeaderGroup(); this.status = status; this.responseHeaders = new HeaderGroup(); this.responseHeaders.setHeaders(responseHeaders); this.resource = resource; this.variants = variantMap != null ? Collections.unmodifiableSet(new HashSet<>(variantMap.keySet())) : null; this.dateRef = new AtomicReference<>(); this.expiresRef = new AtomicReference<>(); this.lastModifiedRef = new AtomicReference<>(); this.eTagRef = new AtomicReference<>(); } /** * Create a new {@link HttpCacheEntry}. * * @param requestDate Date/time when the request was made (Used for age calculations) * @param responseDate Date/time that the response came back (Used for age calculations) * @param status HTTP status from origin response * @param responseHeaders Header[] from original HTTP Response * @param resource representing origin response body * @deprecated Use {{@link HttpCacheEntryFactory} */ @Deprecated public HttpCacheEntry(final Date requestDate, final Date responseDate, final int status, final Header[] responseHeaders, final Resource resource) { this(requestDate, responseDate, status, responseHeaders, resource, new HashMap<>()); } /** * Create a new {@link HttpCacheEntry}. * * @param requestDate * Date/time when the request was made (Used for age * calculations) * @param responseDate * Date/time that the response came back (Used for age * calculations) * @param status * HTTP status from origin response * @param responseHeaders * Header[] from original HTTP Response * @param resource representing origin response body * * @deprecated Use {{@link HttpCacheEntryFactory} */ @Deprecated public HttpCacheEntry(final Instant requestDate, final Instant responseDate, final int status, final Header[] responseHeaders, final Resource resource) { this(requestDate, responseDate, status, responseHeaders, resource, new HashMap<>()); } /** * Returns the status from the origin {@link org.apache.hc.core5.http.HttpResponse}. */ public int getStatus() { return status; } /** * Returns the time the associated origin request was initiated by the * caching module. * @return {@link Date} * @deprecated USe {@link #getRequestInstant()} */ @Deprecated public Date getRequestDate() { return DateUtils.toDate(requestDate); } /** * Returns the time the associated origin request was initiated by the * caching module. * @return {@link Instant} * @since 5.2 */ public Instant getRequestInstant() { return requestDate; } /** * Returns the time the origin response was received by the caching module. * @return {@link Date} * @deprecated Use {@link #getResponseInstant()} */ @Deprecated public Date getResponseDate() { return DateUtils.toDate(responseDate); } /** * Returns the time the origin response was received by the caching module. * * @return {@link Instant} * @since 5.2 */ public Instant getResponseInstant() { return responseDate; } /** * Returns all the headers that were on the origin response. */ @Override public Header[] getHeaders() { return responseHeaders.getHeaders(); } /** * Returns the first header from the origin response with the given * name. */ @Override public Header getFirstHeader(final String name) { return responseHeaders.getFirstHeader(name); } /** * @since 5.0 */ @Override public Header getLastHeader(final String name) { return responseHeaders.getLastHeader(name); } /** * Gets all the headers with the given name that were on the origin * response. */ @Override public Header[] getHeaders(final String name) { return responseHeaders.getHeaders(name); } /** * @since 5.0 */ @Override public boolean containsHeader(final String name) { return responseHeaders.containsHeader(name); } /** * @since 5.0 */ @Override public int countHeaders(final String name) { return responseHeaders.countHeaders(name); } /** * @since 5.0 */ @Override public Header getHeader(final String name) throws ProtocolException { return responseHeaders.getHeader(name); } /** * @since 5.0 */ @Override public Iterator

headerIterator() { return responseHeaders.headerIterator(); } /** * @since 5.0 */ @Override public Iterator
headerIterator(final String name) { return responseHeaders.headerIterator(name); } /** * @since 5.4 */ public MessageHeaders responseHeaders() { return responseHeaders; } /** * Gets the Date value of the "Date" header or null if the header is missing or cannot be * parsed. * * @since 4.3 */ public Date getDate() { return DateUtils.toDate(getInstant()); } private static final Instant NON_VALUE = Instant.ofEpochSecond(Instant.MIN.getEpochSecond(), 0); private Instant getInstant(final AtomicReference ref, final String headerName) { Instant instant = ref.get(); if (instant == null) { instant = DateUtils.parseStandardDate(this, headerName); if (instant == null) { instant = NON_VALUE; } if (!ref.compareAndSet(null, instant)) { instant = ref.get(); } } return instant != null && instant != NON_VALUE ? instant : null; } /** * @since 5.2 */ public Instant getInstant() { return getInstant(dateRef, HttpHeaders.DATE); } /** * @since 5.4 */ public Instant getExpires() { return getInstant(expiresRef, HttpHeaders.EXPIRES); } /** * @since 5.4 */ public Instant getLastModified() { return getInstant(lastModifiedRef, HttpHeaders.LAST_MODIFIED); } /** * @since 5.4 */ public ETag getETag() { ETag eTag = eTagRef.get(); if (eTag == null) { eTag = ETag.get(this); if (eTag == null) { return null; } if (!eTagRef.compareAndSet(null, eTag)) { eTag = eTagRef.get(); } } return eTag; } /** * Returns the {@link Resource} containing the origin response body. */ public Resource getResource() { return this.resource; } /** * Indicates whether the origin response indicated the associated * resource had variants (i.e. that the Vary header was set on the * origin response). */ public boolean hasVariants() { return variants != null; } /** * Returns all known variants. * * @since 5.4 */ public Set getVariants() { return variants != null ? variants : Collections.emptySet(); } /** * @deprecated No longer applicable. Use {@link #getVariants()} instead. */ @Deprecated public Map getVariantMap() { return variants != null ? variants.stream() .collect(Collectors.toMap(Function.identity(), e -> e + requestURI)) : Collections.emptyMap(); } /** * Returns the HTTP request method that was used to create the cached * response entry. * * @since 4.4 */ public String getRequestMethod() { return method; } /** * @since 5.4 */ public String getRequestURI() { return requestURI; } /** * @since 5.4 */ public MessageHeaders requestHeaders() { return requestHeaders; } /** * @since 5.4 */ public Iterator
requestHeaderIterator() { return requestHeaders.headerIterator(); } /** * @since 5.4 */ public Iterator
requestHeaderIterator(final String headerName) { return requestHeaders.headerIterator(headerName); } /** * Tests if the given {@link HttpCacheEntry} is newer than the given {@link MessageHeaders} * by comparing values of their {@literal DATE} header. In case the given entry, or the message, * or their {@literal DATE} headers are null, this method returns {@code false}. * * @since 5.4 */ public static boolean isNewer(final HttpCacheEntry entry, final MessageHeaders message) { if (entry == null || message == null) { return false; } final Instant cacheDate = entry.getInstant(); if (cacheDate == null) { return false; } final Instant messageDate = DateUtils.parseStandardDate(message, HttpHeaders.DATE); if (messageDate == null) { return false; } return cacheDate.compareTo(messageDate) > 0; } /** * Provides a string representation of this instance suitable for * human consumption. */ @Override public String toString() { return "HttpCacheEntry{" + "requestDate=" + requestDate + ", responseDate=" + responseDate + ", method='" + method + '\'' + ", requestURI='" + requestURI + '\'' + ", requestHeaders=" + requestHeaders + ", status=" + status + ", responseHeaders=" + responseHeaders + ", resource=" + resource + ", variants=" + variants + '}'; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpCacheCASOperation.java0100664 0000000 0000000 00000003642 14666635064 030501 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Atomic Compare-And-Swap (CAS) cache operation. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface HttpCacheCASOperation { /** * Returns the new cache entry that should replace an existing one. * * @param existing * the cache entry currently in-place in the cache, possibly * {@code null} if nonexistent * @return the cache entry that should replace it, again, * possibly {@code null} if the entry should be deleted */ HttpCacheEntry execute(HttpCacheEntry existing) throws ResourceIOException; } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/ResourceIOException.java0100664 0000000 0000000 00000003146 14666635064 030323 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.io.IOException; /** * Signals a generic resource I/O error. */ public class ResourceIOException extends IOException { private static final long serialVersionUID = 1L; public ResourceIOException(final String message) { super(message); } public ResourceIOException(final String message, final Throwable cause) { super(message); initCause(cause); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/cache/HttpCacheInvalidator.java0100664 0000000 0000000 00000005652 14704162040 030447 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.net.URI; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; /** * Given a particular HTTP request / response pair, flush any cache entries * that this exchange would invalidate. * * @since 4.3 * * @deprecated Do not use. */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) @Internal public interface HttpCacheInvalidator { /** * Flush {@link HttpCacheEntry}s invalidated by the given request. * * @param host backend host * @param request request message * @param cacheKeyResolver cache key resolver used by cache storage * @param cacheStorage internal cache storage * * @since 5.0 */ void flushCacheEntriesInvalidatedByRequest( HttpHost host, HttpRequest request, Resolver cacheKeyResolver, HttpCacheStorage cacheStorage); /** * Flush {@link HttpCacheEntry}s invalidated by the given message exchange. * * @param host backend host * @param request request message * @param response response message * @param cacheKeyResolver cache key resolver used by cache storage * @param cacheStorage internal cache storage * * @since 5.0 */ void flushCacheEntriesInvalidatedByExchange( HttpHost host, HttpRequest request, HttpResponse response, Resolver cacheKeyResolver, HttpCacheStorage cacheStorage); } httpclient5-cache/src/main/java/org/apache/hc/client5/http/schedule/0040775 0000000 0000000 00000000000 14666635064 024312 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/schedule/package-info.java0100664 0000000 0000000 00000002423 14666635064 027477 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Scheduling strategies used by HTTP cache implementations. */ package org.apache.hc.client5.http.schedule; httpclient5-cache/src/main/java/org/apache/hc/client5/http/schedule/SchedulingStrategy.java0100664 0000000 0000000 00000003216 14666635064 030764 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.schedule; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.TimeValue; /** * Strategy to determine an execution time (schedule) for an operation. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface SchedulingStrategy { /** * Schedules execution time for an operation. */ TimeValue schedule(int attemptNumber); } httpclient5-cache/src/main/java/org/apache/hc/client5/http/schedule/ConcurrentCountMap.java0100664 0000000 0000000 00000005326 14666635064 030751 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.schedule; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; import java.util.concurrent.atomic.AtomicInteger; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Concurrent map of integer counts. * * @since 5.0 * * @param identifier used as a map key */ @Contract(threading = ThreadingBehavior.SAFE) public final class ConcurrentCountMap { private final ConcurrentMap map; public ConcurrentCountMap() { this.map = new ConcurrentHashMap<>(); } public int getCount(final T identifier) { Args.notNull(identifier, "Identifier"); final AtomicInteger count = map.get(identifier); return count != null ? count.get() : 0; } public void resetCount(final T identifier) { Args.notNull(identifier, "Identifier"); map.remove(identifier); } public int increaseCount(final T identifier) { Args.notNull(identifier, "Identifier"); final AtomicInteger count = get(identifier); return count.incrementAndGet(); } private AtomicInteger get(final T identifier) { AtomicInteger entry = map.get(identifier); if (entry == null) { final AtomicInteger newEntry = new AtomicInteger(); entry = map.putIfAbsent(identifier, newEntry); if (entry == null) { entry = newEntry; } } return entry; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/0040775 0000000 0000000 00000000000 14666635064 023457 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/0040775 0000000 0000000 00000000000 15005672016 024504 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/package-info.java0100664 0000000 0000000 00000002464 14666635064 027714 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Caching API implementation for both the classic and * the asynchronous HTTP transports. */ package org.apache.hc.client5.http.impl.cache; ././@LongLink0100644 0000000 0000000 00000000150 14704162040 011625 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/DefaultAsyncCacheRevalidator.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/DefaultAsyncCacheRevalidator.j0100664 0000000 0000000 00000014221 14704162040 032353 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.IOException; import java.util.concurrent.Future; import java.util.concurrent.RejectedExecutionException; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.schedule.SchedulingStrategy; import org.apache.hc.core5.concurrent.CompletedFuture; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Class used for asynchronous revalidations to be used when the {@code stale-while-revalidate} * directive is present */ class DefaultAsyncCacheRevalidator extends CacheRevalidatorBase { private static final Logger LOG = LoggerFactory.getLogger(DefaultAsyncCacheRevalidator.class); interface RevalidationCall { void execute(AsyncExecCallback asyncExecCallback); } static class InternalScheduledExecutor implements ScheduledExecutor { private final ScheduledExecutor executor; InternalScheduledExecutor(final ScheduledExecutor executor) { this.executor = executor; } @Override public Future schedule(final Runnable command, final TimeValue timeValue) throws RejectedExecutionException { if (timeValue.toMilliseconds() <= 0) { command.run(); return new CompletedFuture<>(null); } return executor.schedule(command, timeValue); } @Override public void shutdown() { executor.shutdown(); } @Override public void awaitTermination(final Timeout timeout) throws InterruptedException { executor.awaitTermination(timeout); } } /** * Create DefaultCacheRevalidator which will make ache revalidation requests * using the supplied {@link SchedulingStrategy} and {@link ScheduledExecutor}. */ public DefaultAsyncCacheRevalidator( final ScheduledExecutor scheduledExecutor, final SchedulingStrategy schedulingStrategy) { super(new InternalScheduledExecutor(scheduledExecutor), schedulingStrategy); } /** * Create CacheValidator which will make ache revalidation requests * using the supplied {@link SchedulingStrategy} and {@link ScheduledExecutorService}. */ public DefaultAsyncCacheRevalidator( final ScheduledExecutorService executorService, final SchedulingStrategy schedulingStrategy) { this(wrap(executorService), schedulingStrategy); } /** * Schedules an asynchronous re-validation */ public void revalidateCacheEntry( final String cacheKey , final AsyncExecCallback asyncExecCallback, final RevalidationCall call) { scheduleRevalidation(cacheKey, () -> call.execute(new AsyncExecCallback() { private final AtomicReference responseRef = new AtomicReference<>(); @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { responseRef.set(response); return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse( final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { final HttpResponse httpResponse = responseRef.getAndSet(null); if (httpResponse != null && httpResponse.getCode() < HttpStatus.SC_SERVER_ERROR) { jobSuccessful(cacheKey); } else { jobFailed(cacheKey); } asyncExecCallback.completed(); } @Override public void failed(final Exception cause) { if (cause instanceof IOException) { LOG.debug("Asynchronous revalidation failed due to I/O error", cause); } else if (cause instanceof HttpException) { LOG.error("HTTP protocol exception during asynchronous revalidation", cause); } else { LOG.error("Unexpected runtime exception thrown during asynchronous revalidation", cause); } try { jobFailed(cacheKey); } finally { asyncExecCallback.failed(cause); } } })); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/BasicHttpCacheStorage.java0100664 0000000 0000000 00000011163 14704162040 031474 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.Collection; import java.util.HashMap; import java.util.LinkedHashMap; import java.util.Map; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.cache.HttpCacheCASOperation; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheStorage; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Basic {@link HttpCacheStorage} implementation backed by an instance of * {@link LinkedHashMap}. In other words, cache entries and * the cached response bodies are held in-memory. This cache does NOT * deallocate resources associated with the cache entries; it is intended * for use with {@link HeapResource} and similar. This is the default cache * storage backend used by {@link CachingHttpClients}. * * @since 4.1 */ @Contract(threading = ThreadingBehavior.SAFE) public class BasicHttpCacheStorage implements HttpCacheStorage { private final InternalCacheStorage entries; private final ReentrantLock lock; public BasicHttpCacheStorage(final CacheConfig config) { super(); this.entries = new InternalCacheStorage(config.getMaxCacheEntries(), null); this.lock = new ReentrantLock(); } /** * Places a HttpCacheEntry in the cache * * @param url * Url to use as the cache key * @param entry * HttpCacheEntry to place in the cache */ @Override public void putEntry( final String url, final HttpCacheEntry entry) throws ResourceIOException { lock.lock(); try { entries.put(url, entry); } finally { lock.unlock(); } } /** * Gets an entry from the cache, if it exists * * @param url * Url that is the cache key * @return HttpCacheEntry if one exists, or null for cache miss */ @Override public HttpCacheEntry getEntry(final String url) throws ResourceIOException { lock.lock(); try { return entries.get(url); } finally { lock.unlock(); } } /** * Removes a HttpCacheEntry from the cache * * @param url * Url that is the cache key */ @Override public void removeEntry(final String url) throws ResourceIOException { lock.lock(); try { entries.remove(url); } finally { lock.unlock(); } } @Override public void updateEntry( final String url, final HttpCacheCASOperation casOperation) throws ResourceIOException { lock.lock(); try { final HttpCacheEntry existingEntry = entries.get(url); entries.put(url, casOperation.execute(existingEntry)); } finally { lock.unlock(); } } @Override public Map getEntries(final Collection keys) throws ResourceIOException { Args.notNull(keys, "Key"); final Map resultMap = new HashMap<>(keys.size()); for (final String key: keys) { final HttpCacheEntry entry = getEntry(key); if (entry != null) { resultMap.put(key, entry); } } return resultMap; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/BasicHttpCache.java0100664 0000000 0000000 00000035162 14740035240 030155 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.net.URI; import java.time.Instant; import java.util.ArrayList; import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Set; import org.apache.hc.client5.http.cache.HttpCacheCASOperation; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheEntryFactory; import org.apache.hc.client5.http.cache.HttpCacheStorage; import org.apache.hc.client5.http.cache.HttpCacheUpdateException; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.client5.http.cache.ResourceFactory; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.client5.http.validator.ValidatorType; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.util.ByteArrayBuffer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; class BasicHttpCache implements HttpCache { private static final Logger LOG = LoggerFactory.getLogger(BasicHttpCache.class); private final ResourceFactory resourceFactory; private final HttpCacheEntryFactory cacheEntryFactory; private final CacheKeyGenerator cacheKeyGenerator; private final HttpCacheStorage storage; public BasicHttpCache( final ResourceFactory resourceFactory, final HttpCacheEntryFactory cacheEntryFactory, final HttpCacheStorage storage, final CacheKeyGenerator cacheKeyGenerator) { this.resourceFactory = resourceFactory; this.cacheEntryFactory = cacheEntryFactory; this.cacheKeyGenerator = cacheKeyGenerator; this.storage = storage; } public BasicHttpCache( final ResourceFactory resourceFactory, final HttpCacheStorage storage, final CacheKeyGenerator cacheKeyGenerator) { this(resourceFactory, HttpCacheEntryFactory.INSTANCE, storage, cacheKeyGenerator); } public BasicHttpCache(final ResourceFactory resourceFactory, final HttpCacheStorage storage) { this( resourceFactory, storage, new CacheKeyGenerator()); } public BasicHttpCache(final CacheConfig config) { this(new HeapResourceFactory(), new BasicHttpCacheStorage(config)); } public BasicHttpCache() { this(CacheConfig.DEFAULT); } void storeInternal(final String cacheKey, final HttpCacheEntry entry) { try { storage.putEntry(cacheKey, entry); } catch (final ResourceIOException ex) { if (LOG.isWarnEnabled()) { LOG.warn("I/O error storing cache entry with key {}", cacheKey); } } } void updateInternal(final String cacheKey, final HttpCacheCASOperation casOperation) { try { storage.updateEntry(cacheKey, casOperation); } catch (final HttpCacheUpdateException ex) { if (LOG.isWarnEnabled()) { LOG.warn("Cannot update cache entry with key {}", cacheKey); } } catch (final ResourceIOException ex) { if (LOG.isWarnEnabled()) { LOG.warn("I/O error updating cache entry with key {}", cacheKey); } } } HttpCacheEntry getInternal(final String cacheKey) { try { return storage.getEntry(cacheKey); } catch (final ResourceIOException ex) { if (LOG.isWarnEnabled()) { LOG.warn("I/O error retrieving cache entry with key {}", cacheKey); } return null; } } private void removeInternal(final String cacheKey) { try { storage.removeEntry(cacheKey); } catch (final ResourceIOException ex) { if (LOG.isWarnEnabled()) { LOG.warn("I/O error removing cache entry with key {}", cacheKey); } } } @Override public CacheMatch match(final HttpHost host, final HttpRequest request) { final String rootKey = cacheKeyGenerator.generateKey(host, request); if (LOG.isDebugEnabled()) { LOG.debug("Get cache root entry: {}", rootKey); } final HttpCacheEntry root = getInternal(rootKey); if (root == null) { return null; } if (root.hasVariants()) { final List variantNames = CacheKeyGenerator.variantNames(root); final String variantKey = cacheKeyGenerator.generateVariantKey(request, variantNames); if (root.getVariants().contains(variantKey)) { final String cacheKey = variantKey + rootKey; if (LOG.isDebugEnabled()) { LOG.debug("Get cache variant entry: {}", cacheKey); } final HttpCacheEntry entry = getInternal(cacheKey); if (entry != null) { return new CacheMatch(new CacheHit(rootKey, cacheKey, entry), new CacheHit(rootKey, root)); } } return new CacheMatch(null, new CacheHit(rootKey, root)); } return new CacheMatch(new CacheHit(rootKey, root), null); } @Override public List getVariants(final CacheHit hit) { if (LOG.isDebugEnabled()) { LOG.debug("Get variant cache entries: {}", hit.rootKey); } final HttpCacheEntry root = hit.entry; final String rootKey = hit.rootKey; if (root != null && root.hasVariants()) { final List variants = new ArrayList<>(); for (final String variantKey : root.getVariants()) { final String variantCacheKey = variantKey + rootKey; final HttpCacheEntry variant = getInternal(variantCacheKey); if (variant != null) { variants.add(new CacheHit(rootKey, variantCacheKey, variant)); } } return variants; } return Collections.emptyList(); } CacheHit store(final String rootKey, final String variantKey, final HttpCacheEntry entry) { if (variantKey == null) { if (LOG.isDebugEnabled()) { LOG.debug("Store entry in cache: {}", rootKey); } storeInternal(rootKey, entry); return new CacheHit(rootKey, entry); } final String variantCacheKey = variantKey + rootKey; if (LOG.isDebugEnabled()) { LOG.debug("Store variant entry in cache: {}", variantCacheKey); } storeInternal(variantCacheKey, entry); if (LOG.isDebugEnabled()) { LOG.debug("Update root entry: {}", rootKey); } updateInternal(rootKey, existing -> { final Set variants = existing != null ? new HashSet<>(existing.getVariants()) : new HashSet<>(); variants.add(variantKey); return cacheEntryFactory.createRoot(entry, variants); }); return new CacheHit(rootKey, variantCacheKey, entry); } @Override public CacheHit store( final HttpHost host, final HttpRequest request, final HttpResponse originResponse, final ByteArrayBuffer content, final Instant requestSent, final Instant responseReceived) { final String rootKey = cacheKeyGenerator.generateKey(host, request); if (LOG.isDebugEnabled()) { LOG.debug("Create cache entry: {}", rootKey); } final Resource resource; try { final ETag eTag = ETag.get(originResponse); resource = content != null ? resourceFactory.generate( rootKey, eTag != null && eTag.getType() == ValidatorType.STRONG ? eTag.getValue() : null, content.array(), 0, content.length()) : null; } catch (final ResourceIOException ex) { if (LOG.isWarnEnabled()) { LOG.warn("I/O error creating cache entry with key {}", rootKey); } final HttpCacheEntry backup = cacheEntryFactory.create( requestSent, responseReceived, host, request, originResponse, content != null ? HeapResourceFactory.INSTANCE.generate(null, content.array(), 0, content.length()) : null); return new CacheHit(rootKey, backup); } final HttpCacheEntry entry = cacheEntryFactory.create(requestSent, responseReceived, host, request, originResponse, resource); final String variantKey = cacheKeyGenerator.generateVariantKey(request, entry); return store(rootKey,variantKey, entry); } @Override public CacheHit update( final CacheHit stale, final HttpHost host, final HttpRequest request, final HttpResponse originResponse, final Instant requestSent, final Instant responseReceived) { if (LOG.isDebugEnabled()) { LOG.debug("Update cache entry: {}", stale.getEntryKey()); } final HttpCacheEntry updatedEntry = cacheEntryFactory.createUpdated( requestSent, responseReceived, host, request, originResponse, stale.entry); final String variantKey = cacheKeyGenerator.generateVariantKey(request, updatedEntry); return store(stale.rootKey, variantKey, updatedEntry); } @Override public CacheHit storeFromNegotiated( final CacheHit negotiated, final HttpHost host, final HttpRequest request, final HttpResponse originResponse, final Instant requestSent, final Instant responseReceived) { if (LOG.isDebugEnabled()) { LOG.debug("Update negotiated cache entry: {}", negotiated.getEntryKey()); } final HttpCacheEntry updatedEntry = cacheEntryFactory.createUpdated( requestSent, responseReceived, host, request, originResponse, negotiated.entry); storeInternal(negotiated.getEntryKey(), updatedEntry); final String rootKey = cacheKeyGenerator.generateKey(host, request); final HttpCacheEntry copy = cacheEntryFactory.copy(updatedEntry); final String variantKey = cacheKeyGenerator.generateVariantKey(request, copy); return store(rootKey, variantKey, copy); } private void evictAll(final HttpCacheEntry root, final String rootKey) { if (LOG.isDebugEnabled()) { LOG.debug("Evicting root cache entry {}", rootKey); } removeInternal(rootKey); if (root.hasVariants()) { for (final String variantKey : root.getVariants()) { final String variantEntryKey = variantKey + rootKey; if (LOG.isDebugEnabled()) { LOG.debug("Evicting variant cache entry {}", variantEntryKey); } removeInternal(variantEntryKey); } } } private void evict(final String rootKey) { final HttpCacheEntry root = getInternal(rootKey); if (root == null) { return; } evictAll(root, rootKey); } private void evict(final String rootKey, final HttpResponse response) { final HttpCacheEntry root = getInternal(rootKey); if (root == null) { return; } final ETag existingETag = root.getETag(); final ETag newETag = ETag.get(response); if (existingETag != null && newETag != null && !ETag.strongCompare(existingETag, newETag) && !HttpCacheEntry.isNewer(root, response)) { evictAll(root, rootKey); } } @Override public void evictInvalidatedEntries(final HttpHost host, final HttpRequest request, final HttpResponse response) { if (LOG.isDebugEnabled()) { LOG.debug("Evict cache entries invalidated by exchange: {}; {} {} -> {}", host, request.getMethod(), request.getRequestUri(), response.getCode()); } final int status = response.getCode(); if (status >= HttpStatus.SC_SUCCESS && status < HttpStatus.SC_CLIENT_ERROR && !Method.isSafe(request.getMethod())) { final String rootKey = cacheKeyGenerator.generateKey(host, request); evict(rootKey); final URI requestUri = CacheKeyGenerator.normalize(CacheKeyGenerator.getRequestUri(host, request)); if (requestUri != null) { final URI contentLocation = CacheSupport.getLocationURI(requestUri, response, HttpHeaders.CONTENT_LOCATION); if (contentLocation != null && CacheSupport.isSameOrigin(requestUri, contentLocation)) { final String cacheKey = cacheKeyGenerator.generateKey(contentLocation); evict(cacheKey, response); } final URI location = CacheSupport.getLocationURI(requestUri, response, HttpHeaders.LOCATION); if (location != null && CacheSupport.isSameOrigin(requestUri, location)) { final String cacheKey = cacheKeyGenerator.generateKey(location); evict(cacheKey, response); } } } } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ResponseCachingPolicy.java0100664 0000000 0000000 00000043704 15005672016 031607 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.time.Duration; import java.time.Instant; import java.util.Iterator; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.message.MessageSupport; import org.slf4j.Logger; import org.slf4j.LoggerFactory; class ResponseCachingPolicy { /** * The default freshness duration for a cached object, in seconds. * *

This constant is used to set the default value for the freshness lifetime of a cached object. * When a new object is added to the cache, it will be assigned this duration if no other duration * is specified.

* *

By default, this value is set to 300 seconds (5 minutes). Applications can customize this * value as needed.

*/ private static final Duration DEFAULT_FRESHNESS_DURATION = Duration.ofMinutes(5); private static final Logger LOG = LoggerFactory.getLogger(ResponseCachingPolicy.class); private final boolean sharedCache; private final boolean neverCache1_0ResponsesWithQueryString; private final boolean neverCache1_1ResponsesWithQueryString; /** * Constructs a new ResponseCachingPolicy with the specified cache policy settings and stale-if-error support. * * @param sharedCache whether to behave as a shared cache (true) or a * non-shared/private cache (false) * @param neverCache1_0ResponsesWithQueryString {@code true} to never cache HTTP 1.0 responses with a query string, * {@code false} to cache if explicit cache headers are found. * @param neverCache1_1ResponsesWithQueryString {@code true} to never cache HTTP 1.1 responses with a query string, * {@code false} to cache if explicit cache headers are found. * @since 5.4 */ public ResponseCachingPolicy( final boolean sharedCache, final boolean neverCache1_0ResponsesWithQueryString, final boolean neverCache1_1ResponsesWithQueryString) { this.sharedCache = sharedCache; this.neverCache1_0ResponsesWithQueryString = neverCache1_0ResponsesWithQueryString; this.neverCache1_1ResponsesWithQueryString = neverCache1_1ResponsesWithQueryString; } /** * Determine if the {@link HttpResponse} gotten from the origin is a * cacheable response. * * @return {@code true} if response is cacheable */ public boolean isResponseCacheable(final ResponseCacheControl cacheControl, final HttpRequest request, final HttpResponse response) { final ProtocolVersion version = request.getVersion() != null ? request.getVersion() : HttpVersion.DEFAULT; if (version.compareToVersion(HttpVersion.HTTP_1_1) > 0) { if (LOG.isDebugEnabled()) { LOG.debug("Protocol version {} is non-cacheable", version); } return false; } // Presently only GET and HEAD methods are supported final String httpMethod = request.getMethod(); if (!Method.GET.isSame(httpMethod) && !Method.HEAD.isSame(httpMethod)) { if (LOG.isDebugEnabled()) { LOG.debug("{} method response is not cacheable", httpMethod); } return false; } final int code = response.getCode(); // Should never happen but better be defensive if (code <= HttpStatus.SC_INFORMATIONAL) { return false; } if (isKnownNonCacheableStatusCode(code)) { if (LOG.isDebugEnabled()) { LOG.debug("{} response is not cacheable", code); } return false; } if (request.getPath().contains("?")) { if (neverCache1_0ResponsesWithQueryString && from1_0Origin(response)) { LOG.debug("Response is not cacheable as it had a query string"); return false; } else if (!neverCache1_1ResponsesWithQueryString && !isExplicitlyCacheable(cacheControl, response)) { LOG.debug("Response is not cacheable as it is missing explicit caching headers"); return false; } } if (cacheControl.isMustUnderstand() && !understoodStatusCode(code)) { // must-understand cache directive overrides no-store LOG.debug("Response contains a status code that the cache does not understand, so it's not cacheable"); return false; } if (isExplicitlyNonCacheable(cacheControl)) { LOG.debug("Response is explicitly non-cacheable per cache control directive"); return false; } if (sharedCache) { if (request.containsHeader(HttpHeaders.AUTHORIZATION) && cacheControl.getSharedMaxAge() == -1 && !(cacheControl.isPublic() || cacheControl.isMustRevalidate())) { LOG.debug("Request contains private credentials"); return false; } } // See if the response is tainted if (response.countHeaders(HttpHeaders.EXPIRES) > 1) { LOG.debug("Multiple Expires headers"); return false; } if (response.countHeaders(HttpHeaders.DATE) > 1) { LOG.debug("Multiple Date headers"); return false; } final Instant responseDate = DateUtils.parseStandardDate(response, HttpHeaders.DATE); final Instant responseExpires = DateUtils.parseStandardDate(response, HttpHeaders.EXPIRES); if (expiresHeaderLessOrEqualToDateHeaderAndNoCacheControl(cacheControl, responseDate, responseExpires)) { LOG.debug("Expires header less or equal to Date header and no cache control directives"); return false; } // Treat responses with `Vary: *` as essentially non-cacheable. final Iterator it = MessageSupport.iterateTokens(response, HttpHeaders.VARY); while (it.hasNext()) { final String token = it.next(); if ("*".equals(token)) { if (LOG.isDebugEnabled()) { LOG.debug("Vary: * found"); } return false; } } return isExplicitlyCacheable(cacheControl, response) || isHeuristicallyCacheable(cacheControl, code, responseDate, responseExpires); } private static boolean isKnownCacheableStatusCode(final int status) { return status == HttpStatus.SC_OK || status == HttpStatus.SC_NON_AUTHORITATIVE_INFORMATION || status == HttpStatus.SC_MULTIPLE_CHOICES || status == HttpStatus.SC_MOVED_PERMANENTLY || status == HttpStatus.SC_GONE; } private static boolean isKnownNonCacheableStatusCode(final int status) { return status == HttpStatus.SC_PARTIAL_CONTENT; } private static boolean isUnknownStatusCode(final int status) { if (status >= 100 && status <= 101) { return false; } if (status >= 200 && status <= 206) { return false; } if (status >= 300 && status <= 307) { return false; } if (status >= 400 && status <= 417) { return false; } return status < 500 || status > 505; } /** * Determines whether the given CacheControl object indicates that the response is explicitly non-cacheable. * * @param cacheControl the CacheControl object representing the cache-control directive(s) from the HTTP response. * @return true if the response is explicitly non-cacheable according to the cache-control directive(s), * false otherwise. *

* When cacheControl is non-null: * - Returns true if the response contains "no-store" or (if sharedCache is true) "private" cache-control directives. * - If the response contains the "no-cache" directive, it is considered cacheable, but requires validation against * the origin server before use. In this case, the method returns false. * - Returns false for other cache-control directives, implying the response is cacheable. *

* When cacheControl is null, returns false, implying the response is cacheable. */ protected boolean isExplicitlyNonCacheable(final ResponseCacheControl cacheControl) { if (cacheControl == null) { return false; } // The response is considered explicitly non-cacheable if it contains // "no-store" or (if sharedCache is true) "private" directives. // Note that "no-cache" is considered cacheable but requires validation before use. return cacheControl.isNoStore() || sharedCache && cacheControl.isCachePrivate(); } protected boolean isExplicitlyCacheable(final ResponseCacheControl cacheControl, final HttpResponse response) { if (cacheControl.isPublic()) { return true; } if (!sharedCache && cacheControl.isCachePrivate()) { return true; } if (response.containsHeader(HttpHeaders.EXPIRES)) { return true; } if (cacheControl.getMaxAge() > 0) { return true; } if (sharedCache && cacheControl.getSharedMaxAge() > 0) { return true; } return false; } protected boolean isHeuristicallyCacheable(final ResponseCacheControl cacheControl, final int status, final Instant responseDate, final Instant responseExpires) { if (isKnownCacheableStatusCode(status)) { final Duration freshnessLifetime = calculateFreshnessLifetime(cacheControl, responseDate, responseExpires); // calculate freshness lifetime if (freshnessLifetime.isNegative()) { if (LOG.isDebugEnabled()) { LOG.debug("Freshness lifetime is invalid"); } return false; } // If the 'immutable' directive is present and the response is still fresh, // then the response is considered cacheable without further validation if (cacheControl.isImmutable() && responseIsStillFresh(responseDate, freshnessLifetime)) { if (LOG.isDebugEnabled()) { LOG.debug("Response is immutable and fresh, considered cacheable without further validation"); } return true; } if (freshnessLifetime.compareTo(Duration.ZERO) > 0) { return true; } } else if (isUnknownStatusCode(status)) { // a response with an unknown status code MUST NOT be // cached if (LOG.isDebugEnabled()) { LOG.debug("{} response is unknown", status); } return false; } return false; } private boolean expiresHeaderLessOrEqualToDateHeaderAndNoCacheControl(final ResponseCacheControl cacheControl, final Instant responseDate, final Instant expires) { if (!cacheControl.isUndefined()) { return false; } if (expires == null || responseDate == null) { return false; } return expires.compareTo(responseDate) <= 0; } private boolean from1_0Origin(final HttpResponse response) { final Iterator it = MessageSupport.iterateTokens(response, HttpHeaders.VIA); if (it.hasNext()) { final String token = it.next(); return token.startsWith("1.0 ") || token.startsWith("HTTP/1.0 "); } final ProtocolVersion version = response.getVersion() != null ? response.getVersion() : HttpVersion.DEFAULT; return HttpVersion.HTTP_1_0.equals(version); } /** * Calculates the freshness lifetime of a response, based on the headers in the response. *

* This method follows the algorithm for calculating the freshness lifetime. * The freshness lifetime represents the time interval in seconds during which the response can be served without * being considered stale. The freshness lifetime calculation takes into account the s-maxage, max-age, Expires, and * Date headers as follows: *

    *
  • If the s-maxage directive is present in the Cache-Control header of the response, its value is used as the * freshness lifetime for shared caches, which typically serve multiple users or clients.
    • *
  • If the max-age directive is present in the Cache-Control header of the response, its value is used as the * freshness lifetime for private caches, which serve a single user or client.
    • *
  • If the Expires header is present in the response, its value is used as the expiration time of the response. * The freshness lifetime is calculated as the difference between the expiration time and the time specified in the * Date header of the response.
    • *
  • If none of the above headers are present or if the calculated freshness lifetime is invalid, a default value of * 5 minutes is returned.
    • *
* *

* Note that caching is a complex topic and cache control directives may interact with each other in non-trivial ways. * This method provides a basic implementation of the freshness lifetime calculation algorithm and may not be suitable * for all use cases. Developers should consult the HTTP caching specifications for more information and consider * implementing additional caching mechanisms as needed. *

*/ private Duration calculateFreshnessLifetime(final ResponseCacheControl cacheControl, final Instant responseDate, final Instant responseExpires) { if (cacheControl.isUndefined()) { // If no cache-control header is present, assume no caching directives and return a default value return DEFAULT_FRESHNESS_DURATION; // 5 minutes } // Check if s-maxage is present and use its value if it is if (cacheControl.getSharedMaxAge() != -1) { return Duration.ofSeconds(cacheControl.getSharedMaxAge()); } else if (cacheControl.getMaxAge() != -1) { return Duration.ofSeconds(cacheControl.getMaxAge()); } if (responseDate != null && responseExpires != null) { return Duration.ofSeconds(responseExpires.getEpochSecond() - responseDate.getEpochSecond()); } // If none of the above conditions are met, a heuristic freshness lifetime might be applicable return DEFAULT_FRESHNESS_DURATION; // 5 minutes } /** * Understood status codes include: * - All 2xx (Successful) status codes (200-299) * - All 3xx (Redirection) status codes (300-399) * - All 4xx (Client Error) status codes up to 417 and 421 * - All 5xx (Server Error) status codes up to 505 * * @param status The HTTP status code to be checked. * @return true if the HTTP status code is understood, false otherwise. */ private boolean understoodStatusCode(final int status) { return status >= 200 && status <= 206 || status >= 300 && status <= 399 || status >= 400 && status <= 417 || status == 421 || status >= 500 && status <= 505; } /** * Determines if an HttpResponse is still fresh based on its Date header and calculated freshness lifetime. * *

* This method calculates the age of the response from its Date header and compares it with the provided freshness * lifetime. If the age is less than the freshness lifetime, the response is considered fresh. *

* *

* Note: If the Date header is missing or invalid, this method assumes the response is not fresh. *

* * @param responseDate The response date. * @param freshnessLifetime The calculated freshness lifetime of the HttpResponse. * @return {@code true} if the response age is less than its freshness lifetime, {@code false} otherwise. */ private boolean responseIsStillFresh(final Instant responseDate, final Duration freshnessLifetime) { if (responseDate == null) { // The Date header is missing or invalid. Assuming the response is not fresh. return false; } final Duration age = Duration.between(responseDate, Instant.now()); return age.compareTo(freshnessLifetime) < 0; } } ././@LongLink0100644 0000000 0000000 00000000147 14704162040 011633 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheControlHeaderGenerator.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheControlHeaderGenerator.ja0100664 0000000 0000000 00000010175 14704162040 032341 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.ArrayList; import java.util.List; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpMessage; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHeaderValueFormatter; import org.apache.hc.core5.http.message.BufferedHeader; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; @Internal @Contract(threading = ThreadingBehavior.IMMUTABLE) class CacheControlHeaderGenerator { /** * Default instance of {@link CacheControlHeaderGenerator}. */ public static final CacheControlHeaderGenerator INSTANCE = new CacheControlHeaderGenerator(); public List convert(final RequestCacheControl cacheControl) { Args.notNull(cacheControl, "Cache control"); final List params = new ArrayList<>(10); if (cacheControl.getMaxAge() >= 0) { params.add(new BasicHeader("max-age", cacheControl.getMaxAge())); } if (cacheControl.getMaxStale() >= 0) { params.add(new BasicHeader("max-stale", cacheControl.getMaxStale())); } if (cacheControl.getMinFresh() >= 0) { params.add(new BasicHeader("min-fresh", cacheControl.getMinFresh())); } if (cacheControl.isNoCache()) { params.add(new BasicHeader("no-cache", null)); } if (cacheControl.isNoStore()) { params.add(new BasicHeader("no-store", null)); } if (cacheControl.isOnlyIfCached()) { params.add(new BasicHeader("only-if-cached", null)); } if (cacheControl.getStaleIfError() >= 0) { params.add(new BasicHeader("stale-if-error", cacheControl.getStaleIfError())); } return params; } public Header generate(final RequestCacheControl cacheControl) { final List params = convert(cacheControl); if (!params.isEmpty()) { final CharArrayBuffer buf = new CharArrayBuffer(1024); buf.append(HttpHeaders.CACHE_CONTROL); buf.append(": "); for (int i = 0; i < params.size(); i++) { if (i > 0) { buf.append(", "); } BasicHeaderValueFormatter.INSTANCE.formatNameValuePair(buf, params.get(i), false); } return BufferedHeader.create(buf); } return null; } public void generate(final RequestCacheControl cacheControl, final HttpMessage message) { final Header h = generate(cacheControl); if (h != null) { message.addHeader(h); } } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/HeapResourceFactory.java0100664 0000000 0000000 00000005130 14704162040 031254 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.client5.http.cache.ResourceFactory; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Generates {@link Resource} instances stored entirely in heap. * * @since 4.1 */ @Contract(threading = ThreadingBehavior.STATELESS) public class HeapResourceFactory implements ResourceFactory { /** * Default instance of {@link HeapResourceFactory}. */ public static final HeapResourceFactory INSTANCE = new HeapResourceFactory(); @Override public Resource generate( final String requestId, final byte[] content, final int off, final int len) { final byte[] copy = new byte[len]; System.arraycopy(content, off, copy, 0, len); return new HeapResource(copy); } @Override public Resource generate(final String requestId, final byte[] content) { return new HeapResource(content != null ? content.clone() : null); } /** * @deprecated Do not use. */ @Deprecated @Override public Resource copy( final String requestId, final Resource resource) throws ResourceIOException { Args.notNull(resource, "Resource"); return resource; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AsyncCachingExec.java0100664 0000000 0000000 00000171555 15005672016 030521 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.IOException; import java.io.InterruptedIOException; import java.nio.ByteBuffer; import java.time.Instant; import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import java.util.function.Consumer; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.async.methods.SimpleBody; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.cache.CacheResponseStatus; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.schedule.SchedulingStrategy; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.concurrent.ComplexFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.impl.BasicEntityDetails; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.ByteArrayBuffer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request executor in the request execution chain that is responsible for * transparent client-side caching. *

* The current implementation is conditionally * compliant with HTTP/1.1 (meaning all the MUST and MUST NOTs are obeyed), * although quite a lot, though not all, of the SHOULDs and SHOULD NOTs * are obeyed too. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE) // So long as the responseCache implementation is threadsafe class AsyncCachingExec extends CachingExecBase implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(AsyncCachingExec.class); private final HttpAsyncCache responseCache; private final DefaultAsyncCacheRevalidator cacheRevalidator; private final ConditionalRequestBuilder conditionalRequestBuilder; AsyncCachingExec(final HttpAsyncCache cache, final DefaultAsyncCacheRevalidator cacheRevalidator, final CacheConfig config) { super(config); this.responseCache = Args.notNull(cache, "Response cache"); this.cacheRevalidator = cacheRevalidator; this.conditionalRequestBuilder = new ConditionalRequestBuilder<>(request -> BasicRequestBuilder.copy(request).build()); } AsyncCachingExec( final HttpAsyncCache cache, final ScheduledExecutorService executorService, final SchedulingStrategy schedulingStrategy, final CacheConfig config) { this(cache, executorService != null ? new DefaultAsyncCacheRevalidator(executorService, schedulingStrategy) : null, config); } private void triggerResponse( final SimpleHttpResponse cacheResponse, final AsyncExecChain.Scope scope, final AsyncExecCallback asyncExecCallback) { scope.execRuntime.releaseEndpoint(); final SimpleBody body = cacheResponse.getBody(); final byte[] content = body != null ? body.getBodyBytes() : null; final ContentType contentType = body != null ? body.getContentType() : null; try { final AsyncDataConsumer dataConsumer = asyncExecCallback.handleResponse( cacheResponse, content != null ? new BasicEntityDetails(content.length, contentType) : null); if (dataConsumer != null) { if (content != null) { dataConsumer.consume(ByteBuffer.wrap(content)); } dataConsumer.streamEnd(null); } asyncExecCallback.completed(); } catch (final HttpException | IOException ex) { asyncExecCallback.failed(ex); } } static class AsyncExecCallbackWrapper implements AsyncExecCallback { private final Runnable command; private final Consumer exceptionConsumer; AsyncExecCallbackWrapper(final Runnable command, final Consumer exceptionConsumer) { this.command = command; this.exceptionConsumer = exceptionConsumer; } @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { return null; } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { } @Override public void completed() { command.run(); } @Override public void failed(final Exception cause) { if (exceptionConsumer != null) { exceptionConsumer.accept(cause); } } } @Override public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final HttpRoute route = scope.route; final HttpClientContext context = scope.clientContext; final URIAuthority authority = request.getAuthority(); final String scheme = request.getScheme(); final HttpHost target = authority != null ? new HttpHost(scheme, authority) : route.getTargetHost(); doExecute(target, request, entityProducer, scope, chain, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { context.setRequest(request); context.setResponse(response); return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse( final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { asyncExecCallback.completed(); } @Override public void failed(final Exception cause) { asyncExecCallback.failed(cause); } }); } public void doExecute( final HttpHost target, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final String exchangeId = scope.exchangeId; final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); final CancellableDependency operation = scope.cancellableDependency; if (LOG.isDebugEnabled()) { LOG.debug("{} request via cache: {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_MISS); context.setCacheEntry(null); if (clientRequestsOurOptions(request)) { context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); triggerResponse(SimpleHttpResponse.create(HttpStatus.SC_NOT_IMPLEMENTED), scope, asyncExecCallback); return; } final RequestCacheControl requestCacheControl; if (request.containsHeader(HttpHeaders.CACHE_CONTROL)) { requestCacheControl = CacheControlHeaderParser.INSTANCE.parse(request); context.setRequestCacheControl(requestCacheControl); } else { requestCacheControl = context.getRequestCacheControlOrDefault(); CacheControlHeaderGenerator.INSTANCE.generate(requestCacheControl, request); } if (LOG.isDebugEnabled()) { LOG.debug("{} request cache control: {}", exchangeId, requestCacheControl); } if (cacheableRequestPolicy.canBeServedFromCache(requestCacheControl, request)) { operation.setDependency(responseCache.match(target, request, new FutureCallback() { @Override public void completed(final CacheMatch result) { final CacheHit hit = result != null ? result.hit : null; final CacheHit root = result != null ? result.root : null; if (hit == null) { handleCacheMiss(requestCacheControl, root, target, request, entityProducer, scope, chain, asyncExecCallback); } else { final ResponseCacheControl responseCacheControl = CacheControlHeaderParser.INSTANCE.parse(hit.entry); if (LOG.isDebugEnabled()) { LOG.debug("{} response cache control: {}", exchangeId, responseCacheControl); } context.setResponseCacheControl(responseCacheControl); handleCacheHit(requestCacheControl, responseCacheControl, hit, target, request, entityProducer, scope, chain, asyncExecCallback); } } @Override public void failed(final Exception cause) { asyncExecCallback.failed(cause); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); } else { if (LOG.isDebugEnabled()) { LOG.debug("{} request cannot be served from cache", exchangeId); } callBackend(target, request, entityProducer, scope, chain, asyncExecCallback); } } void chainProceed( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { try { chain.proceed(request, entityProducer, scope, asyncExecCallback); } catch (final HttpException | IOException ex) { asyncExecCallback.failed(ex); } } void callBackend( final HttpHost target, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { final String exchangeId = scope.exchangeId; if (LOG.isDebugEnabled()) { LOG.debug("{} calling the backend", exchangeId); } final Instant requestDate = getCurrentDate(); final AtomicReference callbackRef = new AtomicReference<>(); chainProceed(request, entityProducer, scope, chain, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse( final HttpResponse backendResponse, final EntityDetails entityDetails) throws HttpException, IOException { final Instant responseDate = getCurrentDate(); final AsyncExecCallback callback = new BackendResponseHandler(target, request, requestDate, responseDate, scope, asyncExecCallback); callbackRef.set(callback); return callback.handleResponse(backendResponse, entityDetails); } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { final AsyncExecCallback callback = callbackRef.getAndSet(null); if (callback != null) { callback.handleInformationResponse(response); } else { asyncExecCallback.handleInformationResponse(response); } } @Override public void completed() { final AsyncExecCallback callback = callbackRef.getAndSet(null); if (callback != null) { callback.completed(); } else { asyncExecCallback.completed(); } } @Override public void failed(final Exception cause) { final AsyncExecCallback callback = callbackRef.getAndSet(null); if (callback != null) { callback.failed(cause); } else { asyncExecCallback.failed(cause); } } }); } class CachingAsyncDataConsumer implements AsyncDataConsumer { private final String exchangeId; private final AsyncExecCallback fallback; private final HttpResponse backendResponse; private final EntityDetails entityDetails; private final AtomicBoolean writtenThrough; private final AtomicReference bufferRef; private final AtomicReference dataConsumerRef; CachingAsyncDataConsumer( final String exchangeId, final AsyncExecCallback fallback, final HttpResponse backendResponse, final EntityDetails entityDetails) { this.exchangeId = exchangeId; this.fallback = fallback; this.backendResponse = backendResponse; this.entityDetails = entityDetails; this.writtenThrough = new AtomicBoolean(false); this.bufferRef = new AtomicReference<>(entityDetails != null ? new ByteArrayBuffer(1024) : null); this.dataConsumerRef = new AtomicReference<>(); } @Override public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException { final AsyncDataConsumer dataConsumer = dataConsumerRef.get(); if (dataConsumer != null) { dataConsumer.updateCapacity(capacityChannel); } else { capacityChannel.update(Integer.MAX_VALUE); } } @Override public final void consume(final ByteBuffer src) throws IOException { final ByteArrayBuffer buffer = bufferRef.get(); if (buffer != null) { if (src.hasArray()) { buffer.append(src.array(), src.arrayOffset() + src.position(), src.remaining()); } else { while (src.hasRemaining()) { buffer.append(src.get()); } } if (buffer.length() > cacheConfig.getMaxObjectSize()) { if (LOG.isDebugEnabled()) { LOG.debug("{} backend response content length exceeds maximum", exchangeId); } // Over the max limit. Stop buffering and forward the response // along with all the data buffered so far to the caller. bufferRef.set(null); try { final AsyncDataConsumer dataConsumer = fallback.handleResponse(backendResponse, entityDetails); if (dataConsumer != null) { dataConsumerRef.set(dataConsumer); writtenThrough.set(true); dataConsumer.consume(ByteBuffer.wrap(buffer.array(), 0, buffer.length())); } } catch (final HttpException ex) { fallback.failed(ex); } } } else { final AsyncDataConsumer dataConsumer = dataConsumerRef.get(); if (dataConsumer != null) { dataConsumer.consume(src); } } } @Override public final void streamEnd(final List trailers) throws HttpException, IOException { final AsyncDataConsumer dataConsumer = dataConsumerRef.getAndSet(null); if (dataConsumer != null) { dataConsumer.streamEnd(trailers); } } @Override public void releaseResources() { final AsyncDataConsumer dataConsumer = dataConsumerRef.getAndSet(null); if (dataConsumer != null) { dataConsumer.releaseResources(); } } } class BackendResponseHandler implements AsyncExecCallback { private final HttpHost target; private final HttpRequest request; private final Instant requestDate; private final Instant responseDate; private final AsyncExecChain.Scope scope; private final AsyncExecCallback asyncExecCallback; private final AtomicReference cachingConsumerRef; BackendResponseHandler( final HttpHost target, final HttpRequest request, final Instant requestDate, final Instant responseDate, final AsyncExecChain.Scope scope, final AsyncExecCallback asyncExecCallback) { this.target = target; this.request = request; this.requestDate = requestDate; this.responseDate = responseDate; this.scope = scope; this.asyncExecCallback = asyncExecCallback; this.cachingConsumerRef = new AtomicReference<>(); } @Override public AsyncDataConsumer handleResponse( final HttpResponse backendResponse, final EntityDetails entityDetails) throws HttpException, IOException { final String exchangeId = scope.exchangeId; responseCache.evictInvalidatedEntries(target, request, backendResponse, new FutureCallback() { @Override public void completed(final Boolean result) { } @Override public void failed(final Exception ex) { if (LOG.isDebugEnabled()) { LOG.debug("{} unable to flush invalidated entries from cache", exchangeId, ex); } } @Override public void cancelled() { } }); if (isResponseTooBig(entityDetails)) { if (LOG.isDebugEnabled()) { LOG.debug("{} backend response is known to be too big", exchangeId); } return asyncExecCallback.handleResponse(backendResponse, entityDetails); } final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); final ResponseCacheControl responseCacheControl = CacheControlHeaderParser.INSTANCE.parse(backendResponse); context.setResponseCacheControl(responseCacheControl); final boolean cacheable = responseCachingPolicy.isResponseCacheable(responseCacheControl, request, backendResponse); if (cacheable) { storeRequestIfModifiedSinceFor304Response(request, backendResponse); if (LOG.isDebugEnabled()) { LOG.debug("{} caching backend response", exchangeId); } final CachingAsyncDataConsumer cachingDataConsumer = new CachingAsyncDataConsumer( exchangeId, asyncExecCallback, backendResponse, entityDetails); cachingConsumerRef.set(cachingDataConsumer); return cachingDataConsumer; } if (LOG.isDebugEnabled()) { LOG.debug("{} backend response is not cacheable", exchangeId); } return asyncExecCallback.handleResponse(backendResponse, entityDetails); } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } void triggerNewCacheEntryResponse(final HttpResponse backendResponse, final Instant responseDate, final ByteArrayBuffer buffer) { final String exchangeId = scope.exchangeId; final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); final CancellableDependency operation = scope.cancellableDependency; operation.setDependency(responseCache.store( target, request, backendResponse, buffer, requestDate, responseDate, new FutureCallback() { @Override public void completed(final CacheHit hit) { if (LOG.isDebugEnabled()) { LOG.debug("{} backend response successfully cached", exchangeId); } try { final SimpleHttpResponse cacheResponse = responseGenerator.generateResponse(request, hit.entry); context.setCacheEntry(hit.entry); triggerResponse(cacheResponse, scope, asyncExecCallback); } catch (final ResourceIOException ex) { asyncExecCallback.failed(ex); } } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); } void triggerCachedResponse(final HttpCacheEntry entry) { final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); try { final SimpleHttpResponse cacheResponse = responseGenerator.generateResponse(request, entry); context.setCacheEntry(entry); triggerResponse(cacheResponse, scope, asyncExecCallback); } catch (final ResourceIOException ex) { asyncExecCallback.failed(ex); } } @Override public void completed() { final String exchangeId = scope.exchangeId; final CachingAsyncDataConsumer cachingDataConsumer = cachingConsumerRef.getAndSet(null); if (cachingDataConsumer == null || cachingDataConsumer.writtenThrough.get()) { asyncExecCallback.completed(); return; } final HttpResponse backendResponse = cachingDataConsumer.backendResponse; final ByteArrayBuffer buffer = cachingDataConsumer.bufferRef.getAndSet(null); // Handle 304 Not Modified responses if (backendResponse.getCode() == HttpStatus.SC_NOT_MODIFIED) { responseCache.match(target, request, new FutureCallback() { @Override public void completed(final CacheMatch result) { final CacheHit hit = result != null ? result.hit : null; if (hit != null) { if (LOG.isDebugEnabled()) { LOG.debug("{} existing cache entry found, updating cache entry", exchangeId); } responseCache.update( hit, target, request, backendResponse, requestDate, responseDate, new FutureCallback() { @Override public void completed(final CacheHit updated) { if (LOG.isDebugEnabled()) { LOG.debug("{} cache entry updated, generating response from updated entry", exchangeId); } triggerCachedResponse(updated.entry); } @Override public void failed(final Exception cause) { if (LOG.isDebugEnabled()) { LOG.debug("{} request failed: {}", exchangeId, cause.getMessage()); } asyncExecCallback.failed(cause); } @Override public void cancelled() { if (LOG.isDebugEnabled()) { LOG.debug("{} cache entry updated aborted", exchangeId); } asyncExecCallback.failed(new InterruptedIOException()); } }); } else { triggerNewCacheEntryResponse(backendResponse, responseDate, buffer); } } @Override public void failed(final Exception cause) { asyncExecCallback.failed(cause); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } }); } else { if (cacheConfig.isFreshnessCheckEnabled()) { final CancellableDependency operation = scope.cancellableDependency; operation.setDependency(responseCache.match(target, request, new FutureCallback() { @Override public void completed(final CacheMatch result) { final CacheHit hit = result != null ? result.hit : null; if (HttpCacheEntry.isNewer(hit != null ? hit.entry : null, backendResponse)) { if (LOG.isDebugEnabled()) { LOG.debug("{} backend already contains fresher cache entry", exchangeId); } triggerCachedResponse(hit.entry); } else { triggerNewCacheEntryResponse(backendResponse, responseDate, buffer); } } @Override public void failed(final Exception cause) { asyncExecCallback.failed(cause); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); } else { triggerNewCacheEntryResponse(backendResponse, responseDate, buffer); } } } @Override public void failed(final Exception cause) { asyncExecCallback.failed(cause); } } private void handleCacheHit( final RequestCacheControl requestCacheControl, final ResponseCacheControl responseCacheControl, final CacheHit hit, final HttpHost target, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); final String exchangeId = scope.exchangeId; if (LOG.isDebugEnabled()) { LOG.debug("{} cache hit: {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_HIT); cacheHits.getAndIncrement(); final Instant now = getCurrentDate(); final CacheSuitability cacheSuitability = suitabilityChecker.assessSuitability(requestCacheControl, responseCacheControl, request, hit.entry, now); if (LOG.isDebugEnabled()) { LOG.debug("{} cache suitability: {}", exchangeId, cacheSuitability); } if (cacheSuitability == CacheSuitability.FRESH || cacheSuitability == CacheSuitability.FRESH_ENOUGH) { if (LOG.isDebugEnabled()) { LOG.debug("{} cache hit is fresh enough", exchangeId); } try { final SimpleHttpResponse cacheResponse = generateCachedResponse(request, hit.entry, now); context.setCacheEntry(hit.entry); triggerResponse(cacheResponse, scope, asyncExecCallback); } catch (final ResourceIOException ex) { if (requestCacheControl.isOnlyIfCached()) { if (LOG.isDebugEnabled()) { LOG.debug("{} request marked only-if-cached", exchangeId); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); final SimpleHttpResponse cacheResponse = generateGatewayTimeout(); triggerResponse(cacheResponse, scope, asyncExecCallback); } else { context.setCacheResponseStatus(CacheResponseStatus.FAILURE); try { chain.proceed(request, entityProducer, scope, asyncExecCallback); } catch (final HttpException | IOException ex2) { asyncExecCallback.failed(ex2); } } } } else { if (requestCacheControl.isOnlyIfCached()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cache entry not is not fresh and only-if-cached requested", exchangeId); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); final SimpleHttpResponse cacheResponse = generateGatewayTimeout(); triggerResponse(cacheResponse, scope, asyncExecCallback); } else if (cacheSuitability == CacheSuitability.MISMATCH) { if (LOG.isDebugEnabled()) { LOG.debug("{} cache entry does not match the request; calling backend", exchangeId); } callBackend(target, request, entityProducer, scope, chain, asyncExecCallback); } else if (entityProducer != null && !entityProducer.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} request is not repeatable; calling backend", exchangeId); } callBackend(target, request, entityProducer, scope, chain, asyncExecCallback); } else if (hit.entry.getStatus() == HttpStatus.SC_NOT_MODIFIED && !suitabilityChecker.isConditional(request)) { if (LOG.isDebugEnabled()) { LOG.debug("{} non-modified cache entry does not match the non-conditional request; calling backend", exchangeId); } callBackend(target, request, entityProducer, scope, chain, asyncExecCallback); } else if (cacheSuitability == CacheSuitability.REVALIDATION_REQUIRED) { if (LOG.isDebugEnabled()) { LOG.debug("{} revalidation required; revalidating cache entry", exchangeId); } revalidateCacheEntryWithoutFallback(responseCacheControl, hit, target, request, entityProducer, scope, chain, asyncExecCallback); } else if (cacheSuitability == CacheSuitability.STALE_WHILE_REVALIDATED) { if (cacheRevalidator != null) { if (LOG.isDebugEnabled()) { LOG.debug("{} serving stale with asynchronous revalidation", exchangeId); } try { final String revalidationExchangeId = ExecSupport.getNextExchangeId(); context.setExchangeId(revalidationExchangeId); final AsyncExecChain.Scope fork = new AsyncExecChain.Scope( revalidationExchangeId, scope.route, scope.originalRequest, new ComplexFuture<>(null), HttpCacheContext.create(), scope.execRuntime.fork(), scope.scheduler, scope.execCount); if (LOG.isDebugEnabled()) { LOG.debug("{} starting asynchronous revalidation exchange {}", exchangeId, revalidationExchangeId); } cacheRevalidator.revalidateCacheEntry( hit.getEntryKey(), asyncExecCallback, c -> revalidateCacheEntry(responseCacheControl, hit, target, request, entityProducer, fork, chain, c)); context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); final SimpleHttpResponse cacheResponse = responseGenerator.generateResponse(request, hit.entry); context.setCacheEntry(hit.entry); triggerResponse(cacheResponse, scope, asyncExecCallback); } catch (final IOException ex) { asyncExecCallback.failed(ex); } } else { if (LOG.isDebugEnabled()) { LOG.debug("{} revalidating stale cache entry (asynchronous revalidation disabled)", exchangeId); } revalidateCacheEntryWithFallback(requestCacheControl, responseCacheControl, hit, target, request, entityProducer, scope, chain, asyncExecCallback); } } else if (cacheSuitability == CacheSuitability.STALE) { if (LOG.isDebugEnabled()) { LOG.debug("{} revalidating stale cache entry", exchangeId); } revalidateCacheEntryWithFallback(requestCacheControl, responseCacheControl, hit, target, request, entityProducer, scope, chain, asyncExecCallback); } else { if (LOG.isDebugEnabled()) { LOG.debug("{} cache entry not usable; calling backend", exchangeId); } callBackend(target, request, entityProducer, scope, chain, asyncExecCallback); } } } void revalidateCacheEntry( final ResponseCacheControl responseCacheControl, final CacheHit hit, final HttpHost target, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { final Instant requestDate = getCurrentDate(); final HttpRequest conditionalRequest = conditionalRequestBuilder.buildConditionalRequest( responseCacheControl, BasicRequestBuilder.copy(request).build(), hit.entry); final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); chainProceed(conditionalRequest, entityProducer, scope, chain, new AsyncExecCallback() { final AtomicReference callbackRef = new AtomicReference<>(); void triggerUpdatedCacheEntryResponse(final HttpResponse backendResponse, final Instant responseDate) { final CancellableDependency operation = scope.cancellableDependency; operation.setDependency(responseCache.update( hit, target, request, backendResponse, requestDate, responseDate, new FutureCallback() { @Override public void completed(final CacheHit updated) { try { final SimpleHttpResponse cacheResponse = generateCachedResponse(request, updated.entry, responseDate); context.setCacheEntry(updated.entry); triggerResponse(cacheResponse, scope, asyncExecCallback); } catch (final ResourceIOException ex) { asyncExecCallback.failed(ex); } } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); } AsyncExecCallback evaluateResponse(final HttpResponse backendResponse, final Instant responseDate) { final int statusCode = backendResponse.getCode(); if (statusCode == HttpStatus.SC_NOT_MODIFIED || statusCode == HttpStatus.SC_OK) { context.setCacheResponseStatus(CacheResponseStatus.VALIDATED); cacheUpdates.getAndIncrement(); } if (statusCode == HttpStatus.SC_NOT_MODIFIED) { return new AsyncExecCallbackWrapper(() -> triggerUpdatedCacheEntryResponse(backendResponse, responseDate), asyncExecCallback::failed); } return new BackendResponseHandler(target, conditionalRequest, requestDate, responseDate, scope, asyncExecCallback); } @Override public AsyncDataConsumer handleResponse( final HttpResponse backendResponse1, final EntityDetails entityDetails) throws HttpException, IOException { final Instant responseDate = getCurrentDate(); final AsyncExecCallback callback1; if (HttpCacheEntry.isNewer(hit.entry, backendResponse1)) { final HttpRequest unconditional = conditionalRequestBuilder.buildUnconditionalRequest( BasicRequestBuilder.copy(scope.originalRequest).build()); callback1 = new AsyncExecCallbackWrapper(() -> chainProceed(unconditional, entityProducer, scope, chain, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse( final HttpResponse backendResponse2, final EntityDetails entityDetails1) throws HttpException, IOException { final Instant responseDate2 = getCurrentDate(); final AsyncExecCallback callback2 = evaluateResponse(backendResponse2, responseDate2); callbackRef.set(callback2); return callback2.handleResponse(backendResponse2, entityDetails1); } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { final AsyncExecCallback callback2 = callbackRef.getAndSet(null); if (callback2 != null) { callback2.handleInformationResponse(response); } else { asyncExecCallback.handleInformationResponse(response); } } @Override public void completed() { final AsyncExecCallback callback2 = callbackRef.getAndSet(null); if (callback2 != null) { callback2.completed(); } else { asyncExecCallback.completed(); } } @Override public void failed(final Exception cause) { final AsyncExecCallback callback2 = callbackRef.getAndSet(null); if (callback2 != null) { callback2.failed(cause); } else { asyncExecCallback.failed(cause); } } }), asyncExecCallback::failed); } else { callback1 = evaluateResponse(backendResponse1, responseDate); } callbackRef.set(callback1); return callback1.handleResponse(backendResponse1, entityDetails); } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { final AsyncExecCallback callback1 = callbackRef.getAndSet(null); if (callback1 != null) { callback1.handleInformationResponse(response); } else { asyncExecCallback.handleInformationResponse(response); } } @Override public void completed() { final AsyncExecCallback callback1 = callbackRef.getAndSet(null); if (callback1 != null) { callback1.completed(); } else { asyncExecCallback.completed(); } } @Override public void failed(final Exception cause) { final AsyncExecCallback callback1 = callbackRef.getAndSet(null); if (callback1 != null) { callback1.failed(cause); } else { asyncExecCallback.failed(cause); } } }); } void revalidateCacheEntryWithoutFallback( final ResponseCacheControl responseCacheControl, final CacheHit hit, final HttpHost target, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { final String exchangeId = scope.exchangeId; final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); revalidateCacheEntry(responseCacheControl, hit, target, request, entityProducer, scope, chain, new AsyncExecCallback() { private final AtomicBoolean committed = new AtomicBoolean(); @Override public AsyncDataConsumer handleResponse(final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { committed.set(true); return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { asyncExecCallback.completed(); } @Override public void failed(final Exception cause) { if (!committed.get() && cause instanceof IOException) { if (LOG.isDebugEnabled()) { LOG.debug("{} I/O error while revalidating cache entry", exchangeId, cause); } final SimpleHttpResponse cacheResponse = generateGatewayTimeout(); context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); triggerResponse(cacheResponse, scope, asyncExecCallback); } else { asyncExecCallback.failed(cause); } } }); } void revalidateCacheEntryWithFallback( final RequestCacheControl requestCacheControl, final ResponseCacheControl responseCacheControl, final CacheHit hit, final HttpHost target, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { final String exchangeId = scope.exchangeId; final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); revalidateCacheEntry(responseCacheControl, hit, target, request, entityProducer, scope, chain, new AsyncExecCallback() { private final AtomicReference committed = new AtomicReference<>(); @Override public AsyncDataConsumer handleResponse(final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { final int status = response.getCode(); if (staleIfErrorAppliesTo(status) && suitabilityChecker.isSuitableIfError(requestCacheControl, responseCacheControl, hit.entry, getCurrentDate())) { if (LOG.isDebugEnabled()) { LOG.debug("{} serving stale response due to {} status and stale-if-error enabled", exchangeId, status); } return null; } committed.set(response); return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { final HttpResponse response = committed.get(); if (response == null) { try { context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); final SimpleHttpResponse cacheResponse = responseGenerator.generateResponse(request, hit.entry); context.setCacheEntry(hit.entry); triggerResponse(cacheResponse, scope, asyncExecCallback); } catch (final IOException ex) { asyncExecCallback.failed(ex); } } else { asyncExecCallback.completed(); } } @Override public void failed(final Exception cause) { final HttpResponse response = committed.get(); if (response == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} I/O error while revalidating cache entry", exchangeId, cause); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); if (cause instanceof IOException && suitabilityChecker.isSuitableIfError(requestCacheControl, responseCacheControl, hit.entry, getCurrentDate())) { if (LOG.isDebugEnabled()) { LOG.debug("{} serving stale response due to IOException and stale-if-error enabled", exchangeId); } try { final SimpleHttpResponse cacheResponse = responseGenerator.generateResponse(request, hit.entry); context.setCacheEntry(hit.entry); triggerResponse(cacheResponse, scope, asyncExecCallback); } catch (final IOException ex) { asyncExecCallback.failed(cause); } } else { final SimpleHttpResponse cacheResponse = generateGatewayTimeout(); triggerResponse(cacheResponse, scope, asyncExecCallback); } } else { asyncExecCallback.failed(cause); } } }); } private void handleCacheMiss( final RequestCacheControl requestCacheControl, final CacheHit partialMatch, final HttpHost target, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { final String exchangeId = scope.exchangeId; if (LOG.isDebugEnabled()) { LOG.debug("{} cache miss: {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } cacheMisses.getAndIncrement(); final CancellableDependency operation = scope.cancellableDependency; if (requestCacheControl.isOnlyIfCached()) { if (LOG.isDebugEnabled()) { LOG.debug("{} request marked only-if-cached", exchangeId); } final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); final SimpleHttpResponse cacheResponse = generateGatewayTimeout(); triggerResponse(cacheResponse, scope, asyncExecCallback); } if (partialMatch != null && partialMatch.entry.hasVariants() && entityProducer == null) { operation.setDependency(responseCache.getVariants( partialMatch, new FutureCallback>() { @Override public void completed(final Collection variants) { if (variants != null && !variants.isEmpty()) { negotiateResponseFromVariants(target, request, entityProducer, scope, chain, asyncExecCallback, variants); } else { callBackend(target, request, entityProducer, scope, chain, asyncExecCallback); } } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); } else { callBackend(target, request, entityProducer, scope, chain, asyncExecCallback); } } void negotiateResponseFromVariants( final HttpHost target, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback, final Collection variants) { final String exchangeId = scope.exchangeId; final CancellableDependency operation = scope.cancellableDependency; final Map variantMap = new HashMap<>(); for (final CacheHit variant : variants) { final ETag eTag = variant.entry.getETag(); if (eTag != null) { variantMap.put(eTag, variant); } } final HttpRequest conditionalRequest = conditionalRequestBuilder.buildConditionalRequestFromVariants( request, variantMap.keySet()); final Instant requestDate = getCurrentDate(); chainProceed(conditionalRequest, entityProducer, scope, chain, new AsyncExecCallback() { final AtomicReference callbackRef = new AtomicReference<>(); void updateVariantCacheEntry(final HttpResponse backendResponse, final Instant responseDate, final CacheHit match) { final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); context.setCacheResponseStatus(CacheResponseStatus.VALIDATED); cacheUpdates.getAndIncrement(); operation.setDependency(responseCache.storeFromNegotiated( match, target, request, backendResponse, requestDate, responseDate, new FutureCallback() { @Override public void completed(final CacheHit hit) { try { final SimpleHttpResponse cacheResponse = generateCachedResponse(request, hit.entry, responseDate); context.setCacheEntry(hit.entry); triggerResponse(cacheResponse, scope, asyncExecCallback); } catch (final ResourceIOException ex) { asyncExecCallback.failed(ex); } } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); } @Override public AsyncDataConsumer handleResponse( final HttpResponse backendResponse, final EntityDetails entityDetails) throws HttpException, IOException { final Instant responseDate = getCurrentDate(); final AsyncExecCallback callback; if (backendResponse.getCode() != HttpStatus.SC_NOT_MODIFIED) { callback = new BackendResponseHandler(target, request, requestDate, responseDate, scope, asyncExecCallback); } else { final ETag resultEtag = ETag.get(backendResponse); if (resultEtag == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} 304 response did not contain ETag", exchangeId); } callback = new AsyncExecCallbackWrapper(() -> callBackend(target, request, entityProducer, scope, chain, asyncExecCallback), asyncExecCallback::failed); } else { final CacheHit match = variantMap.get(resultEtag); if (match == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} 304 response did not contain ETag matching one sent in If-None-Match", exchangeId); } callback = new AsyncExecCallbackWrapper(() -> callBackend(target, request, entityProducer, scope, chain, asyncExecCallback), asyncExecCallback::failed); } else { if (HttpCacheEntry.isNewer(match.entry, backendResponse)) { final HttpRequest unconditional = conditionalRequestBuilder.buildUnconditionalRequest( BasicRequestBuilder.copy(request).build()); callback = new AsyncExecCallbackWrapper(() -> callBackend(target, unconditional, entityProducer, scope, chain, asyncExecCallback), asyncExecCallback::failed); } else { callback = new AsyncExecCallbackWrapper(() -> updateVariantCacheEntry(backendResponse, responseDate, match), asyncExecCallback::failed); } } } } callbackRef.set(callback); return callback.handleResponse(backendResponse, entityDetails); } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { final AsyncExecCallback callback = callbackRef.getAndSet(null); if (callback != null) { callback.handleInformationResponse(response); } else { asyncExecCallback.handleInformationResponse(response); } } @Override public void completed() { final AsyncExecCallback callback = callbackRef.getAndSet(null); if (callback != null) { callback.completed(); } else { asyncExecCallback.completed(); } } @Override public void failed(final Exception cause) { final AsyncExecCallback callback = callbackRef.getAndSet(null); if (callback != null) { callback.failed(cause); } else { asyncExecCallback.failed(cause); } } }); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheSuitability.java0100664 0000000 0000000 00000003712 14704162040 030571 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; /** * @since 5.4 */ enum CacheSuitability { MISMATCH, // the cache entry does not match the request properties and cannot be used // to satisfy the request FRESH, // the cache entry is fresh and can be used to satisfy the request FRESH_ENOUGH, // the cache entry is deemed fresh enough and can be used to satisfy the request STALE, // the cache entry is stale and may be unsuitable to satisfy the request STALE_WHILE_REVALIDATED, // the cache entry is stale but may be unsuitable to satisfy the request // while being re-validated at the same time REVALIDATION_REQUIRED // the cache entry is stale and must not be used to satisfy the request // without revalidation }httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/HttpAsyncCache.java0100664 0000000 0000000 00000007111 14704162040 030201 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.time.Instant; import java.util.Collection; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.util.ByteArrayBuffer; interface HttpAsyncCache { /** * Returns a result with either a fully matching {@link HttpCacheEntry} * a partial match with a list of known variants or null if no match could be found. */ Cancellable match(HttpHost host, HttpRequest request, FutureCallback callback); /** * Retrieves variant {@link HttpCacheEntry}s for the given hit. */ Cancellable getVariants( CacheHit hit, FutureCallback> callback); /** * Stores {@link HttpRequest} / {@link HttpResponse} exchange details in the cache. */ Cancellable store( HttpHost host, HttpRequest request, HttpResponse originResponse, ByteArrayBuffer content, Instant requestSent, Instant responseReceived, FutureCallback callback); /** * Updates {@link HttpCacheEntry} using details from a 304 {@link HttpResponse} and * updates the root entry if the given cache entry represents a variant. */ Cancellable update( CacheHit stale, HttpHost host, HttpRequest request, HttpResponse originResponse, Instant requestSent, Instant responseReceived, FutureCallback callback); /** * Stores {@link HttpRequest} / {@link HttpResponse} exchange details in the cache * from the negotiated {@link HttpCacheEntry}. */ Cancellable storeFromNegotiated( CacheHit negotiated, HttpHost host, HttpRequest request, HttpResponse originResponse, Instant requestSent, Instant responseReceived, FutureCallback callback); /** * Evicts {@link HttpCacheEntry}s invalidated by the given message exchange. */ Cancellable evictInvalidatedEntries( HttpHost host, HttpRequest request, HttpResponse response, FutureCallback callback); } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CombinedEntity.java0100664 0000000 0000000 00000006710 14666635064 030303 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.io.SequenceInputStream; import java.util.List; import java.util.Set; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.ByteArrayBuffer; class CombinedEntity implements HttpEntity { private final HttpEntity entity; private final InputStream combinedStream; CombinedEntity(final HttpEntity entity, final ByteArrayBuffer buf) throws IOException { super(); this.entity = entity; this.combinedStream = new SequenceInputStream( new ByteArrayInputStream(buf.array(), 0, buf.length()), entity.getContent()); } @Override public long getContentLength() { return -1; } @Override public String getContentType() { return entity.getContentType(); } @Override public String getContentEncoding() { return entity.getContentEncoding(); } @Override public boolean isChunked() { return true; } @Override public boolean isRepeatable() { return false; } @Override public boolean isStreaming() { return true; } @Override public InputStream getContent() throws IOException, IllegalStateException { return this.combinedStream; } @Override public Set getTrailerNames() { return entity.getTrailerNames(); } @Override public Supplier> getTrailers() { return entity.getTrailers(); } @Override public void writeTo(final OutputStream outStream) throws IOException { Args.notNull(outStream, "Output stream"); try (InputStream inStream = getContent()) { int l; final byte[] tmp = new byte[2048]; while ((l = inStream.read(tmp)) != -1) { outStream.write(tmp, 0, l); } } } @Override public void close() throws IOException { try { combinedStream.close(); } finally { entity.close(); } } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/BasicHttpAsyncCache.java0100664 0000000 0000000 00000055575 14740035240 031165 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.net.URI; import java.time.Instant; import java.util.Collection; import java.util.Collections; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; import java.util.stream.Collectors; import org.apache.hc.client5.http.cache.HttpAsyncCacheStorage; import org.apache.hc.client5.http.cache.HttpCacheCASOperation; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheEntryFactory; import org.apache.hc.client5.http.cache.HttpCacheUpdateException; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.client5.http.cache.ResourceFactory; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.client5.http.impl.Operations; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.client5.http.validator.ValidatorType; import org.apache.hc.core5.concurrent.CallbackContribution; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexCancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.util.ByteArrayBuffer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; class BasicHttpAsyncCache implements HttpAsyncCache { private static final Logger LOG = LoggerFactory.getLogger(BasicHttpAsyncCache.class); private final ResourceFactory resourceFactory; private final HttpCacheEntryFactory cacheEntryFactory; private final CacheKeyGenerator cacheKeyGenerator; private final HttpAsyncCacheStorage storage; public BasicHttpAsyncCache( final ResourceFactory resourceFactory, final HttpCacheEntryFactory cacheEntryFactory, final HttpAsyncCacheStorage storage, final CacheKeyGenerator cacheKeyGenerator) { this.resourceFactory = resourceFactory; this.cacheEntryFactory = cacheEntryFactory; this.cacheKeyGenerator = cacheKeyGenerator; this.storage = storage; } public BasicHttpAsyncCache( final ResourceFactory resourceFactory, final HttpAsyncCacheStorage storage, final CacheKeyGenerator cacheKeyGenerator) { this(resourceFactory, HttpCacheEntryFactory.INSTANCE, storage, cacheKeyGenerator); } public BasicHttpAsyncCache(final ResourceFactory resourceFactory, final HttpAsyncCacheStorage storage) { this( resourceFactory, storage, CacheKeyGenerator.INSTANCE); } @Override public Cancellable match(final HttpHost host, final HttpRequest request, final FutureCallback callback) { final String rootKey = cacheKeyGenerator.generateKey(host, request); if (LOG.isDebugEnabled()) { LOG.debug("Get cache entry: {}", rootKey); } final ComplexCancellable complexCancellable = new ComplexCancellable(); complexCancellable.setDependency(storage.getEntry(rootKey, new FutureCallback() { @Override public void completed(final HttpCacheEntry root) { if (root != null) { if (root.hasVariants()) { final List variantNames = CacheKeyGenerator.variantNames(root); final String variantKey = cacheKeyGenerator.generateVariantKey(request, variantNames); if (root.getVariants().contains(variantKey)) { final String cacheKey = variantKey + rootKey; if (LOG.isDebugEnabled()) { LOG.debug("Get cache variant entry: {}", cacheKey); } complexCancellable.setDependency(storage.getEntry( cacheKey, new FutureCallback() { @Override public void completed(final HttpCacheEntry entry) { callback.completed(new CacheMatch( entry != null ? new CacheHit(rootKey, cacheKey, entry) : null, new CacheHit(rootKey, root))); } @Override public void failed(final Exception ex) { if (ex instanceof ResourceIOException) { if (LOG.isWarnEnabled()) { LOG.warn("I/O error retrieving cache entry with key {}", cacheKey); } callback.completed(null); } else { callback.failed(ex); } } @Override public void cancelled() { callback.cancelled(); } })); return; } callback.completed(new CacheMatch(null, new CacheHit(rootKey, root))); } else { callback.completed(new CacheMatch(new CacheHit(rootKey, root), null)); } } else { callback.completed(null); } } @Override public void failed(final Exception ex) { if (ex instanceof ResourceIOException) { if (LOG.isWarnEnabled()) { LOG.warn("I/O error retrieving cache entry with key {}", rootKey); } callback.completed(null); } else { callback.failed(ex); } } @Override public void cancelled() { callback.cancelled(); } })); return complexCancellable; } @Override public Cancellable getVariants( final CacheHit hit, final FutureCallback> callback) { if (LOG.isDebugEnabled()) { LOG.debug("Get variant cache entries: {}", hit.rootKey); } final ComplexCancellable complexCancellable = new ComplexCancellable(); final HttpCacheEntry root = hit.entry; final String rootKey = hit.rootKey; if (root != null && root.hasVariants()) { final List variantCacheKeys = root.getVariants().stream() .map(e -> e + rootKey) .collect(Collectors.toList()); complexCancellable.setDependency(storage.getEntries( variantCacheKeys, new FutureCallback>() { @Override public void completed(final Map resultMap) { final List cacheHits = resultMap.entrySet().stream() .map(e -> new CacheHit(hit.rootKey, e.getKey(), e.getValue())) .collect(Collectors.toList()); callback.completed(cacheHits); } @Override public void failed(final Exception ex) { if (ex instanceof ResourceIOException) { if (LOG.isWarnEnabled()) { LOG.warn("I/O error retrieving cache entry with keys {}", variantCacheKeys); } callback.completed(Collections.emptyList()); } else { callback.failed(ex); } } @Override public void cancelled() { callback.cancelled(); } })); } else { callback.completed(Collections.emptyList()); } return complexCancellable; } Cancellable storeInternal(final String cacheKey, final HttpCacheEntry entry, final FutureCallback callback) { if (LOG.isDebugEnabled()) { LOG.debug("Store entry in cache: {}", cacheKey); } return storage.putEntry(cacheKey, entry, new FutureCallback() { @Override public void completed(final Boolean result) { if (callback != null) { callback.completed(result); } } @Override public void failed(final Exception ex) { if (ex instanceof ResourceIOException) { if (LOG.isWarnEnabled()) { LOG.warn("I/O error storing cache entry with key {}", cacheKey); } if (callback != null) { callback.completed(false); } } else { if (callback != null) { callback.failed(ex); } } } @Override public void cancelled() { if (callback != null) { callback.cancelled(); } } }); } Cancellable updateInternal(final String cacheKey, final HttpCacheCASOperation casOperation, final FutureCallback callback) { return storage.updateEntry(cacheKey, casOperation, new FutureCallback() { @Override public void completed(final Boolean result) { if (callback != null) { callback.completed(result); } } @Override public void failed(final Exception ex) { if (ex instanceof HttpCacheUpdateException) { if (LOG.isWarnEnabled()) { LOG.warn("Cannot update cache entry with key {}", cacheKey); } if (callback != null) { callback.completed(false); } } else if (ex instanceof ResourceIOException) { if (LOG.isWarnEnabled()) { LOG.warn("I/O error updating cache entry with key {}", cacheKey); } if (callback != null) { callback.completed(false); } } else { if (callback != null) { callback.failed(ex); } } } @Override public void cancelled() { if (callback != null) { callback.cancelled(); } } }); } private void removeInternal(final String cacheKey) { storage.removeEntry(cacheKey, new FutureCallback() { @Override public void completed(final Boolean result) { } @Override public void failed(final Exception ex) { if (LOG.isWarnEnabled()) { if (ex instanceof ResourceIOException) { LOG.warn("I/O error removing cache entry with key {}", cacheKey); } else { LOG.warn("Unexpected error removing cache entry with key {}", cacheKey, ex); } } } @Override public void cancelled() { } }); } Cancellable store( final String rootKey, final String variantKey, final HttpCacheEntry entry, final FutureCallback callback) { if (variantKey == null) { if (LOG.isDebugEnabled()) { LOG.debug("Store entry in cache: {}", rootKey); } return storeInternal(rootKey, entry, new CallbackContribution(callback) { @Override public void completed(final Boolean result) { callback.completed(new CacheHit(rootKey, entry)); } }); } final String variantCacheKey = variantKey + rootKey; if (LOG.isDebugEnabled()) { LOG.debug("Store variant entry in cache: {}", variantCacheKey); } return storeInternal(variantCacheKey, entry, new CallbackContribution(callback) { @Override public void completed(final Boolean result) { if (LOG.isDebugEnabled()) { LOG.debug("Update root entry: {}", rootKey); } updateInternal(rootKey, existing -> { final Set variantMap = existing != null ? new HashSet<>(existing.getVariants()) : new HashSet<>(); variantMap.add(variantKey); return cacheEntryFactory.createRoot(entry, variantMap); }, new CallbackContribution(callback) { @Override public void completed(final Boolean result) { callback.completed(new CacheHit(rootKey, variantCacheKey, entry)); } }); } }); } @Override public Cancellable store( final HttpHost host, final HttpRequest request, final HttpResponse originResponse, final ByteArrayBuffer content, final Instant requestSent, final Instant responseReceived, final FutureCallback callback) { final String rootKey = cacheKeyGenerator.generateKey(host, request); if (LOG.isDebugEnabled()) { LOG.debug("Create cache entry: {}", rootKey); } final Resource resource; try { final ETag eTag = ETag.get(originResponse); resource = content != null ? resourceFactory.generate( rootKey, eTag != null && eTag.getType() == ValidatorType.STRONG ? eTag.getValue() : null, content.array(), 0, content.length()) : null; } catch (final ResourceIOException ex) { if (LOG.isWarnEnabled()) { LOG.warn("I/O error creating cache entry with key {}", rootKey); } final HttpCacheEntry backup = cacheEntryFactory.create( requestSent, responseReceived, host, request, originResponse, content != null ? HeapResourceFactory.INSTANCE.generate(null, content.array(), 0, content.length()) : null); callback.completed(new CacheHit(rootKey, backup)); return Operations.nonCancellable(); } final HttpCacheEntry entry = cacheEntryFactory.create(requestSent, responseReceived, host, request, originResponse, resource); final String variantKey = cacheKeyGenerator.generateVariantKey(request, entry); return store(rootKey,variantKey, entry, callback); } @Override public Cancellable update( final CacheHit stale, final HttpHost host, final HttpRequest request, final HttpResponse originResponse, final Instant requestSent, final Instant responseReceived, final FutureCallback callback) { if (LOG.isDebugEnabled()) { LOG.debug("Update cache entry: {}", stale.getEntryKey()); } final HttpCacheEntry updatedEntry = cacheEntryFactory.createUpdated( requestSent, responseReceived, host, request, originResponse, stale.entry); final String variantKey = cacheKeyGenerator.generateVariantKey(request, updatedEntry); return store(stale.rootKey, variantKey, updatedEntry, callback); } @Override public Cancellable storeFromNegotiated( final CacheHit negotiated, final HttpHost host, final HttpRequest request, final HttpResponse originResponse, final Instant requestSent, final Instant responseReceived, final FutureCallback callback) { if (LOG.isDebugEnabled()) { LOG.debug("Update negotiated cache entry: {}", negotiated.getEntryKey()); } final HttpCacheEntry updatedEntry = cacheEntryFactory.createUpdated( requestSent, responseReceived, host, request, originResponse, negotiated.entry); storeInternal(negotiated.getEntryKey(), updatedEntry, null); final String rootKey = cacheKeyGenerator.generateKey(host, request); final HttpCacheEntry copy = cacheEntryFactory.copy(updatedEntry); final String variantKey = cacheKeyGenerator.generateVariantKey(request, copy); return store(rootKey, variantKey, copy, callback); } private void evictAll(final HttpCacheEntry root, final String rootKey) { if (LOG.isDebugEnabled()) { LOG.debug("Evicting root cache entry {}", rootKey); } removeInternal(rootKey); if (root.hasVariants()) { for (final String variantKey : root.getVariants()) { final String variantEntryKey = variantKey + rootKey; if (LOG.isDebugEnabled()) { LOG.debug("Evicting variant cache entry {}", variantEntryKey); } removeInternal(variantEntryKey); } } } private Cancellable evict(final String rootKey) { return storage.getEntry(rootKey, new FutureCallback() { @Override public void completed(final HttpCacheEntry root) { if (root != null) { if (LOG.isDebugEnabled()) { LOG.debug("Evicting root cache entry {}", rootKey); } evictAll(root, rootKey); } } @Override public void failed(final Exception ex) { } @Override public void cancelled() { } }); } private Cancellable evict(final String rootKey, final HttpResponse response) { return storage.getEntry(rootKey, new FutureCallback() { @Override public void completed(final HttpCacheEntry root) { if (root != null) { if (LOG.isDebugEnabled()) { LOG.debug("Evicting root cache entry {}", rootKey); } final ETag existingETag = root.getETag(); final ETag newETag = ETag.get(response); if (existingETag != null && newETag != null && !ETag.strongCompare(existingETag, newETag) && !HttpCacheEntry.isNewer(root, response)) { evictAll(root, rootKey); } } } @Override public void failed(final Exception ex) { } @Override public void cancelled() { } }); } @Override public Cancellable evictInvalidatedEntries( final HttpHost host, final HttpRequest request, final HttpResponse response, final FutureCallback callback) { if (LOG.isDebugEnabled()) { LOG.debug("Flush cache entries invalidated by exchange: {}; {} {} -> {}", host, request.getMethod(), request.getRequestUri(), response.getCode()); } final int status = response.getCode(); if (status >= HttpStatus.SC_SUCCESS && status < HttpStatus.SC_CLIENT_ERROR && !Method.isSafe(request.getMethod())) { final String rootKey = cacheKeyGenerator.generateKey(host, request); evict(rootKey); final URI requestUri = CacheKeyGenerator.normalize(CacheKeyGenerator.getRequestUri(host, request)); if (requestUri != null) { final URI contentLocation = CacheSupport.getLocationURI(requestUri, response, HttpHeaders.CONTENT_LOCATION); if (contentLocation != null && CacheSupport.isSameOrigin(requestUri, contentLocation)) { final String cacheKey = cacheKeyGenerator.generateKey(contentLocation); evict(cacheKey, response); } final URI location = CacheSupport.getLocationURI(requestUri, response, HttpHeaders.LOCATION); if (location != null && CacheSupport.isSameOrigin(requestUri, location)) { final String cacheKey = cacheKeyGenerator.generateKey(location); evict(cacheKey, response); } } } callback.completed(Boolean.TRUE); return Operations.nonCancellable(); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingExecBase.java0100664 0000000 0000000 00000016450 14704162040 030302 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.time.Instant; import java.util.concurrent.atomic.AtomicLong; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; public class CachingExecBase { final AtomicLong cacheHits = new AtomicLong(); final AtomicLong cacheMisses = new AtomicLong(); final AtomicLong cacheUpdates = new AtomicLong(); final ResponseCachingPolicy responseCachingPolicy; final CacheValidityPolicy validityPolicy; final CachedHttpResponseGenerator responseGenerator; final CacheableRequestPolicy cacheableRequestPolicy; final CachedResponseSuitabilityChecker suitabilityChecker; final CacheConfig cacheConfig; CachingExecBase( final CacheValidityPolicy validityPolicy, final ResponseCachingPolicy responseCachingPolicy, final CachedHttpResponseGenerator responseGenerator, final CacheableRequestPolicy cacheableRequestPolicy, final CachedResponseSuitabilityChecker suitabilityChecker, final CacheConfig config) { this.responseCachingPolicy = responseCachingPolicy; this.validityPolicy = validityPolicy; this.responseGenerator = responseGenerator; this.cacheableRequestPolicy = cacheableRequestPolicy; this.suitabilityChecker = suitabilityChecker; this.cacheConfig = config != null ? config : CacheConfig.DEFAULT; } CachingExecBase(final CacheConfig config) { super(); this.cacheConfig = config != null ? config : CacheConfig.DEFAULT; this.validityPolicy = new CacheValidityPolicy(config); this.responseGenerator = new CachedHttpResponseGenerator(this.validityPolicy); this.cacheableRequestPolicy = new CacheableRequestPolicy(); this.suitabilityChecker = new CachedResponseSuitabilityChecker(this.validityPolicy, this.cacheConfig); this.responseCachingPolicy = new ResponseCachingPolicy( this.cacheConfig.isSharedCache(), this.cacheConfig.isNeverCacheHTTP10ResponsesWithQuery(), this.cacheConfig.isNeverCacheHTTP11ResponsesWithQuery()); } /** * Reports the number of times that the cache successfully responded * to an {@link HttpRequest} without contacting the origin server. * @return the number of cache hits */ public long getCacheHits() { return cacheHits.get(); } /** * Reports the number of times that the cache contacted the origin * server because it had no appropriate response cached. * @return the number of cache misses */ public long getCacheMisses() { return cacheMisses.get(); } /** * Reports the number of times that the cache was able to satisfy * a response by revalidating an existing but stale cache entry. * @return the number of cache revalidations */ public long getCacheUpdates() { return cacheUpdates.get(); } SimpleHttpResponse generateCachedResponse( final HttpRequest request, final HttpCacheEntry entry, final Instant now) throws ResourceIOException { if (shouldSendNotModifiedResponse(request, entry, now)) { return responseGenerator.generateNotModifiedResponse(entry); } return responseGenerator.generateResponse(request, entry); } SimpleHttpResponse generateGatewayTimeout() { return SimpleHttpResponse.create(HttpStatus.SC_GATEWAY_TIMEOUT, "Gateway Timeout"); } Instant getCurrentDate() { return Instant.now(); } boolean clientRequestsOurOptions(final HttpRequest request) { if (!Method.OPTIONS.isSame(request.getMethod())) { return false; } if (!"*".equals(request.getRequestUri())) { return false; } final Header h = request.getFirstHeader(HttpHeaders.MAX_FORWARDS); return "0".equals(h != null ? h.getValue() : null); } boolean shouldSendNotModifiedResponse(final HttpRequest request, final HttpCacheEntry responseEntry, final Instant now) { return suitabilityChecker.isConditional(request) && suitabilityChecker.allConditionalsMatch(request, responseEntry, now); } boolean staleIfErrorAppliesTo(final int statusCode) { return statusCode == HttpStatus.SC_INTERNAL_SERVER_ERROR || statusCode == HttpStatus.SC_BAD_GATEWAY || statusCode == HttpStatus.SC_SERVICE_UNAVAILABLE || statusCode == HttpStatus.SC_GATEWAY_TIMEOUT; } /** * For 304 Not modified responses, adds a "Last-Modified" header with the * value of the "If-Modified-Since" header passed in the request. This * header is required to be able to reuse match the cache entry for * subsequent requests but as defined in http specifications it is not * included in 304 responses by backend servers. This header will not be * included in the resulting response. */ void storeRequestIfModifiedSinceFor304Response(final HttpRequest request, final HttpResponse backendResponse) { if (backendResponse.getCode() == HttpStatus.SC_NOT_MODIFIED) { final Header h = request.getFirstHeader(HttpHeaders.IF_MODIFIED_SINCE); if (h != null) { backendResponse.addHeader(HttpHeaders.LAST_MODIFIED, h.getValue()); } } } boolean isResponseTooBig(final EntityDetails entityDetails) { if (entityDetails == null) { return false; } final long contentLength = entityDetails.getContentLength(); if (contentLength == -1) { return false; } final long maxObjectSize = cacheConfig.getMaxObjectSize(); return contentLength > maxObjectSize; } } ././@LongLink0100644 0000000 0000000 00000000153 14704162040 011630 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractSerializingCacheStorage.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractSerializingCacheStorag0100664 0000000 0000000 00000014550 14704162040 032475 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; import org.apache.hc.client5.http.cache.HttpCacheCASOperation; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer; import org.apache.hc.client5.http.cache.HttpCacheStorage; import org.apache.hc.client5.http.cache.HttpCacheStorageEntry; import org.apache.hc.client5.http.cache.HttpCacheUpdateException; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.util.Args; /** * Abstract cache backend for serialized objects capable of CAS (compare-and-swap) updates. * * @since 5.0 */ public abstract class AbstractSerializingCacheStorage implements HttpCacheStorage { private final int maxUpdateRetries; private final HttpCacheEntrySerializer serializer; public AbstractSerializingCacheStorage(final int maxUpdateRetries, final HttpCacheEntrySerializer serializer) { this.maxUpdateRetries = Args.notNegative(maxUpdateRetries, "Max retries"); this.serializer = Args.notNull(serializer, "Cache entry serializer"); } protected abstract String digestToStorageKey(String key); protected abstract void store(String storageKey, T storageObject) throws ResourceIOException; protected abstract T restore(String storageKey) throws ResourceIOException; protected abstract CAS getForUpdateCAS(String storageKey) throws ResourceIOException; protected abstract T getStorageObject(CAS cas) throws ResourceIOException; protected abstract boolean updateCAS(String storageKey, CAS cas, T storageObject) throws ResourceIOException; protected abstract void delete(String storageKey) throws ResourceIOException; protected abstract Map bulkRestore(Collection storageKeys) throws ResourceIOException; @Override public final void putEntry(final String key, final HttpCacheEntry entry) throws ResourceIOException { final String storageKey = digestToStorageKey(key); final T storageObject = serializer.serialize(new HttpCacheStorageEntry(key, entry)); store(storageKey, storageObject); } @Override public final HttpCacheEntry getEntry(final String key) throws ResourceIOException { final String storageKey = digestToStorageKey(key); final T storageObject = restore(storageKey); if (storageObject == null) { return null; } final HttpCacheStorageEntry entry = serializer.deserialize(storageObject); if (key.equals(entry.getKey())) { return entry.getContent(); } return null; } @Override public final void removeEntry(final String key) throws ResourceIOException { final String storageKey = digestToStorageKey(key); delete(storageKey); } @Override public final void updateEntry( final String key, final HttpCacheCASOperation casOperation) throws HttpCacheUpdateException, ResourceIOException { int numRetries = 0; final String storageKey = digestToStorageKey(key); for (;;) { final CAS cas = getForUpdateCAS(storageKey); HttpCacheStorageEntry storageEntry = cas != null ? serializer.deserialize(getStorageObject(cas)) : null; if (storageEntry != null && !key.equals(storageEntry.getKey())) { storageEntry = null; } final HttpCacheEntry existingEntry = storageEntry != null ? storageEntry.getContent() : null; final HttpCacheEntry updatedEntry = casOperation.execute(existingEntry); if (existingEntry == null) { putEntry(key, updatedEntry); return; } final T storageObject = serializer.serialize(new HttpCacheStorageEntry(key, updatedEntry)); if (!updateCAS(storageKey, cas, storageObject)) { numRetries++; if (numRetries >= maxUpdateRetries) { throw new HttpCacheUpdateException("Cache update failed after " + numRetries + " retries"); } } else { return; } } } @Override public final Map getEntries(final Collection keys) throws ResourceIOException { Args.notNull(keys, "Storage keys"); final List storageKeys = new ArrayList<>(keys.size()); for (final String key: keys) { storageKeys.add(digestToStorageKey(key)); } final Map storageObjectMap = bulkRestore(storageKeys); final Map resultMap = new HashMap<>(); for (final String key: keys) { final String storageKey = digestToStorageKey(key); final T storageObject = storageObjectMap.get(storageKey); if (storageObject != null) { final HttpCacheStorageEntry entry = serializer.deserialize(storageObject); if (key.equals(entry.getKey())) { resultMap.put(key, entry.getContent()); } } } return resultMap; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ViaCacheGenerator.java0100664 0000000 0000000 00000004757 14704162040 030667 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.util.VersionInfo; final class ViaCacheGenerator { final static ViaCacheGenerator INSTANCE = new ViaCacheGenerator(); final ConcurrentMap internalCache = new ConcurrentHashMap<>(4); String generateViaHeader(final VersionInfo vi, final ProtocolVersion pv) { final StringBuilder buf = new StringBuilder(); if (!URIScheme.HTTP.same(pv.getProtocol())) { buf.append(pv.getProtocol()).append('/'); } buf.append(pv.getMajor()).append('.').append(pv.getMinor()); buf.append(' ').append("localhost").append(' '); buf.append("(Apache-HttpClient/"); final String release = (vi != null) ? vi.getRelease() : VersionInfo.UNAVAILABLE; buf.append(release).append(" (cache))"); return buf.toString(); } String lookup(final ProtocolVersion pv) { return internalCache.computeIfAbsent(pv, v -> { final VersionInfo vi = VersionInfo.loadVersionInfo("org.apache.hc.client5", getClass().getClassLoader()); return generateViaHeader(vi, v); }); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheableRequestPolicy.java0100664 0000000 0000000 00000005722 14704162040 031726 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolVersion; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Determines if an HttpRequest is allowed to be served from the cache. */ class CacheableRequestPolicy { private static final Logger LOG = LoggerFactory.getLogger(CacheableRequestPolicy.class); /** * Determines if an HttpRequest can be served from the cache. * * @param request * an HttpRequest * @return boolean Is it possible to serve this request from cache */ public boolean canBeServedFromCache(final RequestCacheControl cacheControl, final HttpRequest request) { final String method = request.getMethod(); final ProtocolVersion pv = request.getVersion() != null ? request.getVersion() : HttpVersion.DEFAULT; if (HttpVersion.HTTP_1_1.compareToVersion(pv) != 0) { LOG.debug("non-HTTP/1.1 request cannot be served from cache"); return false; } if (!Method.GET.isSame(method) && !Method.HEAD.isSame(method)) { if (LOG.isDebugEnabled()) { LOG.debug("{} request cannot be served from cache", method); } return false; } if (cacheControl.isNoStore()) { LOG.debug("Request with no-store cannot be served from cache"); return false; } if (cacheControl.isNoCache()) { LOG.debug("Request with no-cache cannot be served from cache"); return false; } LOG.debug("Request can be served from cache"); return true; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheConfig.java0100664 0000000 0000000 00000053413 15005672016 027503 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; /** *

Configuration for HTTP caches

* *

Cache configuration can be grouped into the following categories:

* *

Protocol options. I some cases the HTTP protocol allows for * conditional behaviors or optional protocol extensions. Such conditional * protocol behaviors or extensions can be turned on or off here. * See {@link CacheConfig#isNeverCacheHTTP10ResponsesWithQuery()}, * {@link CacheConfig#isNeverCacheHTTP11ResponsesWithQuery()}, * {@link CacheConfig#isStaleIfErrorEnabled()}

* *

Cache size. If the backend storage supports these limits, one * can specify the {@link CacheConfig#getMaxCacheEntries maximum number of * cache entries} as well as the {@link CacheConfig#getMaxObjectSize()} * maximum cacheable response body size}.

* *

Public/private caching. By default, the caching module considers * itself to be a shared (public) cache, and will not, for example, cache * responses to requests with {@code Authorization} headers or responses * marked with {@code Cache-Control: private}. If, however, the cache * is only going to be used by one logical "user" (behaving similarly to a * browser cache), then one may want to {@link CacheConfig#isSharedCache()} * turn off the shared cache setting}.

* *

Heuristic caching. Per HTTP caching specification, a cache may * cache certain cache entries even if no explicit cache control headers are * set by the origin. This behavior is off by default, but you may want to * turn this on if you are working with an origin that doesn't set proper * headers but where one may still want to cache the responses. Use {@link * CacheConfig#isHeuristicCachingEnabled()} to enable heuristic caching}, * then specify either a {@link CacheConfig#getHeuristicDefaultLifetime() * default freshness lifetime} and/or a {@link * CacheConfig#getHeuristicCoefficient() fraction of the time since * the resource was last modified}. * *

Background validation. The cache module supports the * {@code stale-while-revalidate} directive, which allows certain cache entry * revalidations to happen in the background. Asynchronous validation is enabled * by default but it could be disabled by setting the number of re-validation * workers to {@code 0} with {@link CacheConfig#getAsynchronousWorkers()} * parameter

*/ public class CacheConfig implements Cloneable { /** Default setting for the maximum object size that will be * cached, in bytes. */ public final static int DEFAULT_MAX_OBJECT_SIZE_BYTES = 8192; /** Default setting for the maximum number of cache entries * that will be retained. */ public final static int DEFAULT_MAX_CACHE_ENTRIES = 1000; /** Default setting for the number of retries on a failed * cache processChallenge */ public final static int DEFAULT_MAX_UPDATE_RETRIES = 1; /** * @deprecated No longer applicable. Do not use. */ @Deprecated public final static boolean DEFAULT_303_CACHING_ENABLED = false; /** * @deprecated No longer applicable. Do not use. */ @Deprecated public final static boolean DEFAULT_WEAK_ETAG_ON_PUTDELETE_ALLOWED = false; /** Default setting for heuristic caching */ public final static boolean DEFAULT_HEURISTIC_CACHING_ENABLED = false; /** Default coefficient used to heuristically determine freshness * lifetime from the Last-Modified time of a cache entry. */ public final static float DEFAULT_HEURISTIC_COEFFICIENT = 0.1f; /** Default lifetime to be assumed when we cannot calculate * freshness heuristically. */ public final static TimeValue DEFAULT_HEURISTIC_LIFETIME = TimeValue.ZERO_MILLISECONDS; /** Default number of worker threads to allow for background revalidations * resulting from the stale-while-revalidate directive. */ public static final int DEFAULT_ASYNCHRONOUS_WORKERS = 1; public static final CacheConfig DEFAULT = new Builder().build(); private final long maxObjectSize; private final int maxCacheEntries; private final int maxUpdateRetries; private final boolean heuristicCachingEnabled; private final float heuristicCoefficient; private final TimeValue heuristicDefaultLifetime; private final boolean sharedCache; private final boolean freshnessCheckEnabled; private final int asynchronousWorkers; private final boolean neverCacheHTTP10ResponsesWithQuery; private final boolean staleIfErrorEnabled; /** * A constant indicating whether HTTP/1.1 responses with a query string should never be cached. * */ private final boolean neverCacheHTTP11ResponsesWithQuery; CacheConfig( final long maxObjectSize, final int maxCacheEntries, final int maxUpdateRetries, final boolean heuristicCachingEnabled, final float heuristicCoefficient, final TimeValue heuristicDefaultLifetime, final boolean sharedCache, final boolean freshnessCheckEnabled, final int asynchronousWorkers, final boolean neverCacheHTTP10ResponsesWithQuery, final boolean neverCacheHTTP11ResponsesWithQuery, final boolean staleIfErrorEnabled) { super(); this.maxObjectSize = maxObjectSize; this.maxCacheEntries = maxCacheEntries; this.maxUpdateRetries = maxUpdateRetries; this.heuristicCachingEnabled = heuristicCachingEnabled; this.heuristicCoefficient = heuristicCoefficient; this.heuristicDefaultLifetime = heuristicDefaultLifetime; this.sharedCache = sharedCache; this.freshnessCheckEnabled = freshnessCheckEnabled; this.asynchronousWorkers = asynchronousWorkers; this.neverCacheHTTP10ResponsesWithQuery = neverCacheHTTP10ResponsesWithQuery; this.neverCacheHTTP11ResponsesWithQuery = neverCacheHTTP11ResponsesWithQuery; this.staleIfErrorEnabled = staleIfErrorEnabled; } /** * Returns the current maximum response body size that will be cached. * @return size in bytes * * @since 4.2 */ public long getMaxObjectSize() { return maxObjectSize; } /** * Returns whether the cache will never cache HTTP 1.0 responses with a query string or not. * @return {@code true} to not cache query string responses, {@code false} to cache if explicit cache headers are * found */ public boolean isNeverCacheHTTP10ResponsesWithQuery() { return neverCacheHTTP10ResponsesWithQuery; } /** * Determines whether HTTP/1.1 responses with query strings should never be cached by the * client. By default, caching of such responses is allowed. Enabling this option may improve * security by preventing responses with sensitive information from being cached. *

* Note that this option only applies to HTTP/1.1. *

* * @return {@code true} if HTTP/1.1 responses with query strings should never be cached; * {@code false} otherwise. * @since 5.4 */ public boolean isNeverCacheHTTP11ResponsesWithQuery() { return neverCacheHTTP11ResponsesWithQuery; } /** * Returns a boolean value indicating whether the stale-if-error cache * directive is enabled. If this option is enabled, cached responses that * have become stale due to an error (such as a server error or a network * failure) will be returned instead of generating a new request. This can * help to reduce the load on the origin server and improve performance. * @return {@code true} if the stale-if-error directive is enabled, or * {@code false} otherwise. */ public boolean isStaleIfErrorEnabled() { return this.staleIfErrorEnabled; } /** * Returns the maximum number of cache entries the cache will retain. */ public int getMaxCacheEntries() { return maxCacheEntries; } /** * Returns the number of times to retry a cache processChallenge on failure */ public int getMaxUpdateRetries() { return maxUpdateRetries; } /** * @deprecated No longer applicable. Do not use. */ @Deprecated public boolean is303CachingEnabled() { return true; } /** * Returns whether weak etags is allowed with PUT/DELETE methods. * @return {@code true} if it is allowed. * * @deprecated Do not use. */ @Deprecated public boolean isWeakETagOnPutDeleteAllowed() { return true; } /** * Returns whether heuristic caching is enabled. * @return {@code true} if it is enabled. */ public boolean isHeuristicCachingEnabled() { return heuristicCachingEnabled; } /** * Returns lifetime coefficient used in heuristic freshness caching. */ public float getHeuristicCoefficient() { return heuristicCoefficient; } /** * Get the default lifetime to be used if heuristic freshness calculation is * not possible. */ public TimeValue getHeuristicDefaultLifetime() { return heuristicDefaultLifetime; } /** * Returns whether the cache will behave as a shared cache or not. * @return {@code true} for a shared cache, {@code false} for a non- * shared (private) cache */ public boolean isSharedCache() { return sharedCache; } /** * Returns whether the cache will perform an extra cache entry freshness check * upon cache update in case of a cache miss * * @since 5.0 */ public boolean isFreshnessCheckEnabled() { return freshnessCheckEnabled; } /** * Returns the maximum number of threads to allow for background * revalidations due to the {@code stale-while-revalidate} directive. A * value of 0 means background revalidations are disabled. */ public int getAsynchronousWorkers() { return asynchronousWorkers; } @Override protected CacheConfig clone() throws CloneNotSupportedException { return (CacheConfig) super.clone(); } public static Builder custom() { return new Builder(); } public static Builder copy(final CacheConfig config) { Args.notNull(config, "Cache config"); return new Builder() .setMaxObjectSize(config.getMaxObjectSize()) .setMaxCacheEntries(config.getMaxCacheEntries()) .setMaxUpdateRetries(config.getMaxUpdateRetries()) .setHeuristicCachingEnabled(config.isHeuristicCachingEnabled()) .setHeuristicCoefficient(config.getHeuristicCoefficient()) .setHeuristicDefaultLifetime(config.getHeuristicDefaultLifetime()) .setSharedCache(config.isSharedCache()) .setAsynchronousWorkers(config.getAsynchronousWorkers()) .setNeverCacheHTTP10ResponsesWithQueryString(config.isNeverCacheHTTP10ResponsesWithQuery()) .setNeverCacheHTTP11ResponsesWithQueryString(config.isNeverCacheHTTP11ResponsesWithQuery()) .setStaleIfErrorEnabled(config.isStaleIfErrorEnabled()); } public static class Builder { private long maxObjectSize; private int maxCacheEntries; private int maxUpdateRetries; private boolean heuristicCachingEnabled; private float heuristicCoefficient; private TimeValue heuristicDefaultLifetime; private boolean sharedCache; private boolean freshnessCheckEnabled; private int asynchronousWorkers; private boolean neverCacheHTTP10ResponsesWithQuery; private boolean neverCacheHTTP11ResponsesWithQuery; private boolean staleIfErrorEnabled; Builder() { this.maxObjectSize = DEFAULT_MAX_OBJECT_SIZE_BYTES; this.maxCacheEntries = DEFAULT_MAX_CACHE_ENTRIES; this.maxUpdateRetries = DEFAULT_MAX_UPDATE_RETRIES; this.heuristicCachingEnabled = DEFAULT_HEURISTIC_CACHING_ENABLED; this.heuristicCoefficient = DEFAULT_HEURISTIC_COEFFICIENT; this.heuristicDefaultLifetime = DEFAULT_HEURISTIC_LIFETIME; this.sharedCache = true; this.freshnessCheckEnabled = true; this.asynchronousWorkers = DEFAULT_ASYNCHRONOUS_WORKERS; this.staleIfErrorEnabled = false; } /** * Specifies the maximum response body size that will be eligible for caching. * @param maxObjectSize size in bytes * @return this instance. */ public Builder setMaxObjectSize(final long maxObjectSize) { this.maxObjectSize = maxObjectSize; return this; } /** * Sets the maximum number of cache entries the cache will retain. * * @return this instance. */ public Builder setMaxCacheEntries(final int maxCacheEntries) { this.maxCacheEntries = maxCacheEntries; return this; } /** * Sets the number of times to retry a cache processChallenge on failure * * @return this instance. */ public Builder setMaxUpdateRetries(final int maxUpdateRetries) { this.maxUpdateRetries = maxUpdateRetries; return this; } /** * @return this instance. * @deprecated Has no effect. Do not use. */ @Deprecated public Builder setAllow303Caching(final boolean allow303Caching) { return this; } /** * @return this instance. * @deprecated No longer applicable. Do not use. */ @Deprecated public Builder setWeakETagOnPutDeleteAllowed(final boolean weakETagOnPutDeleteAllowed) { return this; } /** * Enables or disables heuristic caching. * @param heuristicCachingEnabled should be {@code true} to * permit heuristic caching, {@code false} to enable it. * @return this instance. */ public Builder setHeuristicCachingEnabled(final boolean heuristicCachingEnabled) { this.heuristicCachingEnabled = heuristicCachingEnabled; return this; } /** * Sets coefficient to be used in heuristic freshness caching. This is * interpreted as the fraction of the time between the {@code Last-Modified} * and {@code Date} headers of a cached response during which the cached * response will be considered heuristically fresh. * @param heuristicCoefficient should be between {@code 0.0} and * {@code 1.0}. * @return this instance. */ public Builder setHeuristicCoefficient(final float heuristicCoefficient) { this.heuristicCoefficient = heuristicCoefficient; return this; } /** * Sets default lifetime to be used if heuristic freshness calculation * is not possible. Explicit cache control directives on either the * request or origin response will override this, as will the heuristic * {@code Last-Modified} freshness calculation if it is available. * * @param heuristicDefaultLifetime is the number to consider a * cache-eligible response fresh in the absence of other information. * Set this to {@code 0} to disable this style of heuristic caching. * @return this instance. */ public Builder setHeuristicDefaultLifetime(final TimeValue heuristicDefaultLifetime) { this.heuristicDefaultLifetime = heuristicDefaultLifetime; return this; } /** * Sets whether the cache should behave as a shared cache or not. * @param sharedCache true to behave as a shared cache, false to * behave as a non-shared (private) cache. To have the cache * behave like a browser cache, you want to set this to {@code false}. * * @return this instance. */ public Builder setSharedCache(final boolean sharedCache) { this.sharedCache = sharedCache; return this; } /** * Sets the maximum number of threads to allow for background * revalidations due to the {@code stale-while-revalidate} directive. * @param asynchronousWorkers number of threads; a value of 0 disables background * revalidations. * @return this instance. */ public Builder setAsynchronousWorkers(final int asynchronousWorkers) { this.asynchronousWorkers = asynchronousWorkers; return this; } /** * Sets whether the cache should never cache HTTP 1.0 responses with a query string or not. * @param neverCacheHTTP10ResponsesWithQuery true to never cache responses with a query * string, false to cache if explicit cache headers are found. Set this to {@code true} * to better emulate IE, which also never caches responses, regardless of what caching * headers may be present. * @return this instance. */ public Builder setNeverCacheHTTP10ResponsesWithQueryString( final boolean neverCacheHTTP10ResponsesWithQuery) { this.neverCacheHTTP10ResponsesWithQuery = neverCacheHTTP10ResponsesWithQuery; return this; } /** * Enables or disables the stale-if-error cache directive. If this option * is enabled, cached responses that have become stale due to an error (such * as a server error or a network failure) will be returned instead of * generating a new request. This can help to reduce the load on the origin * server and improve performance. *

* By default, the stale-if-error directive is disabled. *

* * @param enabled a boolean value indicating whether the stale-if-error * directive should be enabled. * @return this instance. */ public Builder setStaleIfErrorEnabled(final boolean enabled) { this.staleIfErrorEnabled = enabled; return this; } public Builder setFreshnessCheckEnabled(final boolean freshnessCheckEnabled) { this.freshnessCheckEnabled = freshnessCheckEnabled; return this; } /** * Sets the flag indicating whether HTTP/1.1 responses with a query string should never be cached. * * @param neverCacheHTTP11ResponsesWithQuery whether to never cache HTTP/1.1 responses with a query string * @return this instance. */ public Builder setNeverCacheHTTP11ResponsesWithQueryString( final boolean neverCacheHTTP11ResponsesWithQuery) { this.neverCacheHTTP11ResponsesWithQuery = neverCacheHTTP11ResponsesWithQuery; return this; } public CacheConfig build() { return new CacheConfig( maxObjectSize, maxCacheEntries, maxUpdateRetries, heuristicCachingEnabled, heuristicCoefficient, heuristicDefaultLifetime, sharedCache, freshnessCheckEnabled, asynchronousWorkers, neverCacheHTTP10ResponsesWithQuery, neverCacheHTTP11ResponsesWithQuery, staleIfErrorEnabled); } } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("[maxObjectSize=").append(this.maxObjectSize) .append(", maxCacheEntries=").append(this.maxCacheEntries) .append(", maxUpdateRetries=").append(this.maxUpdateRetries) .append(", heuristicCachingEnabled=").append(this.heuristicCachingEnabled) .append(", heuristicCoefficient=").append(this.heuristicCoefficient) .append(", heuristicDefaultLifetime=").append(this.heuristicDefaultLifetime) .append(", sharedCache=").append(this.sharedCache) .append(", freshnessCheckEnabled=").append(this.freshnessCheckEnabled) .append(", asynchronousWorkers=").append(this.asynchronousWorkers) .append(", neverCacheHTTP10ResponsesWithQuery=").append(this.neverCacheHTTP10ResponsesWithQuery) .append(", neverCacheHTTP11ResponsesWithQuery=").append(this.neverCacheHTTP11ResponsesWithQuery) .append(", staleIfErrorEnabled=").append(this.staleIfErrorEnabled) .append("]"); return builder.toString(); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/HeapResource.java0100664 0000000 0000000 00000005035 14704162040 027730 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Cache resource backed by a byte array on the heap. * * @since 4.1 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class HeapResource extends Resource { private static final long serialVersionUID = -2078599905620463394L; private final AtomicReference arrayRef; public HeapResource(final byte[] b) { super(); this.arrayRef = new AtomicReference<>(b); } @Override public byte[] get() throws ResourceIOException { final byte[] byteArray = this.arrayRef.get(); if (byteArray != null) { return byteArray; } throw new ResourceIOException("Resource already disposed"); } @Override public long length() { final byte[] byteArray = this.arrayRef.get(); return byteArray != null ? byteArray.length : -1; } @Override public void dispose() { this.arrayRef.set(null); } @Override public String toString() { return "[" + "heap," + "len=" + length() + ']'; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttpClients.java0100664 0000000 0000000 00000004471 14666635064 031106 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.File; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; /** * Factory methods for {@link CloseableHttpClient} instances * capable of client-side caching. * * @since 4.3 */ public final class CachingHttpClients { private CachingHttpClients() { super(); } /** * Creates builder object for construction of custom * {@link CloseableHttpClient} instances. */ public static CachingHttpClientBuilder custom() { return CachingHttpClientBuilder.create(); } /** * Creates {@link CloseableHttpClient} instance that uses a memory bound * response cache. */ public static CloseableHttpClient createMemoryBound() { return CachingHttpClientBuilder.create().build(); } /** * Creates {@link CloseableHttpClient} instance that uses a file system * bound response cache. * * @param cacheDir location of response cache. */ public static CloseableHttpClient createFileBound(final File cacheDir) { return CachingHttpClientBuilder.create().setCacheDir(cacheDir).build(); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheKeyGenerator.java0100664 0000000 0000000 00000032435 14704162040 030672 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.net.URI; import java.net.URISyntaxException; import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.Collection; import java.util.Iterator; import java.util.List; import java.util.Locale; import java.util.Spliterator; import java.util.Spliterators; import java.util.concurrent.atomic.AtomicBoolean; import java.util.function.Consumer; import java.util.stream.StreamSupport; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.MessageHeaders; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.message.BasicHeaderElementIterator; import org.apache.hc.core5.http.message.BasicHeaderValueFormatter; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.net.PercentCodec; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.TextUtils; /** * @since 4.1 */ @Contract(threading = ThreadingBehavior.STATELESS) public class CacheKeyGenerator implements Resolver { /** * Default instance of {@link CacheKeyGenerator}. */ public static final CacheKeyGenerator INSTANCE = new CacheKeyGenerator(); @Override public String resolve(final URI uri) { return generateKey(uri); } /** * Returns text representation of the request URI of the given {@link HttpRequest}. * This method will use {@link HttpRequest#getPath()}, {@link HttpRequest#getScheme()} and * {@link HttpRequest#getAuthority()} values when available or attributes of target * {@link HttpHost } in order to construct an absolute URI. *

* This method will not attempt to ensure validity of the resultant text representation. * * @param target target host * @param request the {@link HttpRequest} * * @return String the request URI */ @Internal public static String getRequestUri(final HttpHost target, final HttpRequest request) { Args.notNull(target, "Target"); Args.notNull(request, "HTTP request"); final StringBuilder buf = new StringBuilder(); final URIAuthority authority = request.getAuthority(); if (authority != null) { final String scheme = request.getScheme(); buf.append(scheme != null ? scheme : URIScheme.HTTP.id).append("://"); buf.append(authority.getHostName()); if (authority.getPort() >= 0) { buf.append(":").append(authority.getPort()); } } else { buf.append(target.getSchemeName()).append("://"); buf.append(target.getHostName()); if (target.getPort() >= 0) { buf.append(":").append(target.getPort()); } } final String path = request.getPath(); if (path == null) { buf.append("/"); } else { if (buf.length() > 0 && !path.startsWith("/")) { buf.append("/"); } buf.append(path); } return buf.toString(); } /** * Returns normalized representation of the request URI optimized for use as a cache key. * This method ensures the resultant URI has an explicit port in the authority component, * and explicit path component and no fragment. */ @Internal public static URI normalize(final URI requestUri) throws URISyntaxException { Args.notNull(requestUri, "URI"); final URIBuilder builder = new URIBuilder(requestUri); if (builder.getHost() != null) { if (builder.getScheme() == null) { builder.setScheme(URIScheme.HTTP.id); } if (builder.getPort() <= -1) { if (URIScheme.HTTP.same(builder.getScheme())) { builder.setPort(80); } else if (URIScheme.HTTPS.same(builder.getScheme())) { builder.setPort(443); } } } builder.setFragment(null); return builder.optimize().build(); } /** * Lenient URI parser that normalizes valid {@link URI}s and returns {@code null} for malformed URIs. */ @Internal public static URI normalize(final String requestUri) { if (requestUri == null) { return null; } try { return CacheKeyGenerator.normalize(new URI(requestUri)); } catch (final URISyntaxException ex) { return null; } } /** * Computes a key for the given request {@link URI} that can be used as * a unique identifier for cached resources. The URI is expected to * in an absolute form. * * @param requestUri request URI * @return cache key */ public String generateKey(final URI requestUri) { try { final URI normalizeRequestUri = normalize(requestUri); return normalizeRequestUri.toASCIIString(); } catch (final URISyntaxException ex) { return requestUri.toASCIIString(); } } /** * Computes a root key for the given {@link HttpHost} and {@link HttpRequest} * that can be used as a unique identifier for cached resources. * * @param host The host for this request * @param request the {@link HttpRequest} * @return cache key */ public String generateKey(final HttpHost host, final HttpRequest request) { final String s = getRequestUri(host, request); try { return generateKey(new URI(s)); } catch (final URISyntaxException ex) { return s; } } /** * Returns all variant names contained in {@literal VARY} headers of the given message. * * @since 5.4 */ public static List variantNames(final MessageHeaders message) { if (message == null) { return null; } final List names = new ArrayList<>(); for (final Iterator

it = message.headerIterator(HttpHeaders.VARY); it.hasNext(); ) { final Header header = it.next(); MessageSupport.parseTokens(header, names::add); } return names; } @Internal public static void normalizeElements(final MessageHeaders message, final String headerName, final Consumer consumer) { // User-Agent as a special case due to its grammar if (headerName.equalsIgnoreCase(HttpHeaders.USER_AGENT)) { final Header header = message.getFirstHeader(headerName); if (header != null) { consumer.accept(header.getValue().toLowerCase(Locale.ROOT)); } } else { normalizeElements(message.headerIterator(headerName), consumer); } } @Internal public static void normalizeElements(final Iterator
iterator, final Consumer consumer) { final Iterator it = new BasicHeaderElementIterator(iterator); StreamSupport.stream(Spliterators.spliteratorUnknownSize(it, Spliterator.NONNULL), false) .filter(e -> !TextUtils.isBlank(e.getName())) .map(e -> { if (e.getValue() == null && e.getParameterCount() == 0) { return e.getName().toLowerCase(Locale.ROOT); } final CharArrayBuffer buf = new CharArrayBuffer(1024); BasicHeaderValueFormatter.INSTANCE.formatNameValuePair( buf, new BasicNameValuePair( e.getName().toLowerCase(Locale.ROOT), !TextUtils.isBlank(e.getValue()) ? e.getValue() : null), false); if (e.getParameterCount() > 0) { for (final NameValuePair nvp : e.getParameters()) { if (!TextUtils.isBlank(nvp.getName())) { buf.append(';'); BasicHeaderValueFormatter.INSTANCE.formatNameValuePair( buf, new BasicNameValuePair( nvp.getName().toLowerCase(Locale.ROOT), !TextUtils.isBlank(nvp.getValue()) ? nvp.getValue() : null), false); } } } return buf.toString(); }) .sorted() .distinct() .forEach(consumer); } /** * Computes a "variant key" for the given request and the given variants. * @param request originating request * @param variantNames variant names * @return variant key * * @since 5.4 */ public String generateVariantKey(final HttpRequest request, final Collection variantNames) { Args.notNull(variantNames, "Variant names"); final StringBuilder buf = new StringBuilder("{"); final AtomicBoolean firstHeader = new AtomicBoolean(); variantNames.stream() .map(h -> h.toLowerCase(Locale.ROOT)) .sorted() .distinct() .forEach(h -> { if (!firstHeader.compareAndSet(false, true)) { buf.append("&"); } buf.append(PercentCodec.encode(h, StandardCharsets.UTF_8)).append("="); final AtomicBoolean firstToken = new AtomicBoolean(); normalizeElements(request, h, t -> { if (!firstToken.compareAndSet(false, true)) { buf.append(","); } buf.append(PercentCodec.encode(t, StandardCharsets.UTF_8)); }); }); buf.append("}"); return buf.toString(); } /** * Computes a "variant key" from the headers of the given request if the given * cache entry can have variants ({@code Vary} header is present). * * @param request originating request * @param entry cache entry * @return variant key if the given cache entry can have variants, {@code null} otherwise. */ public String generateVariantKey(final HttpRequest request, final HttpCacheEntry entry) { if (entry.containsHeader(HttpHeaders.VARY)) { final List variantNames = variantNames(entry); return generateVariantKey(request, variantNames); } return null; } /** * Computes a key for the given {@link HttpHost} and {@link HttpRequest} * that can be used as a unique identifier for cached resources. if the request has a * {@literal VARY} header the identifier will also include variant key. * * @param host The host for this request * @param request the {@link HttpRequest} * @param entry the parent entry used to track the variants * @return cache key * * @deprecated Use {@link #generateKey(HttpHost, HttpRequest)} or {@link #generateVariantKey(HttpRequest, Collection)} */ @Deprecated public String generateKey(final HttpHost host, final HttpRequest request, final HttpCacheEntry entry) { final String rootKey = generateKey(host, request); final List variantNames = variantNames(entry); if (variantNames.isEmpty()) { return rootKey; } return generateVariantKey(request, variantNames) + rootKey; } } ././@LongLink0100644 0000000 0000000 00000000154 15005672016 011635 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachedResponseSuitabilityChecker.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachedResponseSuitabilityCheck0100664 0000000 0000000 00000042540 15005672016 032500 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.net.URI; import java.net.URISyntaxException; import java.time.Instant; import java.util.ArrayList; import java.util.HashSet; import java.util.Iterator; import java.util.List; import java.util.Locale; import java.util.Objects; import java.util.Set; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Determines whether a given {@link HttpCacheEntry} is suitable to be * used as a response for a given {@link HttpRequest}. */ class CachedResponseSuitabilityChecker { private static final Logger LOG = LoggerFactory.getLogger(CachedResponseSuitabilityChecker.class); private final CacheValidityPolicy validityStrategy; private final boolean sharedCache; private final boolean staleifError; CachedResponseSuitabilityChecker(final CacheValidityPolicy validityStrategy, final CacheConfig config) { super(); this.validityStrategy = validityStrategy; this.sharedCache = config.isSharedCache(); this.staleifError = config.isStaleIfErrorEnabled(); } CachedResponseSuitabilityChecker(final CacheConfig config) { this(new CacheValidityPolicy(config), config); } /** * Determine if I can utilize the given {@link HttpCacheEntry} to respond to the given * {@link HttpRequest}. * * @since 5.4 */ public CacheSuitability assessSuitability(final RequestCacheControl requestCacheControl, final ResponseCacheControl responseCacheControl, final HttpRequest request, final HttpCacheEntry entry, final Instant now) { if (!requestMethodMatch(request, entry)) { LOG.debug("Request method and the cache entry method do not match"); return CacheSuitability.MISMATCH; } if (!requestUriMatch(request, entry)) { LOG.debug("Target request URI and the cache entry request URI do not match"); return CacheSuitability.MISMATCH; } if (!requestHeadersMatch(request, entry)) { LOG.debug("Request headers nominated by the cached response do not match those of the request associated with the cache entry"); return CacheSuitability.MISMATCH; } if (!requestHeadersMatch(request, entry)) { LOG.debug("Request headers nominated by the cached response do not match those of the request associated with the cache entry"); return CacheSuitability.MISMATCH; } if (requestCacheControl.isNoCache()) { LOG.debug("Request contained no-cache directive; the cache entry must be re-validated"); return CacheSuitability.REVALIDATION_REQUIRED; } if (isResponseNoCache(responseCacheControl, entry)) { LOG.debug("Response contained no-cache directive; the cache entry must be re-validated"); return CacheSuitability.REVALIDATION_REQUIRED; } if (hasUnsupportedConditionalHeaders(request)) { LOG.debug("Response from cache is not suitable due to the request containing unsupported conditional headers"); return CacheSuitability.REVALIDATION_REQUIRED; } if (!isConditional(request) && entry.getStatus() == HttpStatus.SC_NOT_MODIFIED) { LOG.debug("Unconditional request and non-modified cached response"); return CacheSuitability.REVALIDATION_REQUIRED; } if (!allConditionalsMatch(request, entry, now)) { LOG.debug("Response from cache is not suitable due to the conditional request and with mismatched conditions"); return CacheSuitability.REVALIDATION_REQUIRED; } final TimeValue currentAge = validityStrategy.getCurrentAge(entry, now); if (LOG.isDebugEnabled()) { LOG.debug("Cache entry current age: {}", currentAge); } final TimeValue freshnessLifetime = validityStrategy.getFreshnessLifetime(responseCacheControl, entry); if (LOG.isDebugEnabled()) { LOG.debug("Cache entry freshness lifetime: {}", freshnessLifetime); } final boolean fresh = currentAge.compareTo(freshnessLifetime) < 0; if (!fresh && responseCacheControl.isMustRevalidate()) { LOG.debug("Response from cache is not suitable due to the response must-revalidate requirement"); return CacheSuitability.REVALIDATION_REQUIRED; } if (!fresh && sharedCache && responseCacheControl.isProxyRevalidate()) { LOG.debug("Response from cache is not suitable due to the response proxy-revalidate requirement"); return CacheSuitability.REVALIDATION_REQUIRED; } if (fresh && requestCacheControl.getMaxAge() >= 0) { if (currentAge.toSeconds() > requestCacheControl.getMaxAge() && requestCacheControl.getMaxStale() == -1) { LOG.debug("Response from cache is not suitable due to the request max-age requirement"); return CacheSuitability.REVALIDATION_REQUIRED; } } if (fresh && requestCacheControl.getMinFresh() >= 0) { if (requestCacheControl.getMinFresh() == 0 || freshnessLifetime.toSeconds() - currentAge.toSeconds() < requestCacheControl.getMinFresh()) { LOG.debug("Response from cache is not suitable due to the request min-fresh requirement"); return CacheSuitability.REVALIDATION_REQUIRED; } } if (requestCacheControl.getMaxStale() >= 0) { final long stale = currentAge.compareTo(freshnessLifetime) > 0 ? currentAge.toSeconds() - freshnessLifetime.toSeconds() : 0; if (LOG.isDebugEnabled()) { LOG.debug("Cache entry staleness: {} SECONDS", stale); } if (stale >= requestCacheControl.getMaxStale()) { LOG.debug("Response from cache is not suitable due to the request max-stale requirement"); return CacheSuitability.REVALIDATION_REQUIRED; } LOG.debug("The cache entry is fresh enough"); return CacheSuitability.FRESH_ENOUGH; } if (fresh) { LOG.debug("The cache entry is fresh"); return CacheSuitability.FRESH; } if (responseCacheControl.getStaleWhileRevalidate() > 0) { final long stale = currentAge.compareTo(freshnessLifetime) > 0 ? currentAge.toSeconds() - freshnessLifetime.toSeconds() : 0; if (stale < responseCacheControl.getStaleWhileRevalidate()) { LOG.debug("The cache entry is stale but suitable while being revalidated"); return CacheSuitability.STALE_WHILE_REVALIDATED; } } LOG.debug("The cache entry is stale"); return CacheSuitability.STALE; } boolean requestMethodMatch(final HttpRequest request, final HttpCacheEntry entry) { return request.getMethod().equalsIgnoreCase(entry.getRequestMethod()) || Method.HEAD.isSame(request.getMethod()) && Method.GET.isSame(entry.getRequestMethod()); } boolean requestUriMatch(final HttpRequest request, final HttpCacheEntry entry) { try { final URI requestURI = CacheKeyGenerator.normalize(request.getUri()); final URI cacheURI = new URI(entry.getRequestURI()); if (requestURI.isAbsolute()) { return Objects.equals(requestURI, cacheURI); } return Objects.equals(requestURI.getPath(), cacheURI.getPath()) && Objects.equals(requestURI.getQuery(), cacheURI.getQuery()); } catch (final URISyntaxException ex) { return false; } } boolean requestHeadersMatch(final HttpRequest request, final HttpCacheEntry entry) { final Iterator
it = entry.headerIterator(HttpHeaders.VARY); if (it.hasNext()) { final Set headerNames = new HashSet<>(); while (it.hasNext()) { final Header header = it.next(); MessageSupport.parseTokens(header, e -> { headerNames.add(e.toLowerCase(Locale.ROOT)); }); } final List tokensInRequest = new ArrayList<>(); final List tokensInCache = new ArrayList<>(); for (final String headerName: headerNames) { if (headerName.equalsIgnoreCase("*")) { return false; } CacheKeyGenerator.normalizeElements(request, headerName, tokensInRequest::add); CacheKeyGenerator.normalizeElements(entry.requestHeaders(), headerName, tokensInCache::add); if (!Objects.equals(tokensInRequest, tokensInCache)) { return false; } } } return true; } /** * Determines if the given {@link HttpCacheEntry} requires revalidation based on the presence of the {@code no-cache} directive * in the Cache-Control header. *

* The method returns true in the following cases: * - If the {@code no-cache} directive is present without any field names (unqualified). * - If the {@code no-cache} directive is present with field names, and at least one of these field names is present * in the headers of the {@link HttpCacheEntry}. *

* If the {@code no-cache} directive is not present in the Cache-Control header, the method returns {@code false}. */ boolean isResponseNoCache(final ResponseCacheControl responseCacheControl, final HttpCacheEntry entry) { // If no-cache directive is present and has no field names if (responseCacheControl.isNoCache()) { final Set noCacheFields = responseCacheControl.getNoCacheFields(); if (noCacheFields.isEmpty()) { LOG.debug("Revalidation required due to unqualified no-cache directive"); return true; } for (final String field : noCacheFields) { if (entry.containsHeader(field)) { if (LOG.isDebugEnabled()) { LOG.debug("Revalidation required due to no-cache directive with field {}", field); } return true; } } } return false; } /** * Is this request the type of conditional request we support? * @param request The current httpRequest being made * @return {@code true} if the request is supported */ public boolean isConditional(final HttpRequest request) { return hasSupportedEtagValidator(request) || hasSupportedLastModifiedValidator(request); } /** * Check that conditionals that are part of this request match * @param request The current httpRequest being made * @param entry the cache entry * @param now right NOW in time * @return {@code true} if the request matches all conditionals */ public boolean allConditionalsMatch(final HttpRequest request, final HttpCacheEntry entry, final Instant now) { final boolean hasEtagValidator = hasSupportedEtagValidator(request); final boolean hasLastModifiedValidator = hasSupportedLastModifiedValidator(request); if (!hasEtagValidator && !hasLastModifiedValidator) { return true; } final boolean etagValidatorMatches = hasEtagValidator && etagValidatorMatches(request, entry); final boolean lastModifiedValidatorMatches = hasLastModifiedValidator && lastModifiedValidatorMatches(request, entry, now); if (hasEtagValidator && hasLastModifiedValidator && !(etagValidatorMatches && lastModifiedValidatorMatches)) { return false; } else if (hasEtagValidator && !etagValidatorMatches) { return false; } return !hasLastModifiedValidator || lastModifiedValidatorMatches; } boolean hasUnsupportedConditionalHeaders(final HttpRequest request) { return request.containsHeader(HttpHeaders.IF_RANGE) || request.containsHeader(HttpHeaders.IF_MATCH) || request.containsHeader(HttpHeaders.IF_UNMODIFIED_SINCE); } boolean hasSupportedEtagValidator(final HttpRequest request) { return request.containsHeader(HttpHeaders.IF_NONE_MATCH); } boolean hasSupportedLastModifiedValidator(final HttpRequest request) { return request.containsHeader(HttpHeaders.IF_MODIFIED_SINCE); } /** * Check entry against If-None-Match * @param request The current httpRequest being made * @param entry the cache entry * @return boolean does the etag validator match */ boolean etagValidatorMatches(final HttpRequest request, final HttpCacheEntry entry) { final ETag etag = entry.getETag(); if (etag == null) { return false; } final Iterator it = MessageSupport.iterateTokens(request, HttpHeaders.IF_NONE_MATCH); while (it.hasNext()) { final String token = it.next(); if ("*".equals(token) || ETag.weakCompare(etag, ETag.parse(token))) { return true; } } return false; } /** * Check entry against If-Modified-Since, if If-Modified-Since is in the future it is invalid * @param request The current httpRequest being made * @param entry the cache entry * @param now right NOW in time * @return boolean Does the last modified header match */ boolean lastModifiedValidatorMatches(final HttpRequest request, final HttpCacheEntry entry, final Instant now) { final Instant lastModified = entry.getLastModified(); if (lastModified == null) { return false; } for (final Header h : request.getHeaders(HttpHeaders.IF_MODIFIED_SINCE)) { final Instant ifModifiedSince = DateUtils.parseStandardDate(h.getValue()); if (ifModifiedSince != null) { if (ifModifiedSince.isAfter(now) || lastModified.isAfter(ifModifiedSince)) { return false; } } } return true; } public boolean isSuitableIfError(final RequestCacheControl requestCacheControl, final ResponseCacheControl responseCacheControl, final HttpCacheEntry entry, final Instant now) { // Explicit cache control if (requestCacheControl.getStaleIfError() > 0 || responseCacheControl.getStaleIfError() > 0) { final TimeValue currentAge = validityStrategy.getCurrentAge(entry, now); final TimeValue freshnessLifetime = validityStrategy.getFreshnessLifetime(responseCacheControl, entry); if (requestCacheControl.getMinFresh() > 0 && requestCacheControl.getMinFresh() < freshnessLifetime.toSeconds()) { return false; } final long stale = currentAge.compareTo(freshnessLifetime) > 0 ? currentAge.toSeconds() - freshnessLifetime.toSeconds() : 0; if (requestCacheControl.getStaleIfError() > 0 && stale < requestCacheControl.getStaleIfError()) { return true; } if (responseCacheControl.getStaleIfError() > 0 && stale < responseCacheControl.getStaleIfError()) { return true; } } // Global override if (staleifError && requestCacheControl.getStaleIfError() == -1 && responseCacheControl.getStaleIfError() == -1) { return true; } return false; } }httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ResponseCacheConformance.java0100664 0000000 0000000 00000006312 14704162040 032237 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.IOException; import java.time.Instant; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.protocol.HttpContext; /** * This response interceptor removes common {@literal Content-} headers from the 304 * response messages based on the provision of the HTTP specification that 304 * status code represents a confirmation that the requested resource content has * not changed since its retrieval or the last update and adds {@literal Date} * header if it is not present in the response message.. */ @Contract(threading = ThreadingBehavior.IMMUTABLE) class ResponseCacheConformance implements HttpResponseInterceptor { public static final ResponseCacheConformance INSTANCE = new ResponseCacheConformance(); private final static String[] DISALLOWED_ENTITY_HEADERS = { HttpHeaders.CONTENT_ENCODING, HttpHeaders.CONTENT_LANGUAGE, HttpHeaders.CONTENT_LENGTH, HttpHeaders.CONTENT_MD5, HttpHeaders.CONTENT_RANGE, HttpHeaders.CONTENT_TYPE }; @Override public void process(final HttpResponse response, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { if (response.getCode() == HttpStatus.SC_NOT_MODIFIED) { for (final String headerName : DISALLOWED_ENTITY_HEADERS) { response.removeHeaders(headerName); } } if (!response.containsHeader(HttpHeaders.DATE)) { response.addHeader(new BasicHeader(HttpHeaders.DATE, Instant.now())); } } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ResponseViaCache.java0100664 0000000 0000000 00000004703 14704162040 030526 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.IOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.protocol.HttpContext; /** * This response interceptor adds {@literal VIA} header to all incoming * response messages dispatched through the caching layer. */ @Contract(threading = ThreadingBehavior.IMMUTABLE) class ResponseViaCache implements HttpResponseInterceptor { /** * Default instance of {@link ResponseViaCache}. */ public static final ResponseViaCache INSTANCE = new ResponseViaCache(); @Override public void process(final HttpResponse response, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { final ProtocolVersion protocolVersion = context.getProtocolVersion(); response.addHeader(HttpHeaders.VIA, ViaCacheGenerator.INSTANCE.lookup(protocolVersion)); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheValidityPolicy.java0100664 0000000 0000000 00000023637 14704162040 031244 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.time.Duration; import java.time.Instant; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; class CacheValidityPolicy { private static final Logger LOG = LoggerFactory.getLogger(CacheValidityPolicy.class); private final boolean shared; private final boolean useHeuristicCaching; private final float heuristicCoefficient; private final TimeValue heuristicDefaultLifetime; /** * Constructs a CacheValidityPolicy with the provided CacheConfig. If the config is null, it will use * default heuristic coefficient and default heuristic lifetime from CacheConfig.DEFAULT. * * @param config The CacheConfig to use for this CacheValidityPolicy. If null, default values are used. */ CacheValidityPolicy(final CacheConfig config) { super(); this.shared = config != null ? config.isSharedCache() : CacheConfig.DEFAULT.isSharedCache(); this.useHeuristicCaching = config != null ? config.isHeuristicCachingEnabled() : CacheConfig.DEFAULT.isHeuristicCachingEnabled(); this.heuristicCoefficient = config != null ? config.getHeuristicCoefficient() : CacheConfig.DEFAULT.getHeuristicCoefficient(); this.heuristicDefaultLifetime = config != null ? config.getHeuristicDefaultLifetime() : CacheConfig.DEFAULT.getHeuristicDefaultLifetime(); } /** * Default constructor for CacheValidityPolicy. Initializes the policy with default values. */ CacheValidityPolicy() { this(null); } public TimeValue getCurrentAge(final HttpCacheEntry entry, final Instant now) { return TimeValue.ofSeconds(getCorrectedInitialAge(entry).toSeconds() + getResidentTime(entry, now).toSeconds()); } /** * Calculate the freshness lifetime of a response based on the provided cache control and cache entry. *

    *
  • If the cache is shared and the s-maxage response directive is present, use its value.
    • *
  • If the max-age response directive is present, use its value.
    • *
  • If the Expires response header field is present, use its value minus the value of the Date response header field.
    • *
  • Otherwise, a heuristic freshness lifetime might be applicable.
    • *
* * @param responseCacheControl the cache control directives associated with the response. * @param entry the cache entry associated with the response. * @return the calculated freshness lifetime as a {@link TimeValue}. */ public TimeValue getFreshnessLifetime(final ResponseCacheControl responseCacheControl, final HttpCacheEntry entry) { // If the cache is shared and the s-maxage response directive is present, use its value if (shared) { final long sharedMaxAge = responseCacheControl.getSharedMaxAge(); if (sharedMaxAge > -1) { if (LOG.isDebugEnabled()) { LOG.debug("Using s-maxage directive for freshness lifetime calculation: {} seconds", sharedMaxAge); } return TimeValue.ofSeconds(sharedMaxAge); } } // If the max-age response directive is present, use its value final long maxAge = responseCacheControl.getMaxAge(); if (maxAge > -1) { if (LOG.isDebugEnabled()) { LOG.debug("Using max-age directive for freshness lifetime calculation: {} seconds", maxAge); } return TimeValue.ofSeconds(maxAge); } // If the Expires response header field is present, use its value minus the value of the Date response header field final Instant dateValue = entry.getInstant(); if (dateValue != null) { final Instant expiry = entry.getExpires(); if (expiry != null) { final Duration diff = Duration.between(dateValue, expiry); if (diff.isNegative()) { if (LOG.isDebugEnabled()) { LOG.debug("Negative freshness lifetime detected. Content is already expired. Returning zero freshness lifetime."); } return TimeValue.ZERO_MILLISECONDS; } return TimeValue.ofSeconds(diff.getSeconds()); } } if (useHeuristicCaching) { // No explicit expiration time is present in the response. A heuristic freshness lifetime might be applicable if (LOG.isDebugEnabled()) { LOG.debug("No explicit expiration time present in the response. Using heuristic freshness lifetime calculation."); } return getHeuristicFreshnessLifetime(entry); } return TimeValue.ZERO_MILLISECONDS; } TimeValue getHeuristicFreshnessLifetime(final HttpCacheEntry entry) { final Instant dateValue = entry.getInstant(); final Instant lastModifiedValue = entry.getLastModified(); if (dateValue != null && lastModifiedValue != null) { final Duration diff = Duration.between(lastModifiedValue, dateValue); if (diff.isNegative()) { return TimeValue.ZERO_MILLISECONDS; } return TimeValue.ofSeconds((long) (heuristicCoefficient * diff.getSeconds())); } return heuristicDefaultLifetime; } TimeValue getApparentAge(final HttpCacheEntry entry) { final Instant dateValue = entry.getInstant(); if (dateValue == null) { return CacheSupport.MAX_AGE; } final Duration diff = Duration.between(dateValue, entry.getResponseInstant()); if (diff.isNegative()) { return TimeValue.ZERO_MILLISECONDS; } return TimeValue.ofSeconds(diff.getSeconds()); } /** * Extracts and processes the Age value from an HttpCacheEntry by tokenizing the Age header value. * The Age header value is interpreted as a sequence of tokens, and the first token is parsed into a number * representing the age in delta-seconds. If the first token cannot be parsed into a number, the Age value is * considered as invalid and this method returns 0. If the first token represents a negative number or a number * that exceeds Integer.MAX_VALUE, the Age value is set to MAX_AGE (in seconds). * This method uses CacheSupport.parseTokens to robustly handle the Age header value. *

* Note: If the HttpCacheEntry contains multiple Age headers, only the first one is considered. * * @param entry The HttpCacheEntry from which to extract the Age value. * @return The Age value in delta-seconds, or MAX_AGE in seconds if the Age value exceeds Integer.MAX_VALUE or * is negative. If the Age value is invalid (cannot be parsed into a number or contains non-numeric characters), * this method returns 0. */ long getAgeValue(final HttpCacheEntry entry) { final Header age = entry.getFirstHeader(HttpHeaders.AGE); if (age != null) { final AtomicReference firstToken = new AtomicReference<>(); MessageSupport.parseTokens(age, token -> firstToken.compareAndSet(null, token)); final long delta = CacheSupport.deltaSeconds(firstToken.get()); if (delta == -1 && LOG.isDebugEnabled()) { LOG.debug("Malformed Age value: {}", age); } return delta > 0 ? delta : 0; } // If we've got here, there were no valid Age headers return 0; } TimeValue getCorrectedAgeValue(final HttpCacheEntry entry) { final long ageValue = getAgeValue(entry); final long responseDelay = getResponseDelay(entry).toSeconds(); return TimeValue.ofSeconds(ageValue + responseDelay); } TimeValue getResponseDelay(final HttpCacheEntry entry) { final Duration diff = Duration.between(entry.getRequestInstant(), entry.getResponseInstant()); return TimeValue.ofSeconds(diff.getSeconds()); } TimeValue getCorrectedInitialAge(final HttpCacheEntry entry) { final long apparentAge = getApparentAge(entry).toSeconds(); final long correctedReceivedAge = getCorrectedAgeValue(entry).toSeconds(); return TimeValue.ofSeconds(Math.max(apparentAge, correctedReceivedAge)); } TimeValue getResidentTime(final HttpCacheEntry entry, final Instant now) { final Duration diff = Duration.between(entry.getResponseInstant(), now); return TimeValue.ofSeconds(diff.getSeconds()); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheControlHeaderParser.java0100664 0000000 0000000 00000027647 14704162040 032212 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.HashSet; import java.util.Iterator; import java.util.Set; import java.util.function.BiConsumer; import org.apache.hc.client5.http.cache.HeaderConstants; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.FormattedHeader; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.TextUtils; import org.apache.hc.core5.util.Tokenizer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * A parser for the HTTP Cache-Control header that can be used to extract information about caching directives. *

* This class is thread-safe and has a singleton instance ({@link #INSTANCE}). *

*

* The {@link #parseResponse(Iterator)} method takes an HTTP header and returns a {@link ResponseCacheControl} object containing * the relevant caching directives. The header can be either a {@link FormattedHeader} object, which contains a * pre-parsed {@link CharArrayBuffer}, or a plain {@link Header} object, in which case the value will be parsed and * stored in a new {@link CharArrayBuffer}. *

*

* This parser only supports two directives: "max-age" and "s-maxage". If either of these directives are present in the * header, their values will be parsed and stored in the {@link ResponseCacheControl} object. If both directives are * present, the value of "s-maxage" takes precedence. *

*/ @Internal @Contract(threading = ThreadingBehavior.IMMUTABLE) class CacheControlHeaderParser { /** * The singleton instance of this parser. */ public static final CacheControlHeaderParser INSTANCE = new CacheControlHeaderParser(); /** * The logger for this class. */ private static final Logger LOG = LoggerFactory.getLogger(CacheControlHeaderParser.class); private final static char EQUAL_CHAR = '='; /** * The set of characters that can delimit a token in the header. */ private static final Tokenizer.Delimiter TOKEN_DELIMS = Tokenizer.delimiters(EQUAL_CHAR, ','); /** * The set of characters that can delimit a value in the header. */ private static final Tokenizer.Delimiter VALUE_DELIMS = Tokenizer.delimiters(EQUAL_CHAR, ','); /** * The token parser used to extract values from the header. */ private final Tokenizer tokenParser; /** * Constructs a new instance of this parser. */ protected CacheControlHeaderParser() { super(); this.tokenParser = Tokenizer.INSTANCE; } public void parse(final Iterator
headerIterator, final BiConsumer consumer) { while (headerIterator.hasNext()) { final Header header = headerIterator.next(); final CharArrayBuffer buffer; final Tokenizer.Cursor cursor; if (header instanceof FormattedHeader) { buffer = ((FormattedHeader) header).getBuffer(); cursor = new Tokenizer.Cursor(((FormattedHeader) header).getValuePos(), buffer.length()); } else { final String s = header.getValue(); if (s == null) { continue; } buffer = new CharArrayBuffer(s.length()); buffer.append(s); cursor = new Tokenizer.Cursor(0, buffer.length()); } // Parse the header while (!cursor.atEnd()) { final String name = tokenParser.parseToken(buffer, cursor, TOKEN_DELIMS); String value = null; if (!cursor.atEnd()) { final int valueDelim = buffer.charAt(cursor.getPos()); cursor.updatePos(cursor.getPos() + 1); if (valueDelim == EQUAL_CHAR) { value = tokenParser.parseValue(buffer, cursor, VALUE_DELIMS); if (!cursor.atEnd()) { cursor.updatePos(cursor.getPos() + 1); } } } consumer.accept(name, value); } } } /** * Parses the specified response header and returns a new {@link ResponseCacheControl} instance containing * the relevant caching directives. * *

The returned {@link ResponseCacheControl} instance will contain the values for "max-age" and "s-maxage" * caching directives parsed from the input header. If the input header does not contain any caching directives * or if the directives are malformed, the returned {@link ResponseCacheControl} instance will have default values * for "max-age" and "s-maxage" (-1).

* * @param headerIterator the header to parse, cannot be {@code null} * @return a new {@link ResponseCacheControl} instance containing the relevant caching directives parsed * from the response header * @throws IllegalArgumentException if the input header is {@code null} */ public final ResponseCacheControl parseResponse(final Iterator
headerIterator) { Args.notNull(headerIterator, "headerIterator"); final ResponseCacheControl.Builder builder = ResponseCacheControl.builder(); parse(headerIterator, (name, value) -> { if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_S_MAX_AGE)) { builder.setSharedMaxAge(parseSeconds(name, value)); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_MAX_AGE)) { builder.setMaxAge(parseSeconds(name, value)); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_MUST_REVALIDATE)) { builder.setMustRevalidate(true); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_NO_CACHE)) { builder.setNoCache(true); if (value != null) { final Tokenizer.Cursor valCursor = new ParserCursor(0, value.length()); final Set noCacheFields = new HashSet<>(); while (!valCursor.atEnd()) { final String token = tokenParser.parseToken(value, valCursor, VALUE_DELIMS); if (!TextUtils.isBlank(token)) { noCacheFields.add(token); } if (!valCursor.atEnd()) { valCursor.updatePos(valCursor.getPos() + 1); } } builder.setNoCacheFields(noCacheFields); } } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_NO_STORE)) { builder.setNoStore(true); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_PRIVATE)) { builder.setCachePrivate(true); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_PROXY_REVALIDATE)) { builder.setProxyRevalidate(true); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_PUBLIC)) { builder.setCachePublic(true); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_STALE_WHILE_REVALIDATE)) { builder.setStaleWhileRevalidate(parseSeconds(name, value)); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_STALE_IF_ERROR)) { builder.setStaleIfError(parseSeconds(name, value)); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_MUST_UNDERSTAND)) { builder.setMustUnderstand(true); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_IMMUTABLE)) { builder.setImmutable(true); } }); return builder.build(); } public final ResponseCacheControl parse(final HttpResponse response) { return parseResponse(response.headerIterator(HttpHeaders.CACHE_CONTROL)); } public final ResponseCacheControl parse(final HttpCacheEntry cacheEntry) { return parseResponse(cacheEntry.headerIterator(HttpHeaders.CACHE_CONTROL)); } /** * Parses the specified request header and returns a new {@link RequestCacheControl} instance containing * the relevant caching directives. * * @param headerIterator the header to parse, cannot be {@code null} * @return a new {@link RequestCacheControl} instance containing the relevant caching directives parsed * from the request header * @throws IllegalArgumentException if the input header is {@code null} */ public final RequestCacheControl parseRequest(final Iterator
headerIterator) { Args.notNull(headerIterator, "headerIterator"); final RequestCacheControl.Builder builder = RequestCacheControl.builder(); parse(headerIterator, (name, value) -> { if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_MAX_AGE)) { builder.setMaxAge(parseSeconds(name, value)); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_MAX_STALE)) { builder.setMaxStale(parseSeconds(name, value)); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_MIN_FRESH)) { builder.setMinFresh(parseSeconds(name, value)); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_NO_STORE)) { builder.setNoStore(true); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_NO_CACHE)) { builder.setNoCache(true); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_ONLY_IF_CACHED)) { builder.setOnlyIfCached(true); } else if (name.equalsIgnoreCase(HeaderConstants.CACHE_CONTROL_STALE_IF_ERROR)) { builder.setStaleIfError(parseSeconds(name, value)); } }); return builder.build(); } public final RequestCacheControl parse(final HttpRequest request) { return parseRequest(request.headerIterator(HttpHeaders.CACHE_CONTROL)); } private static long parseSeconds(final String name, final String value) { final long delta = CacheSupport.deltaSeconds(value); if (delta == -1 && LOG.isDebugEnabled()) { LOG.debug("Directive {} is malformed: {}", name, value); } return delta; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ehcache/0040775 0000000 0000000 00000000000 14704162040 026060 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ehcache/package-info.java0100664 0000000 0000000 00000002463 14666635064 031273 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Ehcache based caching backend implementation. */ package org.apache.hc.client5.http.impl.cache.ehcache; ././@LongLink0100644 0000000 0000000 00000000153 14704162040 011630 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ehcache/EhcacheHttpCacheStorage.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ehcache/EhcacheHttpCacheStorag0100664 0000000 0000000 00000013441 14704162040 032267 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache.ehcache; import java.util.Collection; import java.util.HashMap; import java.util.Map; import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer; import org.apache.hc.client5.http.cache.HttpCacheStorageEntry; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.client5.http.impl.cache.AbstractSerializingCacheStorage; import org.apache.hc.client5.http.impl.cache.CacheConfig; import org.apache.hc.client5.http.impl.cache.HttpByteArrayCacheEntrySerializer; import org.apache.hc.client5.http.impl.cache.NoopCacheEntrySerializer; import org.apache.hc.core5.util.Args; import org.ehcache.Cache; /** *

This class is a storage backend for cache entries that uses the * popular Ehcache cache implementation. * In particular, this backend allows for spillover to disk, where the * cache can be effectively larger than memory, and cached responses are * paged into and out of memory from disk as needed.

* *

N.B. Since the Ehcache is configured ahead of time with a * maximum number of cache entries, this effectively ignores the * {@link CacheConfig#getMaxCacheEntries()} maximum cache entries} * specified by a provided {@link CacheConfig}.

* *

Please refer to the * Ehcache documentation for details on how to configure the Ehcache * itself.

* @since 4.1 */ public class EhcacheHttpCacheStorage extends AbstractSerializingCacheStorage { /** * Creates cache that stores {@link HttpCacheStorageEntry}s without direct serialization. * * @since 5.0 */ public static EhcacheHttpCacheStorage createObjectCache( final Cache cache, final CacheConfig config) { return new EhcacheHttpCacheStorage<>(cache, config, NoopCacheEntrySerializer.INSTANCE); } /** * Creates cache that stores serialized {@link HttpCacheStorageEntry}s. * * @since 5.0 */ public static EhcacheHttpCacheStorage createSerializedCache( final Cache cache, final CacheConfig config) { return new EhcacheHttpCacheStorage<>(cache, config, HttpByteArrayCacheEntrySerializer.INSTANCE); } private final Cache cache; /** * Constructs a storage backend using the provided Ehcache * with the given configuration options, but using an alternative * cache entry serialization strategy. * @param cache where to store cached origin responses * @param config cache storage configuration options - note that * the setting for max object size will be ignored and * should be configured in the Ehcache instead. * @param serializer alternative serialization mechanism */ public EhcacheHttpCacheStorage( final Cache cache, final CacheConfig config, final HttpCacheEntrySerializer serializer) { super((config != null ? config : CacheConfig.DEFAULT).getMaxUpdateRetries(), serializer); this.cache = Args.notNull(cache, "Ehcache"); } @Override protected String digestToStorageKey(final String key) { return key; } @Override protected void store(final String storageKey, final T storageObject) throws ResourceIOException { cache.put(storageKey, storageObject); } @Override protected T restore(final String storageKey) throws ResourceIOException { return cache.get(storageKey); } @Override protected T getForUpdateCAS(final String storageKey) throws ResourceIOException { return cache.get(storageKey); } @Override protected T getStorageObject(final T element) throws ResourceIOException { return element; } @Override protected boolean updateCAS( final String storageKey, final T oldStorageObject, final T storageObject) throws ResourceIOException { return cache.replace(storageKey, oldStorageObject, storageObject); } @Override protected void delete(final String storageKey) throws ResourceIOException { cache.remove(storageKey); } @Override protected Map bulkRestore(final Collection storageKeys) throws ResourceIOException { final Map resultMap = new HashMap<>(); for (final String storageKey: storageKeys) { final T storageObject = cache.get(storageKey); if (storageObject != null) { resultMap.put(storageKey, storageObject); } } return resultMap; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheRevalidatorBase.java0100664 0000000 0000000 00000014351 14704162040 031337 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.Closeable; import java.io.IOException; import java.util.HashSet; import java.util.Set; import java.util.concurrent.Future; import java.util.concurrent.RejectedExecutionException; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.ScheduledFuture; import java.util.concurrent.ScheduledThreadPoolExecutor; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.schedule.ConcurrentCountMap; import org.apache.hc.client5.http.schedule.SchedulingStrategy; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Abstract cache re-validation class. */ class CacheRevalidatorBase implements Closeable { private final ReentrantLock lock; interface ScheduledExecutor { Future schedule(Runnable command, TimeValue timeValue) throws RejectedExecutionException; void shutdown(); void awaitTermination(final Timeout timeout) throws InterruptedException; } public static ScheduledExecutor wrap(final ScheduledExecutorService executorService) { return new ScheduledExecutor() { @Override public ScheduledFuture schedule(final Runnable command, final TimeValue timeValue) throws RejectedExecutionException { Args.notNull(command, "Runnable"); Args.notNull(timeValue, "Time value"); return executorService.schedule(command, timeValue.getDuration(), timeValue.getTimeUnit()); } @Override public void shutdown() { executorService.shutdown(); } @Override public void awaitTermination(final Timeout timeout) throws InterruptedException { Args.notNull(timeout, "Timeout"); executorService.awaitTermination(timeout.getDuration(), timeout.getTimeUnit()); } }; } private final ScheduledExecutor scheduledExecutor; private final SchedulingStrategy schedulingStrategy; private final Set pendingRequest; private final ConcurrentCountMap failureCache; private static final Logger LOG = LoggerFactory.getLogger(CacheRevalidatorBase.class); /** * Create CacheValidator which will make ache revalidation requests * using the supplied {@link SchedulingStrategy} and {@link ScheduledExecutor}. */ public CacheRevalidatorBase( final ScheduledExecutor scheduledExecutor, final SchedulingStrategy schedulingStrategy) { this.scheduledExecutor = scheduledExecutor; this.schedulingStrategy = schedulingStrategy; this.pendingRequest = new HashSet<>(); this.failureCache = new ConcurrentCountMap<>(); this.lock = new ReentrantLock(); } /** * Create CacheValidator which will make ache revalidation requests * using the supplied {@link SchedulingStrategy} and {@link ScheduledThreadPoolExecutor}. */ public CacheRevalidatorBase( final ScheduledThreadPoolExecutor scheduledThreadPoolExecutor, final SchedulingStrategy schedulingStrategy) { this(wrap(scheduledThreadPoolExecutor), schedulingStrategy); } /** * Schedules an asynchronous re-validation */ void scheduleRevalidation(final String cacheKey, final Runnable command) { lock.lock(); try { if (!pendingRequest.contains(cacheKey)) { final int consecutiveFailedAttempts = failureCache.getCount(cacheKey); final TimeValue executionTime = schedulingStrategy.schedule(consecutiveFailedAttempts); try { scheduledExecutor.schedule(command, executionTime); pendingRequest.add(cacheKey); } catch (final RejectedExecutionException ex) { LOG.debug("Revalidation of cache entry with key {} could not be scheduled", cacheKey, ex); } } } finally { lock.unlock(); } } @Override public void close() throws IOException { scheduledExecutor.shutdown(); } public void awaitTermination(final Timeout timeout) throws InterruptedException { Args.notNull(timeout, "Timeout"); scheduledExecutor.awaitTermination(timeout); } void jobSuccessful(final String identifier) { failureCache.resetCount(identifier); lock.lock(); try { pendingRequest.remove(identifier); } finally { lock.unlock(); } } void jobFailed(final String identifier) { failureCache.increaseCount(identifier); lock.lock(); try { pendingRequest.remove(identifier); } finally { lock.unlock(); } } Set getScheduledIdentifiers() { lock.lock(); try { return new HashSet<>(pendingRequest); } finally { lock.unlock(); } } } ././@LongLink0100644 0000000 0000000 00000000151 14704162040 011626 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttpAsyncClientBuilder.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttpAsyncClientBuilder.0100664 0000000 0000000 00000015733 14704162040 032347 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.File; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.ScheduledThreadPoolExecutor; import java.util.function.Function; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.cache.HttpAsyncCacheStorage; import org.apache.hc.client5.http.cache.HttpAsyncCacheStorageAdaptor; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.cache.HttpCacheEntryFactory; import org.apache.hc.client5.http.cache.HttpCacheStorage; import org.apache.hc.client5.http.cache.ResourceFactory; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder; import org.apache.hc.client5.http.impl.schedule.ImmediateSchedulingStrategy; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.schedule.SchedulingStrategy; import org.apache.hc.core5.http.config.NamedElementChain; import org.apache.hc.core5.http.protocol.HttpContext; /** * Builder for {@link org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient} * instances capable of client-side caching. * * @since 5.0 */ public class CachingHttpAsyncClientBuilder extends HttpAsyncClientBuilder { private ResourceFactory resourceFactory; private HttpAsyncCacheStorage storage; private File cacheDir; private SchedulingStrategy schedulingStrategy; private CacheConfig cacheConfig; private boolean deleteCache; public static CachingHttpAsyncClientBuilder create() { return new CachingHttpAsyncClientBuilder(); } protected CachingHttpAsyncClientBuilder() { super(); addResponseInterceptorFirst(ResponseCacheConformance.INSTANCE); addResponseInterceptorLast(ResponseViaCache.INSTANCE); addRequestInterceptorLast(RequestViaCache.INSTANCE); this.deleteCache = true; } public final CachingHttpAsyncClientBuilder setResourceFactory(final ResourceFactory resourceFactory) { this.resourceFactory = resourceFactory; return this; } public final CachingHttpAsyncClientBuilder setHttpCacheStorage(final HttpCacheStorage storage) { this.storage = storage != null ? new HttpAsyncCacheStorageAdaptor(storage) : null; return this; } public final CachingHttpAsyncClientBuilder setHttpCacheStorage(final HttpAsyncCacheStorage storage) { this.storage = storage; return this; } public final CachingHttpAsyncClientBuilder setCacheDir(final File cacheDir) { this.cacheDir = cacheDir; return this; } public final CachingHttpAsyncClientBuilder setSchedulingStrategy(final SchedulingStrategy schedulingStrategy) { this.schedulingStrategy = schedulingStrategy; return this; } public final CachingHttpAsyncClientBuilder setCacheConfig(final CacheConfig cacheConfig) { this.cacheConfig = cacheConfig; return this; } /** * @deprecated Do not use. */ @Deprecated public final CachingHttpAsyncClientBuilder setHttpCacheInvalidator(final org.apache.hc.client5.http.cache.HttpAsyncCacheInvalidator cacheInvalidator) { return this; } public CachingHttpAsyncClientBuilder setDeleteCache(final boolean deleteCache) { this.deleteCache = deleteCache; return this; } @Override protected void customizeExecChain(final NamedElementChain execChainDefinition) { final CacheConfig config = this.cacheConfig != null ? this.cacheConfig : CacheConfig.DEFAULT; // We copy the instance fields to avoid changing them, and rename to avoid accidental use of the wrong version ResourceFactory resourceFactoryCopy = this.resourceFactory; if (resourceFactoryCopy == null) { if (this.cacheDir == null) { resourceFactoryCopy = new HeapResourceFactory(); } else { resourceFactoryCopy = new FileResourceFactory(cacheDir); } } HttpAsyncCacheStorage storageCopy = this.storage; if (storageCopy == null) { if (this.cacheDir == null) { storageCopy = new HttpAsyncCacheStorageAdaptor(new BasicHttpCacheStorage(config)); } else { final ManagedHttpCacheStorage managedStorage = new ManagedHttpCacheStorage(config); if (this.deleteCache) { addCloseable(managedStorage::shutdown); } else { addCloseable(managedStorage); } storageCopy = new HttpAsyncCacheStorageAdaptor(managedStorage); } } final HttpAsyncCache httpCache = new BasicHttpAsyncCache( resourceFactoryCopy, HttpCacheEntryFactory.INSTANCE, storageCopy, CacheKeyGenerator.INSTANCE); DefaultAsyncCacheRevalidator cacheRevalidator = null; if (config.getAsynchronousWorkers() > 0) { final ScheduledExecutorService executorService = new ScheduledThreadPoolExecutor(config.getAsynchronousWorkers()); addCloseable(executorService::shutdownNow); cacheRevalidator = new DefaultAsyncCacheRevalidator( executorService, this.schedulingStrategy != null ? this.schedulingStrategy : ImmediateSchedulingStrategy.INSTANCE); } final AsyncCachingExec cachingExec = new AsyncCachingExec( httpCache, cacheRevalidator, config); execChainDefinition.addBefore(ChainElement.PROTOCOL.name(), cachingExec, ChainElement.CACHING.name()); } @Override protected Function contextAdaptor() { return HttpCacheContext::castOrCreate; } } ././@LongLink0100644 0000000 0000000 00000000160 14666635064 011650 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractSerializingAsyncCacheStorage.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractSerializingAsyncCacheS0100664 0000000 0000000 00000027622 14666635064 032464 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.concurrent.atomic.AtomicInteger; import org.apache.hc.client5.http.cache.HttpAsyncCacheStorage; import org.apache.hc.client5.http.cache.HttpCacheCASOperation; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer; import org.apache.hc.client5.http.cache.HttpCacheStorageEntry; import org.apache.hc.client5.http.cache.HttpCacheUpdateException; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.client5.http.impl.Operations; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexCancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.util.Args; /** * Abstract cache backend for serialized objects capable of CAS (compare-and-swap) updates. * * @since 5.0 */ public abstract class AbstractSerializingAsyncCacheStorage implements HttpAsyncCacheStorage { private final int maxUpdateRetries; private final HttpCacheEntrySerializer serializer; public AbstractSerializingAsyncCacheStorage(final int maxUpdateRetries, final HttpCacheEntrySerializer serializer) { this.maxUpdateRetries = Args.notNegative(maxUpdateRetries, "Max retries"); this.serializer = Args.notNull(serializer, "Cache entry serializer"); } protected abstract String digestToStorageKey(String key); protected abstract T getStorageObject(CAS cas) throws ResourceIOException; protected abstract Cancellable store(String storageKey, T storageObject, FutureCallback callback); protected abstract Cancellable restore(String storageKey, FutureCallback callback); protected abstract Cancellable getForUpdateCAS(String storageKey, FutureCallback callback); protected abstract Cancellable updateCAS(String storageKey, CAS cas, T storageObject, FutureCallback callback); protected abstract Cancellable delete(String storageKey, FutureCallback callback); protected abstract Cancellable bulkRestore(Collection storageKeys, FutureCallback> callback); @Override public final Cancellable putEntry( final String key, final HttpCacheEntry entry, final FutureCallback callback) { Args.notNull(key, "Storage key"); Args.notNull(callback, "Callback"); try { final String storageKey = digestToStorageKey(key); final T storageObject = serializer.serialize(new HttpCacheStorageEntry(key, entry)); return store(storageKey, storageObject, callback); } catch (final Exception ex) { callback.failed(ex); return Operations.nonCancellable(); } } @Override public final Cancellable getEntry(final String key, final FutureCallback callback) { Args.notNull(key, "Storage key"); Args.notNull(callback, "Callback"); try { final String storageKey = digestToStorageKey(key); return restore(storageKey, new FutureCallback() { @Override public void completed(final T storageObject) { try { if (storageObject != null) { final HttpCacheStorageEntry entry = serializer.deserialize(storageObject); if (key.equals(entry.getKey())) { callback.completed(entry.getContent()); } else { callback.completed(null); } } else { callback.completed(null); } } catch (final Exception ex) { callback.failed(ex); } } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } }); } catch (final Exception ex) { callback.failed(ex); return Operations.nonCancellable(); } } @Override public final Cancellable removeEntry(final String key, final FutureCallback callback) { Args.notNull(key, "Storage key"); Args.notNull(callback, "Callback"); try { final String storageKey = digestToStorageKey(key); return delete(storageKey, callback); } catch (final Exception ex) { callback.failed(ex); return Operations.nonCancellable(); } } @Override public final Cancellable updateEntry( final String key, final HttpCacheCASOperation casOperation, final FutureCallback callback) { Args.notNull(key, "Storage key"); Args.notNull(casOperation, "CAS operation"); Args.notNull(callback, "Callback"); final ComplexCancellable complexCancellable = new ComplexCancellable(); final AtomicInteger count = new AtomicInteger(0); attemptUpdateEntry(key, casOperation, complexCancellable, count, callback); return complexCancellable; } private void attemptUpdateEntry( final String key, final HttpCacheCASOperation casOperation, final ComplexCancellable complexCancellable, final AtomicInteger count, final FutureCallback callback) { try { final String storageKey = digestToStorageKey(key); complexCancellable.setDependency(getForUpdateCAS(storageKey, new FutureCallback() { @Override public void completed(final CAS cas) { try { HttpCacheStorageEntry storageEntry = cas != null ? serializer.deserialize(getStorageObject(cas)) : null; if (storageEntry != null && !key.equals(storageEntry.getKey())) { storageEntry = null; } final HttpCacheEntry existingEntry = storageEntry != null ? storageEntry.getContent() : null; final HttpCacheEntry updatedEntry = casOperation.execute(existingEntry); if (existingEntry == null) { putEntry(key, updatedEntry, callback); } else { final T storageObject = serializer.serialize(new HttpCacheStorageEntry(key, updatedEntry)); complexCancellable.setDependency(updateCAS(storageKey, cas, storageObject, new FutureCallback() { @Override public void completed(final Boolean result) { if (result.booleanValue()) { callback.completed(result); } else { if (!complexCancellable.isCancelled()) { final int numRetries = count.incrementAndGet(); if (numRetries >= maxUpdateRetries) { callback.failed(new HttpCacheUpdateException("Cache update failed after " + numRetries + " retries")); } else { attemptUpdateEntry(key, casOperation, complexCancellable, count, callback); } } } } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } })); } } catch (final Exception ex) { callback.failed(ex); } } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } })); } catch (final Exception ex) { callback.failed(ex); } } @Override public final Cancellable getEntries(final Collection keys, final FutureCallback> callback) { Args.notNull(keys, "Storage keys"); Args.notNull(callback, "Callback"); try { final List storageKeys = new ArrayList<>(keys.size()); for (final String key: keys) { storageKeys.add(digestToStorageKey(key)); } return bulkRestore(storageKeys, new FutureCallback>() { @Override public void completed(final Map storageObjectMap) { try { final Map resultMap = new HashMap<>(); for (final String key: keys) { final String storageKey = digestToStorageKey(key); final T storageObject = storageObjectMap.get(storageKey); if (storageObject != null) { final HttpCacheStorageEntry entry = serializer.deserialize(storageObject); if (key.equals(entry.getKey())) { resultMap.put(key, entry.getContent()); } } } callback.completed(resultMap); } catch (final Exception ex) { callback.failed(ex); } } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } }); } catch (final Exception ex) { callback.failed(ex); return Operations.nonCancellable(); } } } ././@LongLink0100644 0000000 0000000 00000000151 14704162040 011626 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ByteArrayCacheEntrySerializer.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ByteArrayCacheEntrySerializer.0100664 0000000 0000000 00000012643 14704162040 032406 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.io.ObjectStreamClass; import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.regex.Pattern; import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer; import org.apache.hc.client5.http.cache.HttpCacheStorageEntry; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * {@link HttpCacheEntrySerializer} implementation that uses the default (native) * serialization. * * @see java.io.Serializable * * @since 4.1 * @deprecated This class is deprecated and will be removed in a future release. Please use {@link HttpByteArrayCacheEntrySerializer} for improved performance. * @see HttpByteArrayCacheEntrySerializer */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public final class ByteArrayCacheEntrySerializer implements HttpCacheEntrySerializer { /** * Default instance of {@link ByteArrayCacheEntrySerializer}. */ public static final ByteArrayCacheEntrySerializer INSTANCE = new ByteArrayCacheEntrySerializer(); @Override public byte[] serialize(final HttpCacheStorageEntry cacheEntry) throws ResourceIOException { if (cacheEntry == null) { return null; } final ByteArrayOutputStream buf = new ByteArrayOutputStream(); try (final ObjectOutputStream oos = new ObjectOutputStream(buf)) { oos.writeObject(cacheEntry); } catch (final IOException ex) { throw new ResourceIOException(ex.getMessage(), ex); } return buf.toByteArray(); } @Override public HttpCacheStorageEntry deserialize(final byte[] serializedObject) throws ResourceIOException { if (serializedObject == null) { return null; } try (final ObjectInputStream ois = new RestrictedObjectInputStream(new ByteArrayInputStream(serializedObject))) { return (HttpCacheStorageEntry) ois.readObject(); } catch (final IOException | ClassNotFoundException ex) { throw new ResourceIOException(ex.getMessage(), ex); } } // visible for testing static class RestrictedObjectInputStream extends ObjectInputStream { private static final List ALLOWED_CLASS_PATTERNS = Collections.unmodifiableList(Arrays.asList( Pattern.compile("^(\\[L)?org\\.apache\\.hc\\.(.*)"), Pattern.compile("^(?:\\[+L)?java\\.util\\..*$"), Pattern.compile("^(?:\\[+L)?java\\.lang\\..*$"), Pattern.compile("^(?:\\[+L)?java\\.time\\..*$"), // java 8 time Pattern.compile("^\\[+Z$"), // boolean Pattern.compile("^\\[+B$"), // byte Pattern.compile("^\\[+C$"), // char Pattern.compile("^\\[+D$"), // double Pattern.compile("^\\[+F$"), // float Pattern.compile("^\\[+I$"), // int Pattern.compile("^\\[+J$"), // long Pattern.compile("^\\[+S$") // short )); private RestrictedObjectInputStream(final InputStream in) throws IOException { super(in); } @Override protected Class resolveClass(final ObjectStreamClass objectStreamClass) throws IOException, ClassNotFoundException { final String className = objectStreamClass.getName(); if (!isAllowedClassName(className)) { throw new ResourceIOException(String.format( "Class %s is not allowed for deserialization", objectStreamClass.getName())); } return super.resolveClass(objectStreamClass); } // visible for testing static boolean isAllowedClassName(final String className) { for (final Pattern allowedClassPattern : ALLOWED_CLASS_PATTERNS) { if (allowedClassPattern.matcher(className).matches()) { return true; } } return false; } } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheMatch.java0100664 0000000 0000000 00000003253 14704162040 027323 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; /** * Represents a full match or a partial match (variant options) * result of a cache lookup operation. */ class CacheMatch { final CacheHit hit; final CacheHit root; CacheMatch(final CacheHit hit, final CacheHit root) { this.hit = hit; this.root = root; } @Override public String toString() { return "CacheLookupResult{" + "hit=" + hit + ", root=" + root + '}'; } } ././@LongLink0100644 0000000 0000000 00000000146 14704162040 011632 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractBinaryCacheStorage.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractBinaryCacheStorage.jav0100664 0000000 0000000 00000003502 14704162040 032360 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer; /** * Abstract cache backend for serialized binary objects capable of CAS (compare-and-swap) updates. * * @since 5.0 */ public abstract class AbstractBinaryCacheStorage extends AbstractSerializingCacheStorage { public AbstractBinaryCacheStorage(final int maxUpdateRetries, final HttpCacheEntrySerializer serializer) { super(maxUpdateRetries, serializer); } public AbstractBinaryCacheStorage(final int maxUpdateRetries) { super(maxUpdateRetries, HttpByteArrayCacheEntrySerializer.INSTANCE); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/RequestViaCache.java0100664 0000000 0000000 00000004564 14704162040 030365 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.IOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.protocol.HttpContext; /** * This response interceptor adds {@literal VIA} header to all outgoing * request messages dispatched through the caching layer. */ @Contract(threading = ThreadingBehavior.IMMUTABLE) class RequestViaCache implements HttpRequestInterceptor { public static final RequestViaCache INSTANCE = new RequestViaCache(); @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { final ProtocolVersion protocolVersion = context.getProtocolVersion(); request.addHeader(HttpHeaders.VIA, ViaCacheGenerator.INSTANCE.lookup(protocolVersion)); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttpAsyncClients.java0100664 0000000 0000000 00000006357 14666635064 032111 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.File; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; /** * Factory methods for {@link CloseableHttpAsyncClient} instances * capable of client-side caching. * * @since 5.0 */ public final class CachingHttpAsyncClients { private CachingHttpAsyncClients() { super(); } /** * Creates builder object for construction of custom * {@link CloseableHttpAsyncClient} instances. */ public static CachingHttpAsyncClientBuilder custom() { return CachingHttpAsyncClientBuilder.create(); } /** * Creates {@link CloseableHttpAsyncClient} instance that uses a memory bound * response cache. */ public static CloseableHttpAsyncClient createMemoryBound() { return CachingHttpAsyncClientBuilder.create().build(); } /** * Creates {@link CloseableHttpAsyncClient} instance that uses a file system * bound response cache. * * @param cacheDir location of response cache. */ public static CloseableHttpAsyncClient createFileBound(final File cacheDir) { return CachingHttpAsyncClientBuilder.create().setCacheDir(cacheDir).build(); } /** * Creates builder object for construction of custom HTTP/2 * {@link CloseableHttpAsyncClient} instances. */ public static CachingH2AsyncClientBuilder customHttp2() { return CachingH2AsyncClientBuilder.create(); } /** * Creates HTTP/2 {@link CloseableHttpAsyncClient} instance that uses a memory bound * response cache. */ public static CloseableHttpAsyncClient createHttp2MemoryBound() { return CachingH2AsyncClientBuilder.create().build(); } /** * Creates HTTP/2 {@link CloseableHttpAsyncClient} instance that uses a file system * bound response cache. * * @param cacheDir location of response cache. */ public static CloseableHttpAsyncClient createHttp2FileBound(final File cacheDir) { return CachingH2AsyncClientBuilder.create().setCacheDir(cacheDir).build(); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/NoopCacheEntrySerializer.java0100664 0000000 0000000 00000004412 14704162040 032254 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer; import org.apache.hc.client5.http.cache.HttpCacheStorageEntry; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * {@link HttpCacheEntrySerializer} that uses {@link HttpCacheStorageEntry} * as its cache content representation. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class NoopCacheEntrySerializer implements HttpCacheEntrySerializer { /** * Default instance of {@link NoopCacheEntrySerializer}. */ public static final NoopCacheEntrySerializer INSTANCE = new NoopCacheEntrySerializer(); @Override public HttpCacheStorageEntry serialize(final HttpCacheStorageEntry cacheEntry) throws ResourceIOException { return cacheEntry; } @Override public HttpCacheStorageEntry deserialize(final HttpCacheStorageEntry cacheEntry) throws ResourceIOException { return cacheEntry; } } ././@LongLink0100644 0000000 0000000 00000000155 14704162040 011632 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/HttpByteArrayCacheEntrySerializer.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/HttpByteArrayCacheEntrySeriali0100664 0000000 0000000 00000037577 14704162040 032464 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; import java.time.Instant; import java.util.HashSet; import java.util.Iterator; import java.util.Set; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer; import org.apache.hc.client5.http.cache.HttpCacheStorageEntry; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.impl.io.AbstractMessageParser; import org.apache.hc.core5.http.impl.io.AbstractMessageWriter; import org.apache.hc.core5.http.impl.io.SessionInputBufferImpl; import org.apache.hc.core5.http.impl.io.SessionOutputBufferImpl; import org.apache.hc.core5.http.io.SessionOutputBuffer; import org.apache.hc.core5.http.message.BasicLineFormatter; import org.apache.hc.core5.http.message.BasicLineParser; import org.apache.hc.core5.http.message.HeaderGroup; import org.apache.hc.core5.http.message.LineFormatter; import org.apache.hc.core5.http.message.LineParser; import org.apache.hc.core5.http.message.RequestLine; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.util.CharArrayBuffer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * This class implements the {@link HttpCacheEntrySerializer} interface, which defines the contract for HTTP cache * entry serialization and deserialization. It also includes a default buffer size of 8192 bytes, which can be * overridden by specifying a different buffer size in the constructor. * * @since 5.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class HttpByteArrayCacheEntrySerializer implements HttpCacheEntrySerializer { private static final Logger LOG = LoggerFactory.getLogger(HttpByteArrayCacheEntrySerializer.class); /** * The default buffer size used for I/O operations, set to 8192 bytes. */ private static final int DEFAULT_BUFFER_SIZE = 8192; static final String HC_CACHE_VERSION = "1.0"; static final String HC_CACHE_VERSION_LINE = "HttpClient CacheEntry " + HC_CACHE_VERSION; static final String HC_CACHE_KEY = "HC-Key"; static final String HC_CACHE_LENGTH = "HC-Resource-Length"; static final String HC_REQUEST_INSTANT = "HC-Request-Instant"; static final String HC_RESPONSE_INSTANT = "HC-Response-Instant"; static final String HC_VARIANT = "HC-Variant"; /** * Default instance of {@link HttpByteArrayCacheEntrySerializer}. */ public static final HttpByteArrayCacheEntrySerializer INSTANCE = new HttpByteArrayCacheEntrySerializer(); private final LineParser lineParser; private final LineFormatter lineFormatter; private final int bufferSize; /** * Constructs a HttpByteArrayCacheEntrySerializer with the specified buffer size. * * @param bufferSize the buffer size to use for serialization and deserialization. */ public HttpByteArrayCacheEntrySerializer(final int bufferSize) { this.lineParser = BasicLineParser.INSTANCE; this.lineFormatter = BasicLineFormatter.INSTANCE; this.bufferSize = bufferSize > 0 ? bufferSize : DEFAULT_BUFFER_SIZE; } /** * Constructs a new instance of {@code HttpByteArrayCacheEntrySerializer} with a default buffer size. * * @see #DEFAULT_BUFFER_SIZE */ public HttpByteArrayCacheEntrySerializer() { this(DEFAULT_BUFFER_SIZE); } /** * Serializes an HttpCacheStorageEntry object into a byte array using an HTTP-like format. *

* The metadata is encoded into HTTP pseudo-headers for storage. * * @param storageEntry the HttpCacheStorageEntry to serialize. * @return the byte array containing the serialized HttpCacheStorageEntry. * @throws ResourceIOException if there is an error during serialization. */ @Override public byte[] serialize(final HttpCacheStorageEntry storageEntry) throws ResourceIOException { final String key = storageEntry.getKey(); final HttpCacheEntry cacheEntry = storageEntry.getContent(); final Resource resource = cacheEntry.getResource(); try (ByteArrayOutputStream out = new ByteArrayOutputStream((resource != null ? (int) resource.length() : 0) + DEFAULT_BUFFER_SIZE)) { final SessionOutputBuffer outputBuffer = new SessionOutputBufferImpl(bufferSize); final CharArrayBuffer line = new CharArrayBuffer(DEFAULT_BUFFER_SIZE); line.append(HC_CACHE_VERSION_LINE); outputBuffer.writeLine(line, out); line.clear(); line.append(HC_CACHE_KEY); line.append(": "); line.append(key); outputBuffer.writeLine(line, out); if (resource != null) { line.clear(); line.append(HC_CACHE_LENGTH); line.append(": "); line.append(asStr(resource.length())); outputBuffer.writeLine(line, out); } line.clear(); line.append(HC_REQUEST_INSTANT); line.append(": "); line.append(asStr(cacheEntry.getRequestInstant())); outputBuffer.writeLine(line, out); line.clear(); line.append(HC_RESPONSE_INSTANT); line.append(": "); line.append(asStr(cacheEntry.getResponseInstant())); outputBuffer.writeLine(line, out); for (final String variant : cacheEntry.getVariants()) { line.clear(); line.append(HC_VARIANT); line.append(": "); line.append(variant); outputBuffer.writeLine(line, out); } line.clear(); outputBuffer.writeLine(line, out); line.clear(); final RequestLine requestLine = new RequestLine(cacheEntry.getRequestMethod(), cacheEntry.getRequestURI(), HttpVersion.HTTP_1_1); lineFormatter.formatRequestLine(line, requestLine); outputBuffer.writeLine(line, out); for (final Iterator

it = cacheEntry.requestHeaderIterator(); it.hasNext(); ) { line.clear(); lineFormatter.formatHeader(line, it.next()); outputBuffer.writeLine(line, out); } line.clear(); outputBuffer.writeLine(line, out); line.clear(); final StatusLine statusLine = new StatusLine(HttpVersion.HTTP_1_1, cacheEntry.getStatus(), ""); lineFormatter.formatStatusLine(line, statusLine); outputBuffer.writeLine(line, out); for (final Iterator
it = cacheEntry.headerIterator(); it.hasNext(); ) { line.clear(); lineFormatter.formatHeader(line, it.next()); outputBuffer.writeLine(line, out); } line.clear(); outputBuffer.writeLine(line, out); outputBuffer.flush(out); if (resource != null) { out.write(resource.get()); } out.flush(); final byte[] bytes = out.toByteArray(); if (LOG.isDebugEnabled()) { LOG.debug("Serialized cache entry with key {} and {} bytes", key, bytes.length); } return bytes; } catch (final IOException ex) { throw new ResourceIOException("Exception while serializing cache entry", ex); } } /** * Deserializes a byte array representation of an HTTP cache storage entry into an instance of * {@link HttpCacheStorageEntry}. * * @param serializedObject the byte array representation of the HTTP cache storage entry * @return the deserialized HTTP cache storage entry * @throws ResourceIOException if an error occurs during deserialization */ @Override public HttpCacheStorageEntry deserialize(final byte[] serializedObject) throws ResourceIOException { if (serializedObject == null || serializedObject.length == 0) { throw new ResourceIOException("Serialized object is null or empty"); } try (final InputStream in = new ByteArrayInputStream(serializedObject)) { final SessionInputBufferImpl inputBuffer = new SessionInputBufferImpl(bufferSize); final CharArrayBuffer line = new CharArrayBuffer(DEFAULT_BUFFER_SIZE); checkReadResult(inputBuffer.readLine(line, in)); final String versionLine = line.toString(); if (!versionLine.equals(HC_CACHE_VERSION_LINE)) { throw new ResourceIOException("Unexpected cache entry version line"); } String storageKey = null; long length = -1; Instant requestDate = null; Instant responseDate = null; final Set variants = new HashSet<>(); while (true) { line.clear(); checkReadResult(inputBuffer.readLine(line, in)); if (line.isEmpty()) { break; } final Header header = lineParser.parseHeader(line); final String name = header.getName(); final String value = header.getValue(); if (name.equalsIgnoreCase(HC_CACHE_KEY)) { storageKey = value; } else if (name.equalsIgnoreCase(HC_CACHE_LENGTH)) { length = asLong(value); } else if (name.equalsIgnoreCase(HC_REQUEST_INSTANT)) { requestDate = asInstant(value); } else if (name.equalsIgnoreCase(HC_RESPONSE_INSTANT)) { responseDate = asInstant(value); } else if (name.equalsIgnoreCase(HC_VARIANT)) { variants.add(value); } else { throw new ResourceIOException("Unexpected header entry"); } } if (storageKey == null || requestDate == null || responseDate == null) { throw new ResourceIOException("Invalid cache header format"); } line.clear(); checkReadResult(inputBuffer.readLine(line, in)); final RequestLine requestLine = lineParser.parseRequestLine(line); final HeaderGroup requestHeaders = new HeaderGroup(); while (true) { line.clear(); checkReadResult(inputBuffer.readLine(line, in)); if (line.isEmpty()) { break; } requestHeaders.addHeader(lineParser.parseHeader(line)); } line.clear(); checkReadResult(inputBuffer.readLine(line, in)); final StatusLine statusLine = lineParser.parseStatusLine(line); final HeaderGroup responseHeaders = new HeaderGroup(); while (true) { line.clear(); checkReadResult(inputBuffer.readLine(line, in)); if (line.isEmpty()) { break; } responseHeaders.addHeader(lineParser.parseHeader(line)); } final Resource resource; if (length != -1) { int off = 0; int remaining = (int) length; final byte[] buf = new byte[remaining]; while (remaining > 0) { final int i = inputBuffer.read(buf, off, remaining, in); if (i > 0) { off += i; remaining -= i; } if (i == -1) { throw new ResourceIOException("Unexpected end of cache content"); } } resource = new HeapResource(buf); } else { resource = null; } if (inputBuffer.read(in) != -1) { throw new ResourceIOException("Unexpected content at the end of cache content"); } final HttpCacheEntry httpCacheEntry = new HttpCacheEntry( requestDate, responseDate, requestLine.getMethod(), requestLine.getUri(), requestHeaders, statusLine.getStatusCode(), responseHeaders, resource, !variants.isEmpty() ? variants : null ); if (LOG.isDebugEnabled()) { LOG.debug("Returning deserialized cache entry with storage key '{}'", httpCacheEntry); } return new HttpCacheStorageEntry(storageKey, httpCacheEntry); } catch (final ResourceIOException ex) { throw ex; } catch (final ParseException ex) { throw new ResourceIOException("Invalid cache header format", ex); } catch (final IOException ex) { throw new ResourceIOException("I/O error deserializing cache entry", ex); } } private static String asStr(final long value) { return Long.toString(value); } private static String asStr(final Instant instant) { return Long.toString(instant.toEpochMilli()); } private static long asLong(final String value) throws ResourceIOException { try { return Long.parseLong(value); } catch (final NumberFormatException ex) { throw new ResourceIOException("Invalid cache header format"); } } private static Instant asInstant(final String value) throws ResourceIOException { return Instant.ofEpochMilli(asLong(value)); } private static void checkReadResult(final int n) throws ResourceIOException { if (n == -1) { throw new ResourceIOException("Unexpected end of stream"); } } /** * @return null * @deprecated Do not use. */ @Deprecated protected InputStream makeByteArrayInputStream(final byte[] bytes) { return null; } /** * @return null * @deprecated Do not use. */ @Deprecated protected AbstractMessageParser makeHttpResponseParser() { return null; } /** * @return null * @deprecated Do not use. */ @Deprecated protected AbstractMessageWriter makeHttpResponseWriter(final SessionOutputBuffer outputBuffer) { return null; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheSupport.java0100664 0000000 0000000 00000005703 14704162040 027745 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.net.URI; import java.util.Objects; import org.apache.hc.client5.http.utils.URIUtils; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.MessageHeaders; import org.apache.hc.core5.util.TextUtils; import org.apache.hc.core5.util.TimeValue; /** * HTTP cache support utilities. * * @since 5.4 */ @Internal public final class CacheSupport { public static URI getLocationURI(final URI requestUri, final MessageHeaders response, final String headerName) { final Header h = response.getFirstHeader(headerName); if (h == null) { return null; } final URI locationUri = CacheKeyGenerator.normalize(h.getValue()); if (locationUri == null) { return requestUri; } if (locationUri.isAbsolute()) { return locationUri; } return URIUtils.resolve(requestUri, locationUri); } public static boolean isSameOrigin(final URI requestURI, final URI targetURI) { return targetURI.isAbsolute() && Objects.equals(requestURI.getAuthority(), targetURI.getAuthority()); } public static final TimeValue MAX_AGE = TimeValue.ofSeconds(Integer.MAX_VALUE + 1L); public static long deltaSeconds(final String s) { if (TextUtils.isEmpty(s)) { return -1; } try { long ageValue = Long.parseLong(s); if (ageValue < 0) { ageValue = -1; // Handle negative age values as invalid } else if (ageValue > Integer.MAX_VALUE) { ageValue = MAX_AGE.toSeconds(); } return ageValue; } catch (final NumberFormatException ignore) { } return 0; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/DefaultCacheRevalidator.java0100664 0000000 0000000 00000007451 14704162040 032054 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.IOException; import java.util.concurrent.ScheduledExecutorService; import org.apache.hc.client5.http.schedule.SchedulingStrategy; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpStatus; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Class used for asynchronous revalidations to be used when * the {@code stale-while-revalidate} directive is present */ class DefaultCacheRevalidator extends CacheRevalidatorBase { private static final Logger LOG = LoggerFactory.getLogger(DefaultCacheRevalidator.class); interface RevalidationCall { ClassicHttpResponse execute() throws IOException, HttpException; } /** * Create DefaultCacheRevalidator which will make ache revalidation requests * using the supplied {@link SchedulingStrategy} and {@link ScheduledExecutor}. */ public DefaultCacheRevalidator( final CacheRevalidatorBase.ScheduledExecutor scheduledExecutor, final SchedulingStrategy schedulingStrategy) { super(scheduledExecutor, schedulingStrategy); } /** * Create CacheValidator which will make ache revalidation requests * using the supplied {@link SchedulingStrategy} and {@link ScheduledExecutorService}. */ public DefaultCacheRevalidator( final ScheduledExecutorService scheduledThreadPoolExecutor, final SchedulingStrategy schedulingStrategy) { this(wrap(scheduledThreadPoolExecutor), schedulingStrategy); } /** * Schedules an asynchronous re-validation */ public void revalidateCacheEntry( final String cacheKey, final RevalidationCall call) { scheduleRevalidation(cacheKey, () -> { try (ClassicHttpResponse httpResponse = call.execute()) { if (httpResponse.getCode() < HttpStatus.SC_SERVER_ERROR) { jobSuccessful(cacheKey); } else { jobFailed(cacheKey); } } catch (final IOException ex) { jobFailed(cacheKey); LOG.debug("Asynchronous revalidation failed due to I/O error", ex); } catch (final HttpException ex) { jobFailed(cacheKey); LOG.error("HTTP protocol exception during asynchronous revalidation", ex); } catch (final RuntimeException ex) { jobFailed(cacheKey); LOG.error("Unexpected runtime exception thrown during asynchronous revalidation", ex); } }); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/HttpCache.java0100664 0000000 0000000 00000006252 14704162040 027210 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.time.Instant; import java.util.List; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.util.ByteArrayBuffer; interface HttpCache { /** * Returns a result with either a fully matching {@link HttpCacheEntry} * a partial match with a list of known variants or null if no match could be found. */ CacheMatch match(HttpHost host, HttpRequest request); /** * Retrieves variant {@link HttpCacheEntry}s for the given hit. */ List getVariants(CacheHit hit); /** * Stores {@link HttpRequest} / {@link HttpResponse} exchange details in the cache. */ CacheHit store( HttpHost host, HttpRequest request, HttpResponse originResponse, ByteArrayBuffer content, Instant requestSent, Instant responseReceived); /** * Updates {@link HttpCacheEntry} using details from a 304 {@link HttpResponse} and * updates the root entry if the given cache entry represents a variant. */ CacheHit update( CacheHit stale, HttpHost host, HttpRequest request, HttpResponse originResponse, Instant requestSent, Instant responseReceived); /** * Stores {@link HttpRequest} / {@link HttpResponse} exchange details in the cache * from the negotiated {@link HttpCacheEntry}. */ CacheHit storeFromNegotiated( CacheHit negotiated, HttpHost host, HttpRequest request, HttpResponse originResponse, Instant requestSent, Instant responseReceived); /** * Evicts {@link HttpCacheEntry}s invalidated by the given message exchange. */ void evictInvalidatedEntries(HttpHost host, HttpRequest request, HttpResponse response); } ././@LongLink0100644 0000000 0000000 00000000147 14704162040 011633 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingH2AsyncClientBuilder.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingH2AsyncClientBuilder.ja0100664 0000000 0000000 00000015146 14704162040 032212 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.File; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.ScheduledThreadPoolExecutor; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.cache.HttpAsyncCacheStorage; import org.apache.hc.client5.http.cache.HttpAsyncCacheStorageAdaptor; import org.apache.hc.client5.http.cache.HttpCacheEntryFactory; import org.apache.hc.client5.http.cache.HttpCacheStorage; import org.apache.hc.client5.http.cache.ResourceFactory; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.async.H2AsyncClientBuilder; import org.apache.hc.client5.http.impl.schedule.ImmediateSchedulingStrategy; import org.apache.hc.client5.http.schedule.SchedulingStrategy; import org.apache.hc.core5.http.config.NamedElementChain; /** * Builder for HTTP/2 {@link org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient} * instances capable of client-side caching. * * @since 5.0 */ public class CachingH2AsyncClientBuilder extends H2AsyncClientBuilder { private ResourceFactory resourceFactory; private HttpAsyncCacheStorage storage; private File cacheDir; private SchedulingStrategy schedulingStrategy; private CacheConfig cacheConfig; private boolean deleteCache; public static CachingH2AsyncClientBuilder create() { return new CachingH2AsyncClientBuilder(); } protected CachingH2AsyncClientBuilder() { super(); addResponseInterceptorFirst(ResponseCacheConformance.INSTANCE); addResponseInterceptorLast(ResponseViaCache.INSTANCE); addRequestInterceptorLast(RequestViaCache.INSTANCE); this.deleteCache = true; } public final CachingH2AsyncClientBuilder setResourceFactory(final ResourceFactory resourceFactory) { this.resourceFactory = resourceFactory; return this; } public final CachingH2AsyncClientBuilder setHttpCacheStorage(final HttpCacheStorage storage) { this.storage = storage != null ? new HttpAsyncCacheStorageAdaptor(storage) : null; return this; } public final CachingH2AsyncClientBuilder setHttpCacheStorage(final HttpAsyncCacheStorage storage) { this.storage = storage; return this; } public final CachingH2AsyncClientBuilder setCacheDir(final File cacheDir) { this.cacheDir = cacheDir; return this; } public final CachingH2AsyncClientBuilder setSchedulingStrategy(final SchedulingStrategy schedulingStrategy) { this.schedulingStrategy = schedulingStrategy; return this; } public final CachingH2AsyncClientBuilder setCacheConfig(final CacheConfig cacheConfig) { this.cacheConfig = cacheConfig; return this; } /** * @deprecated Do not use. */ @Deprecated public final CachingH2AsyncClientBuilder setHttpCacheInvalidator(final org.apache.hc.client5.http.cache.HttpAsyncCacheInvalidator cacheInvalidator) { return this; } public CachingH2AsyncClientBuilder setDeleteCache(final boolean deleteCache) { this.deleteCache = deleteCache; return this; } @Override protected void customizeExecChain(final NamedElementChain execChainDefinition) { final CacheConfig config = this.cacheConfig != null ? this.cacheConfig : CacheConfig.DEFAULT; // We copy the instance fields to avoid changing them, and rename to avoid accidental use of the wrong version ResourceFactory resourceFactoryCopy = this.resourceFactory; if (resourceFactoryCopy == null) { if (this.cacheDir == null) { resourceFactoryCopy = new HeapResourceFactory(); } else { resourceFactoryCopy = new FileResourceFactory(cacheDir); } } HttpAsyncCacheStorage storageCopy = this.storage; if (storageCopy == null) { if (this.cacheDir == null) { storageCopy = new HttpAsyncCacheStorageAdaptor(new BasicHttpCacheStorage(config)); } else { final ManagedHttpCacheStorage managedStorage = new ManagedHttpCacheStorage(config); if (this.deleteCache) { addCloseable(managedStorage::shutdown); } else { addCloseable(managedStorage); } storageCopy = new HttpAsyncCacheStorageAdaptor(managedStorage); } } final HttpAsyncCache httpCache = new BasicHttpAsyncCache( resourceFactoryCopy, HttpCacheEntryFactory.INSTANCE, storageCopy, CacheKeyGenerator.INSTANCE); DefaultAsyncCacheRevalidator cacheRevalidator = null; if (config.getAsynchronousWorkers() > 0) { final ScheduledExecutorService executorService = new ScheduledThreadPoolExecutor(config.getAsynchronousWorkers()); addCloseable(executorService::shutdownNow); cacheRevalidator = new DefaultAsyncCacheRevalidator( executorService, this.schedulingStrategy != null ? this.schedulingStrategy : ImmediateSchedulingStrategy.INSTANCE); } final AsyncCachingExec cachingExec = new AsyncCachingExec( httpCache, cacheRevalidator, config); execChainDefinition.addBefore(ChainElement.PROTOCOL.name(), cachingExec, ChainElement.CACHING.name()); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingHttpClientBuilder.java0100664 0000000 0000000 00000014714 14704162040 032211 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.File; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.ScheduledThreadPoolExecutor; import java.util.function.Function; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.cache.HttpCacheEntryFactory; import org.apache.hc.client5.http.cache.HttpCacheStorage; import org.apache.hc.client5.http.cache.ResourceFactory; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; import org.apache.hc.client5.http.impl.schedule.ImmediateSchedulingStrategy; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.schedule.SchedulingStrategy; import org.apache.hc.core5.http.config.NamedElementChain; import org.apache.hc.core5.http.protocol.HttpContext; /** * Builder for {@link org.apache.hc.client5.http.impl.classic.CloseableHttpClient} * instances capable of client-side caching. * * @since 4.3 */ public class CachingHttpClientBuilder extends HttpClientBuilder { private ResourceFactory resourceFactory; private HttpCacheStorage storage; private File cacheDir; private SchedulingStrategy schedulingStrategy; private CacheConfig cacheConfig; private boolean deleteCache; public static CachingHttpClientBuilder create() { return new CachingHttpClientBuilder(); } protected CachingHttpClientBuilder() { super(); addResponseInterceptorFirst(ResponseCacheConformance.INSTANCE); addResponseInterceptorLast(ResponseViaCache.INSTANCE); addRequestInterceptorLast(RequestViaCache.INSTANCE); this.deleteCache = true; } public final CachingHttpClientBuilder setResourceFactory( final ResourceFactory resourceFactory) { this.resourceFactory = resourceFactory; return this; } public final CachingHttpClientBuilder setHttpCacheStorage(final HttpCacheStorage storage) { this.storage = storage; return this; } public final CachingHttpClientBuilder setCacheDir(final File cacheDir) { this.cacheDir = cacheDir; return this; } public final CachingHttpClientBuilder setSchedulingStrategy(final SchedulingStrategy schedulingStrategy) { this.schedulingStrategy = schedulingStrategy; return this; } public final CachingHttpClientBuilder setCacheConfig(final CacheConfig cacheConfig) { this.cacheConfig = cacheConfig; return this; } /** * @deprecated Do not use. */ @Deprecated public final CachingHttpClientBuilder setHttpCacheInvalidator(final org.apache.hc.client5.http.cache.HttpCacheInvalidator cacheInvalidator) { return this; } public final CachingHttpClientBuilder setDeleteCache(final boolean deleteCache) { this.deleteCache = deleteCache; return this; } @Override protected void customizeExecChain(final NamedElementChain execChainDefinition) { final CacheConfig config = this.cacheConfig != null ? this.cacheConfig : CacheConfig.DEFAULT; // We copy the instance fields to avoid changing them, and rename to avoid accidental use of the wrong version ResourceFactory resourceFactoryCopy = this.resourceFactory; if (resourceFactoryCopy == null) { if (this.cacheDir == null) { resourceFactoryCopy = new HeapResourceFactory(); } else { resourceFactoryCopy = new FileResourceFactory(cacheDir); } } HttpCacheStorage storageCopy = this.storage; if (storageCopy == null) { if (this.cacheDir == null) { storageCopy = new BasicHttpCacheStorage(config); } else { final ManagedHttpCacheStorage managedStorage = new ManagedHttpCacheStorage(config); if (this.deleteCache) { addCloseable(managedStorage::shutdown); } else { addCloseable(managedStorage); } storageCopy = managedStorage; } } final HttpCache httpCache = new BasicHttpCache( resourceFactoryCopy, HttpCacheEntryFactory.INSTANCE, storageCopy, CacheKeyGenerator.INSTANCE); DefaultCacheRevalidator cacheRevalidator = null; if (config.getAsynchronousWorkers() > 0) { final ScheduledExecutorService executorService = new ScheduledThreadPoolExecutor(config.getAsynchronousWorkers()); addCloseable(executorService::shutdownNow); cacheRevalidator = new DefaultCacheRevalidator( executorService, this.schedulingStrategy != null ? this.schedulingStrategy : ImmediateSchedulingStrategy.INSTANCE); } final CachingExec cachingExec = new CachingExec( httpCache, cacheRevalidator, config); execChainDefinition.addBefore(ChainElement.PROTOCOL.name(), cachingExec, ChainElement.CACHING.name()); } @Override protected Function contextAdaptor() { return HttpCacheContext::castOrCreate; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/FileResourceFactory.java0100664 0000000 0000000 00000011017 14704162040 031257 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.client5.http.cache.ResourceFactory; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.net.PercentCodec; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; /** * Generates {@link Resource} instances whose body is stored in a temporary file. * * @since 4.1 */ @Contract(threading = ThreadingBehavior.STATELESS) public class FileResourceFactory implements ResourceFactory { private final File cacheDir; public FileResourceFactory(final File cacheDir) { super(); this.cacheDir = cacheDir; } static String generateUniqueCacheFileName(final String requestId, final String eTag, final byte[] content, final int off, final int len) { final StringBuilder buf = new StringBuilder(); if (eTag != null) { PercentCodec.RFC3986.encode(buf, eTag); buf.append('@'); } else if (content != null) { final MessageDigest sha256; try { sha256 = MessageDigest.getInstance("SHA-256"); } catch (final NoSuchAlgorithmException ex) { throw new IllegalStateException(ex); } sha256.update(content, off, len); buf.append(TextUtils.toHexString(sha256.digest())); buf.append('@'); } PercentCodec.RFC3986.encode(buf, requestId); return buf.toString(); } /** * @since 5.4 */ @Override public Resource generate( final String requestId, final String eTag, final byte[] content, final int off, final int len) throws ResourceIOException { Args.notNull(requestId, "Request id"); final String filename = generateUniqueCacheFileName(requestId, eTag, content, off, len); final File file = new File(cacheDir, filename); try (FileOutputStream outStream = new FileOutputStream(file, false)) { if (content != null) { outStream.write(content, off, len); } } catch (final IOException ex) { throw new ResourceIOException(ex.getMessage(), ex); } return new FileResource(file); } @Override public Resource generate(final String requestId, final byte[] content, final int off, final int len) throws ResourceIOException { if (content != null) { return generate(requestId, null, content, off, len); } return generate(requestId, null, null, 0, 0); } @Override public Resource generate(final String requestId, final byte[] content) throws ResourceIOException { if (content != null) { return generate(requestId, null, content, 0, content.length); } return generate(requestId, null, null, 0, 0); } /** * @deprecated Do not use. */ @Deprecated @Override public Resource copy( final String requestId, final Resource resource) throws ResourceIOException { return resource; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheHit.java0100664 0000000 0000000 00000004006 14704162040 027010 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.apache.hc.client5.http.cache.HttpCacheEntry; class CacheHit { final String rootKey; final String variantKey; final HttpCacheEntry entry; public CacheHit(final String rootKey, final String variantKey, final HttpCacheEntry entry) { this.rootKey = rootKey; this.variantKey = variantKey; this.entry = entry; } public CacheHit(final String rootKey, final HttpCacheEntry entry) { this(rootKey, null, entry); } public String getEntryKey() { return variantKey != null ? variantKey : rootKey; } @Override public String toString() { return "CacheHit{" + "rootKey='" + rootKey + '\'' + ", variantKey='" + variantKey + '\'' + ", entry=" + entry + '}'; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ResourceReference.java0100664 0000000 0000000 00000004021 14666635064 030765 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.lang.ref.PhantomReference; import java.lang.ref.ReferenceQueue; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.core5.util.Args; class ResourceReference extends PhantomReference { private final Resource resource; public ResourceReference(final HttpCacheEntry entry, final ReferenceQueue q) { super(entry, q); Args.notNull(entry.getResource(), "Resource"); this.resource = entry.getResource(); } public Resource getResource() { return this.resource; } @Override public int hashCode() { return this.resource.hashCode(); } @Override public boolean equals(final Object obj) { return this.resource.equals(obj); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ManagedHttpCacheStorage.java0100664 0000000 0000000 00000020406 15005672016 032013 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.Closeable; import java.lang.ref.ReferenceQueue; import java.util.Collection; import java.util.HashMap; import java.util.HashSet; import java.util.Map; import java.util.Set; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.cache.HttpCacheCASOperation; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheStorage; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** *

* {@link HttpCacheStorage} implementation capable of deallocating resources associated with * the cache entries. *

* This cache keeps track of cache entries using * {@link java.lang.ref.PhantomReference} and maintains a collection of all resources that * are no longer in use. The cache, however, does not automatically deallocates associated * resources by invoking {@link Resource#dispose()} method. The consumer MUST periodically * call {@link #cleanResources()} method to trigger resource deallocation. The cache can be * permanently shut down using {@link #shutdown()} method. All resources associated with * the entries used by the cache will be deallocated. *

*

* This {@link HttpCacheStorage} implementation is intended for use with {@link FileResource} * and similar. *

*

* Compatibility note. Prior to version 4.4 this storage implementation used to dispose of * all resource entries upon {@link #close()}. As of version 4.4 the {@link #close()} method * disposes only of those resources that have been explicitly removed from the cache with * {@link #removeEntry(String)} method. *

*

* The {@link #shutdown()} ()} method can still be used to shut down the storage and dispose of * all resources currently managed by it. *

* * @since 4.1 */ @Contract(threading = ThreadingBehavior.SAFE) public class ManagedHttpCacheStorage implements HttpCacheStorage, Closeable { private final InternalCacheStorage entries; private final ReferenceQueue morque; private final Set resources; private final AtomicBoolean active; private final ReentrantLock lock; public ManagedHttpCacheStorage(final CacheConfig config) { super(); this.entries = new InternalCacheStorage(config.getMaxCacheEntries(), null); this.morque = new ReferenceQueue<>(); this.resources = new HashSet<>(); this.active = new AtomicBoolean(true); this.lock = new ReentrantLock(); } private void ensureValidState() { if (!isActive()) { throw new IllegalStateException("Cache has been shut down"); } } private void keepResourceReference(final HttpCacheEntry entry) { final Resource resource = entry.getResource(); if (resource != null) { // Must deallocate the resource when the entry is no longer in used final ResourceReference ref = new ResourceReference(entry, this.morque); this.resources.add(ref); } } @Override public void putEntry(final String url, final HttpCacheEntry entry) throws ResourceIOException { Args.notNull(url, "URL"); Args.notNull(entry, "Cache entry"); ensureValidState(); lock.lock(); try { this.entries.put(url, entry); keepResourceReference(entry); } finally { lock.unlock(); } } @Override public HttpCacheEntry getEntry(final String url) throws ResourceIOException { Args.notNull(url, "URL"); ensureValidState(); lock.lock(); try { return this.entries.get(url); } finally { lock.unlock(); } } @Override public void removeEntry(final String url) throws ResourceIOException { Args.notNull(url, "URL"); ensureValidState(); lock.lock(); try { // Cannot deallocate the associated resources immediately as the // cache entry may still be in use this.entries.remove(url); } finally { lock.unlock(); } } @Override public void updateEntry( final String url, final HttpCacheCASOperation casOperation) throws ResourceIOException { Args.notNull(url, "URL"); Args.notNull(casOperation, "CAS operation"); ensureValidState(); lock.lock(); try { final HttpCacheEntry existing = this.entries.get(url); final HttpCacheEntry updated = casOperation.execute(existing); this.entries.put(url, updated); if (existing != updated) { keepResourceReference(updated); } } finally { lock.unlock(); } } @Override public Map getEntries(final Collection keys) throws ResourceIOException { Args.notNull(keys, "Key"); final Map resultMap = new HashMap<>(keys.size()); for (final String key: keys) { final HttpCacheEntry entry = getEntry(key); if (entry != null) { resultMap.put(key, entry); } } return resultMap; } public void cleanResources() { if (isActive()) { ResourceReference ref; while ((ref = (ResourceReference) this.morque.poll()) != null) { lock.lock(); try { this.resources.remove(ref); } finally { lock.unlock(); } ref.getResource().dispose(); } } } public void shutdown() { if (compareAndSet()) { lock.lock(); try { this.entries.clear(); for (final ResourceReference ref: this.resources) { ref.getResource().dispose(); } this.resources.clear(); while (this.morque.poll() != null) { } } finally { lock.unlock(); } } } @Override public void close() { if (compareAndSet()) { lock.lock(); try { ResourceReference ref; while ((ref = (ResourceReference) this.morque.poll()) != null) { this.resources.remove(ref); ref.getResource().dispose(); } } finally { lock.unlock(); } } } /** * Check if the cache is still active and has not shut down. * * @return {@code true} if the cache is active, otherwise return {@code false}. * @since 5.2 */ public boolean isActive() { return active.get(); } private boolean compareAndSet() { return this.active.compareAndSet(true, false); } } ././@LongLink0100644 0000000 0000000 00000000147 14704162040 011633 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachedHttpResponseGenerator.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachedHttpResponseGenerator.ja0100664 0000000 0000000 00000015607 14704162040 032417 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.time.Instant; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.util.TimeValue; /** * Rebuilds an {@link HttpResponse} from a {@link HttpCacheEntry} */ class CachedHttpResponseGenerator { private final CacheValidityPolicy validityStrategy; CachedHttpResponseGenerator(final CacheValidityPolicy validityStrategy) { super(); this.validityStrategy = validityStrategy; } /** * If it is legal to use cached content in response response to the {@link HttpRequest} then * generate an {@link HttpResponse} based on {@link HttpCacheEntry}. * @param request {@link HttpRequest} to generate the response for * @param entry {@link HttpCacheEntry} to transform into an {@link HttpResponse} * @return {@link SimpleHttpResponse} constructed response */ SimpleHttpResponse generateResponse(final HttpRequest request, final HttpCacheEntry entry) throws ResourceIOException { final Instant now = Instant.now(); final SimpleHttpResponse response = new SimpleHttpResponse(entry.getStatus()); response.setHeaders(entry.getHeaders()); if (responseShouldContainEntity(request, entry)) { final Resource resource = entry.getResource(); final Header h = entry.getFirstHeader(HttpHeaders.CONTENT_TYPE); final ContentType contentType = h != null ? ContentType.parse(h.getValue()) : null; final byte[] content = resource.get(); generateContentLength(response, content); response.setBody(content, contentType); } final TimeValue age = this.validityStrategy.getCurrentAge(entry, now); if (TimeValue.isPositive(age)) { if (age.compareTo(CacheSupport.MAX_AGE) >= 0) { response.setHeader(HttpHeaders.AGE, Long.toString(CacheSupport.MAX_AGE.toSeconds())); } else { response.setHeader(HttpHeaders.AGE, Long.toString(age.toSeconds())); } } return response; } /** * Generate a 304 - Not Modified response from the {@link HttpCacheEntry}. This should be * used to respond to conditional requests, when the entry exists or has been re-validated. */ SimpleHttpResponse generateNotModifiedResponse(final HttpCacheEntry entry) { final SimpleHttpResponse response = new SimpleHttpResponse(HttpStatus.SC_NOT_MODIFIED, "Not Modified"); // The response MUST include the following headers // - Date Header dateHeader = entry.getFirstHeader(HttpHeaders.DATE); if (dateHeader == null) { dateHeader = new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(Instant.now())); } response.addHeader(dateHeader); // - ETag and/or Content-Location, if the header would have been sent // in a 200 response to the same request final ETag eTag = entry.getETag(); if (eTag != null) { response.addHeader(new BasicHeader(HttpHeaders.ETAG, eTag.toString())); } final Header contentLocationHeader = entry.getFirstHeader(HttpHeaders.CONTENT_LOCATION); if (contentLocationHeader != null) { response.addHeader(contentLocationHeader); } // - Expires, Cache-Control, and/or Vary, if the field-value might // differ from that sent in any previous response for the same // variant final Header expiresHeader = entry.getFirstHeader(HttpHeaders.EXPIRES); if (expiresHeader != null) { response.addHeader(expiresHeader); } final Header cacheControlHeader = entry.getFirstHeader(HttpHeaders.CACHE_CONTROL); if (cacheControlHeader != null) { response.addHeader(cacheControlHeader); } final Header varyHeader = entry.getFirstHeader(HttpHeaders.VARY); if (varyHeader != null) { response.addHeader(varyHeader); } //Since the goal of a 304 response is to minimize information transfer //when the recipient already has one or more cached representations, a //sender SHOULD NOT generate representation metadata other than the //above listed fields unless said metadata exists for the purpose of //guiding cache updates (e.g., Last-Modified might be useful if the //response does not have an ETag field). if (eTag == null) { final Header lastModifiedHeader = entry.getFirstHeader(HttpHeaders.LAST_MODIFIED); if (lastModifiedHeader != null) { response.addHeader(lastModifiedHeader); } } return response; } private void generateContentLength(final HttpResponse response, final byte[] body) { response.removeHeaders(HttpHeaders.TRANSFER_ENCODING); response.setHeader(HttpHeaders.CONTENT_LENGTH, Integer.toString(body.length)); } private boolean responseShouldContainEntity(final HttpRequest request, final HttpCacheEntry cacheEntry) { return Method.GET.isSame(request.getMethod()) && cacheEntry.getResource() != null; } } ././@LongLink0100644 0000000 0000000 00000000145 14704162040 011631 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ConditionalRequestBuilder.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/ConditionalRequestBuilder.java0100664 0000000 0000000 00000012674 14704162040 032475 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.Collection; import org.apache.hc.client5.http.cache.HeaderConstants; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.core5.function.Factory; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.message.BufferedHeader; import org.apache.hc.core5.util.CharArrayBuffer; class ConditionalRequestBuilder { private final Factory messageCopier; ConditionalRequestBuilder(final Factory messageCopier) { this.messageCopier = messageCopier; } /** * When a {@link HttpCacheEntry} is stale but 'might' be used as a response * to an {@link org.apache.hc.core5.http.HttpRequest} we will attempt to revalidate * the entry with the origin. Build the origin {@link org.apache.hc.core5.http.HttpRequest} * here and return it. * * @param cacheControl the cache control directives. * @param request the original request from the caller * @param cacheEntry the entry that needs to be re-validated * @return the wrapped request */ public T buildConditionalRequest(final ResponseCacheControl cacheControl, final T request, final HttpCacheEntry cacheEntry) { final T newRequest = messageCopier.create(request); final ETag eTag = cacheEntry.getETag(); if (eTag != null) { newRequest.setHeader(HttpHeaders.IF_NONE_MATCH, eTag.toString()); } final Header lastModified = cacheEntry.getFirstHeader(HttpHeaders.LAST_MODIFIED); if (lastModified != null) { newRequest.setHeader(HttpHeaders.IF_MODIFIED_SINCE, lastModified.getValue()); } if (cacheControl.isMustRevalidate() || cacheControl.isProxyRevalidate()) { newRequest.addHeader(HttpHeaders.CACHE_CONTROL, HeaderConstants.CACHE_CONTROL_MAX_AGE + "=0"); } return newRequest; } /** * When a {@link HttpCacheEntry} does not exist for a specific * {@link org.apache.hc.core5.http.HttpRequest} we attempt to see if an existing * {@link HttpCacheEntry} is appropriate by building a conditional * {@link org.apache.hc.core5.http.HttpRequest} using the variants' ETag values. * If no such values exist, the request is unmodified * * @param request the original request from the caller * @param variants * @return the wrapped request */ public T buildConditionalRequestFromVariants(final T request, final Collection variants) { final T newRequest = messageCopier.create(request); final CharArrayBuffer buffer = new CharArrayBuffer(256); buffer.append(HttpHeaders.IF_NONE_MATCH); buffer.append(": "); int i = 0; for (final ETag variant : variants) { if (i > 0) { buffer.append(", "); } variant.format(buffer); i++; } newRequest.setHeader(BufferedHeader.create(buffer)); return newRequest; } /** * Returns a request to unconditionally validate a cache entry with * the origin. In certain cases (due to multiple intervening caches) * our cache may actually receive a response to a normal conditional * validation where the Date header is actually older than that of * our current cache entry. In this case, the protocol recommendation * is to retry the validation and force syncup with the origin. * @param request client request we are trying to satisfy * @return an unconditional validation request */ public T buildUnconditionalRequest(final T request) { final T newRequest = messageCopier.create(request); newRequest.addHeader(HttpHeaders.CACHE_CONTROL,HeaderConstants.CACHE_CONTROL_NO_CACHE); newRequest.removeHeaders(HttpHeaders.IF_RANGE); newRequest.removeHeaders(HttpHeaders.IF_MATCH); newRequest.removeHeaders(HttpHeaders.IF_NONE_MATCH); newRequest.removeHeaders(HttpHeaders.IF_UNMODIFIED_SINCE); newRequest.removeHeaders(HttpHeaders.IF_MODIFIED_SINCE); return newRequest; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/FileResource.java0100664 0000000 0000000 00000007377 14704162040 027745 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.IOException; import java.io.InputStream; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.ByteArrayBuffer; /** * Cache resource backed by a file. * * @since 4.1 */ @Contract(threading = ThreadingBehavior.SAFE) public class FileResource extends Resource { private static final long serialVersionUID = 4132244415919043397L; private final AtomicReference fileRef; private final long len; public FileResource(final File file) { super(); Args.notNull(file, "File"); this.fileRef = new AtomicReference<>(file); this.len = file.length(); } File getFile() { return this.fileRef.get(); } @Override public byte[] get() throws ResourceIOException { final File file = this.fileRef.get(); if (file == null) { throw new ResourceIOException("Resource already disposed"); } try (final InputStream in = new FileInputStream(file)) { final ByteArrayBuffer buf = new ByteArrayBuffer(1024); final byte[] tmp = new byte[2048]; int len; while ((len = in.read(tmp)) != -1) { buf.append(tmp, 0, len); } return buf.toByteArray(); } catch (final IOException ex) { throw new ResourceIOException(ex.getMessage(), ex); } } @Override public InputStream getInputStream() throws ResourceIOException { final File file = this.fileRef.get(); if (file != null) { try { return new FileInputStream(file); } catch (final FileNotFoundException ex) { throw new ResourceIOException(ex.getMessage(), ex); } } throw new ResourceIOException("Resource already disposed"); } @Override public long length() { return len; } @Override public void dispose() { final File file = this.fileRef.getAndSet(null); if (file != null) { file.delete(); } } @Override public String toString() { return "[" + "file=" + getFile() + "," + "len=" + length() + ']'; } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/InternalCacheStorage.java0100664 0000000 0000000 00000006273 14704162040 031375 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.LinkedHashMap; import java.util.LinkedList; import java.util.Map; import java.util.Queue; import java.util.function.Consumer; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheStorageEntry; import org.apache.hc.core5.annotation.Internal; @Internal final public class InternalCacheStorage { private final Map map; private final Queue evictionQueue; private final Consumer evictionCallback; public InternalCacheStorage(final int maxEntries, final Consumer evictionCallback) { this.evictionCallback = evictionCallback; this.map = new LinkedHashMap(20, 0.75f, true) { @Override protected boolean removeEldestEntry(final Map.Entry eldest) { if (size() > maxEntries) { if (evictionCallback != null) { evictionQueue.add(new HttpCacheStorageEntry(eldest.getKey(), eldest.getValue())); } return true; } return false; } }; this.evictionQueue = new LinkedList<>(); } public InternalCacheStorage(final int maxEntries) { this(maxEntries, null); } public InternalCacheStorage() { this(Integer.MAX_VALUE, null); } public void put(final String key, final HttpCacheEntry entry) { map.put(key, entry); HttpCacheStorageEntry evicted; while ((evicted = evictionQueue.poll()) != null) { if (evictionCallback != null) { evictionCallback.accept(evicted); } } } public HttpCacheEntry get(final String key) { return map.get(key); } public HttpCacheEntry remove(final String key) { return map.remove(key); } public void clear() { map.clear(); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/0040775 0000000 0000000 00000000000 14704162040 026406 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/package-info.java0100664 0000000 0000000 00000002474 14666635064 031623 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Memcached based caching backend * implementation. */ package org.apache.hc.client5.http.impl.cache.memcached; ././@LongLink0100644 0000000 0000000 00000000162 14666635064 011652 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedKeyHashingException.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedKeyHashingE0100664 0000000 0000000 00000003145 14666635064 032301 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache.memcached; /** * Signals a problem encountered when trying to map a * logical "storage key" to a "cache key" suitable for use with * memcached. * * @since 4.1 */ public class MemcachedKeyHashingException extends RuntimeException { private static final long serialVersionUID = -7553380015989141114L; public MemcachedKeyHashingException(final Throwable cause) { super(cause); } } ././@LongLink0100644 0000000 0000000 00000000154 14666635064 011653 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/PrefixKeyHashingScheme.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/PrefixKeyHashingSche0100664 0000000 0000000 00000004465 14666635064 032374 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache.memcached; /** * This is a {@link KeyHashingScheme} decorator that simply adds * a known prefix to the results of another {@code KeyHashingScheme}. * Primarily useful for namespacing a shared memcached cluster, for * example. * * @since 4.1 */ public final class PrefixKeyHashingScheme implements KeyHashingScheme { private final String prefix; private final KeyHashingScheme backingScheme; /** * Creates a new {@link KeyHashingScheme} that prepends the given * prefix to the results of hashes from the given backing scheme. * Users should be aware that memcached has a fixed maximum key * length, so the combination of this prefix plus the results of * the backing hashing scheme must still fit within these limits. * @param prefix * @param backingScheme */ public PrefixKeyHashingScheme(final String prefix, final KeyHashingScheme backingScheme) { this.prefix = prefix; this.backingScheme = backingScheme; } @Override public String hash(final String storageKey) { return prefix + backingScheme.hash(storageKey); } } ././@LongLink0100644 0000000 0000000 00000000154 14704162040 011631 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/SHA256KeyHashingScheme.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/SHA256KeyHashingSche0100664 0000000 0000000 00000004756 14704162040 031770 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache.memcached; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import org.apache.hc.client5.http.utils.Hex; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * This is a {@link KeyHashingScheme} based on the * SHA-256 * algorithm. The hashes produced are hex-encoded SHA-256 * digests and hence are always 64-character hexadecimal * strings. * * @since 4.1 */ public final class SHA256KeyHashingScheme implements KeyHashingScheme { /** * Default instance of {@link SHA256KeyHashingScheme}. */ public static final SHA256KeyHashingScheme INSTANCE = new SHA256KeyHashingScheme(); private static final Logger LOG = LoggerFactory.getLogger(SHA256KeyHashingScheme.class); @Override public String hash(final String key) { final MessageDigest md = getDigest(); md.update(key.getBytes()); return Hex.encodeHexString(md.digest()); } private MessageDigest getDigest() { try { return MessageDigest.getInstance("SHA-256"); } catch (final NoSuchAlgorithmException nsae) { LOG.error("can't find SHA-256 implementation for cache key hashing"); throw new MemcachedKeyHashingException(nsae); } } } ././@LongLink0100644 0000000 0000000 00000000175 14704162040 011634 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedOperationCancellationException.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedOperationCa0100664 0000000 0000000 00000003176 14704162040 032330 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache.memcached; import org.apache.hc.client5.http.cache.ResourceIOException; /** * Signals memcached operation cancellation. * * @since 5.4 */ public class MemcachedOperationCancellationException extends ResourceIOException { private static final long serialVersionUID = 1L; public MemcachedOperationCancellationException(final Throwable cause) { super(cause != null ? cause.getMessage() : null, cause); } } ././@LongLink0100644 0000000 0000000 00000000170 14666635064 011651 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedOperationTimeoutException.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedOperationTi0100664 0000000 0000000 00000003157 14666635064 032402 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache.memcached; import org.apache.hc.client5.http.cache.ResourceIOException; /** * Signals memcached operation timeout. * * @since 4.1 */ public class MemcachedOperationTimeoutException extends ResourceIOException { private static final long serialVersionUID = 1L; public MemcachedOperationTimeoutException(final Throwable cause) { super(cause != null ? cause.getMessage() : null, cause); } } ././@LongLink0100644 0000000 0000000 00000000157 14704162040 011634 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedHttpCacheStorage.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedHttpCacheSt0100664 0000000 0000000 00000024613 14704162040 032275 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache.memcached; import java.io.IOException; import java.net.InetSocketAddress; import java.util.Collection; import java.util.HashMap; import java.util.Map; import java.util.concurrent.CancellationException; import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.client5.http.impl.cache.AbstractBinaryCacheStorage; import org.apache.hc.client5.http.impl.cache.CacheConfig; import org.apache.hc.client5.http.impl.cache.HttpByteArrayCacheEntrySerializer; import org.apache.hc.core5.util.Args; import net.spy.memcached.CASResponse; import net.spy.memcached.CASValue; import net.spy.memcached.MemcachedClient; import net.spy.memcached.MemcachedClientIF; import net.spy.memcached.OperationTimeoutException; /** *

* This class is a storage backend that uses an external memcached * for storing cached origin responses. This storage option provides a * couple of interesting advantages over the default in-memory storage * backend: *

*
    *
  1. in-memory cached objects can survive an application restart since * they are held in a separate process
    2. *
  2. it becomes possible for several cooperating applications to share * a large memcached farm together
    3. *
*

* Note that in a shared memcached pool setting you may wish to make use * of the Ketama consistent hashing algorithm to reduce the number of * cache misses that might result if one of the memcached cluster members * fails (see the * KetamaConnectionFactory). *

*

* Because memcached places limits on the size of its keys, we need to * introduce a key hashing scheme to map the annotated URLs the higher-level * caching HTTP client wants to use as keys onto ones that are suitable * for use with memcached. Please see {@link KeyHashingScheme} if you would * like to use something other than the provided {@link SHA256KeyHashingScheme}. *

* *

* Please refer to the * memcached documentation and in particular to the documentation for * the spymemcached * documentation for details about how to set up and configure memcached * and the Java client used here, respectively. *

* * @since 4.1 */ public class MemcachedHttpCacheStorage extends AbstractBinaryCacheStorage> { private final MemcachedClientIF client; private final KeyHashingScheme keyHashingScheme; /** * Create a storage backend talking to a memcached instance * listening on the specified host and port. This is useful if you * just have a single local memcached instance running on the same * machine as your application, for example. * @param address where the memcached daemon is running * @throws IOException in case of an error */ public MemcachedHttpCacheStorage(final InetSocketAddress address) throws IOException { this(new MemcachedClient(address)); } /** * Create a storage backend using the pre-configured given * memcached client. * @param cache client to use for communicating with memcached */ public MemcachedHttpCacheStorage(final MemcachedClient cache) { this(cache, CacheConfig.DEFAULT, HttpByteArrayCacheEntrySerializer.INSTANCE, SHA256KeyHashingScheme.INSTANCE); } /** * Create a storage backend using the pre-configured given * memcached client. * * @param cache client to use for communicating with memcached * * @since 5.2 */ public MemcachedHttpCacheStorage(final MemcachedClientIF cache) { this(cache, CacheConfig.DEFAULT, HttpByteArrayCacheEntrySerializer.INSTANCE, SHA256KeyHashingScheme.INSTANCE); } /** * Create a storage backend using the given memcached client and * applying the given cache configuration, serialization, and hashing * mechanisms. * @param client how to talk to memcached * @param config apply HTTP cache-related options * @param serializer alternative serialization mechanism * @param keyHashingScheme how to map higher-level logical "storage keys" * onto "cache keys" suitable for use with memcached */ public MemcachedHttpCacheStorage( final MemcachedClient client, final CacheConfig config, final HttpCacheEntrySerializer serializer, final KeyHashingScheme keyHashingScheme) { this((MemcachedClientIF) client, config, serializer, keyHashingScheme); } /** * Create a storage backend using the given memcached client and * applying the given cache configuration, serialization, and hashing * mechanisms. * * @param client how to talk to memcached * @param config apply HTTP cache-related options * @param serializer alternative serialization mechanism * @param keyHashingScheme how to map higher-level logical "storage keys" * onto "cache keys" suitable for use with memcached * @since 5.2 */ public MemcachedHttpCacheStorage( final MemcachedClientIF client, final CacheConfig config, final HttpCacheEntrySerializer serializer, final KeyHashingScheme keyHashingScheme) { super((config != null ? config : CacheConfig.DEFAULT).getMaxUpdateRetries(), serializer != null ? serializer : HttpByteArrayCacheEntrySerializer.INSTANCE); this.client = Args.notNull(client, "Memcached client"); this.keyHashingScheme = keyHashingScheme; } @Override protected String digestToStorageKey(final String key) { return keyHashingScheme.hash(key); } @Override protected void store(final String storageKey, final byte[] storageObject) throws ResourceIOException { try { client.set(storageKey, 0, storageObject); } catch (final CancellationException ex) { throw new MemcachedOperationCancellationException(ex); } } private byte[] castAsByteArray(final Object storageObject) throws ResourceIOException { if (storageObject == null) { return null; } if (storageObject instanceof byte[]) { return (byte[]) storageObject; } throw new ResourceIOException("Unexpected cache content: " + storageObject.getClass()); } @Override protected byte[] restore(final String storageKey) throws ResourceIOException { try { return castAsByteArray(client.get(storageKey)); } catch (final CancellationException ex) { throw new MemcachedOperationCancellationException(ex); } catch (final OperationTimeoutException ex) { throw new MemcachedOperationTimeoutException(ex); } } @Override protected CASValue getForUpdateCAS(final String storageKey) throws ResourceIOException { try { return client.gets(storageKey); } catch (final CancellationException ex) { throw new MemcachedOperationCancellationException(ex); } catch (final OperationTimeoutException ex) { throw new MemcachedOperationTimeoutException(ex); } } @Override protected byte[] getStorageObject(final CASValue casValue) throws ResourceIOException { return castAsByteArray(casValue.getValue()); } @Override protected boolean updateCAS( final String storageKey, final CASValue casValue, final byte[] storageObject) throws ResourceIOException { try { final CASResponse casResult = client.cas(storageKey, casValue.getCas(), storageObject); return casResult == CASResponse.OK; } catch (final CancellationException ex) { throw new MemcachedOperationCancellationException(ex); } catch (final OperationTimeoutException ex) { throw new MemcachedOperationTimeoutException(ex); } } @Override protected void delete(final String storageKey) throws ResourceIOException { try { client.delete(storageKey); } catch (final CancellationException ex) { throw new MemcachedOperationCancellationException(ex); } } @Override protected Map bulkRestore(final Collection storageKeys) throws ResourceIOException { try { final Map storageObjectMap = client.getBulk(storageKeys); final Map resultMap = new HashMap<>(storageObjectMap.size()); for (final Map.Entry resultEntry: storageObjectMap.entrySet()) { resultMap.put(resultEntry.getKey(), castAsByteArray(resultEntry.getValue())); } return resultMap; } catch (final CancellationException ex) { throw new MemcachedOperationCancellationException(ex); } catch (final OperationTimeoutException ex) { throw new MemcachedOperationTimeoutException(ex); } } } ././@LongLink0100644 0000000 0000000 00000000164 14704162040 011632 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedHttpAsyncCacheStorage.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/MemcachedHttpAsyncCa0100664 0000000 0000000 00000024514 14704162040 032304 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache.memcached; import java.io.IOException; import java.net.InetSocketAddress; import java.util.Collection; import java.util.HashMap; import java.util.Map; import java.util.concurrent.CancellationException; import java.util.concurrent.ExecutionException; import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.client5.http.impl.Operations; import org.apache.hc.client5.http.impl.cache.AbstractBinaryAsyncCacheStorage; import org.apache.hc.client5.http.impl.cache.CacheConfig; import org.apache.hc.client5.http.impl.cache.HttpByteArrayCacheEntrySerializer; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.util.Args; import net.spy.memcached.CASResponse; import net.spy.memcached.CASValue; import net.spy.memcached.MemcachedClient; import net.spy.memcached.internal.BulkFuture; import net.spy.memcached.internal.GetFuture; import net.spy.memcached.internal.OperationFuture; /** *

* This class is a storage backend that uses an external memcached * for storing cached origin responses. This storage option provides a * couple of interesting advantages over the default in-memory storage * backend: *

*
    *
  1. in-memory cached objects can survive an application restart since * they are held in a separate process
    2. *
  2. it becomes possible for several cooperating applications to share * a large memcached farm together
    3. *
*

* Note that in a shared memcached pool setting you may wish to make use * of the Ketama consistent hashing algorithm to reduce the number of * cache misses that might result if one of the memcached cluster members * fails (see the * KetamaConnectionFactory). *

*

* Because memcached places limits on the size of its keys, we need to * introduce a key hashing scheme to map the annotated URLs the higher-level * caching HTTP client wants to use as keys onto ones that are suitable * for use with memcached. Please see {@link KeyHashingScheme} if you would * like to use something other than the provided {@link SHA256KeyHashingScheme}. *

* *

* Please refer to the * memcached documentation and in particular to the documentation for * the spymemcached * documentation for details about how to set up and configure memcached * and the Java client used here, respectively. *

* * @since 5.0 */ public class MemcachedHttpAsyncCacheStorage extends AbstractBinaryAsyncCacheStorage> { private final MemcachedClient client; private final KeyHashingScheme keyHashingScheme; /** * Create a storage backend talking to a memcached instance * listening on the specified host and port. This is useful if you * just have a single local memcached instance running on the same * machine as your application, for example. * @param address where the memcached daemon is running * @throws IOException in case of an error */ public MemcachedHttpAsyncCacheStorage(final InetSocketAddress address) throws IOException { this(new MemcachedClient(address)); } /** * Create a storage backend using the pre-configured given * memcached client. * @param cache client to use for communicating with memcached */ public MemcachedHttpAsyncCacheStorage(final MemcachedClient cache) { this(cache, CacheConfig.DEFAULT, HttpByteArrayCacheEntrySerializer.INSTANCE, SHA256KeyHashingScheme.INSTANCE); } /** * Create a storage backend using the given memcached client and * applying the given cache configuration, serialization, and hashing * mechanisms. * @param client how to talk to memcached * @param config apply HTTP cache-related options * @param serializer alternative serialization mechanism * @param keyHashingScheme how to map higher-level logical "storage keys" * onto "cache keys" suitable for use with memcached */ public MemcachedHttpAsyncCacheStorage( final MemcachedClient client, final CacheConfig config, final HttpCacheEntrySerializer serializer, final KeyHashingScheme keyHashingScheme) { super((config != null ? config : CacheConfig.DEFAULT).getMaxUpdateRetries(), serializer != null ? serializer : HttpByteArrayCacheEntrySerializer.INSTANCE); this.client = Args.notNull(client, "Memcached client"); this.keyHashingScheme = keyHashingScheme; } @Override protected String digestToStorageKey(final String key) { return keyHashingScheme.hash(key); } private byte[] castAsByteArray(final Object storageObject) throws ResourceIOException { if (storageObject == null) { return null; } if (storageObject instanceof byte[]) { return (byte[]) storageObject; } throw new ResourceIOException("Unexpected cache content: " + storageObject.getClass()); } @Override protected byte[] getStorageObject(final CASValue casValue) throws ResourceIOException { return castAsByteArray(casValue.getValue()); } private Cancellable operation(final OperationFuture operationFuture, final FutureCallback callback) { operationFuture.addListener(future -> { try { callback.completed(operationFuture.get()); } catch (final ExecutionException ex) { if (ex.getCause() instanceof Exception) { if (ex.getCause() instanceof CancellationException) { callback.failed(new MemcachedOperationCancellationException(ex.getCause())); } else { callback.failed((Exception) ex.getCause()); } } else { callback.failed(ex); } } }); return Operations.cancellable(operationFuture); } @Override protected Cancellable store(final String storageKey, final byte[] storageObject, final FutureCallback callback) { return operation(client.set(storageKey, 0, storageObject), callback); } @Override protected Cancellable restore(final String storageKey, final FutureCallback callback) { final GetFuture getFuture = client.asyncGet(storageKey); getFuture.addListener(future -> { try { callback.completed(castAsByteArray(getFuture.get())); } catch (final ExecutionException ex) { if (ex.getCause() instanceof Exception) { if (ex.getCause() instanceof CancellationException) { callback.failed(new MemcachedOperationCancellationException(ex.getCause())); } else { callback.failed((Exception) ex.getCause()); } } else { callback.failed(ex); } } }); return Operations.cancellable(getFuture); } @Override protected Cancellable getForUpdateCAS(final String storageKey, final FutureCallback> callback) { return operation(client.asyncGets(storageKey), callback); } @Override protected Cancellable updateCAS( final String storageKey, final CASValue casValue, final byte[] storageObject, final FutureCallback callback) { return operation(client.asyncCAS(storageKey, casValue.getCas(), storageObject), new FutureCallback() { @Override public void completed(final CASResponse result) { callback.completed(result == CASResponse.OK); } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } }); } @Override protected Cancellable delete(final String storageKey, final FutureCallback callback) { return operation(client.delete(storageKey), callback); } @Override protected Cancellable bulkRestore(final Collection storageKeys, final FutureCallback> callback) { final BulkFuture> future = client.asyncGetBulk(storageKeys); future.addListener(future1 -> { final Map storageObjectMap = future1.get(); final Map resultMap = new HashMap<>(storageObjectMap.size()); for (final Map.Entry resultEntry: storageObjectMap.entrySet()) { resultMap.put(resultEntry.getKey(), castAsByteArray(resultEntry.getValue())); } callback.completed(resultMap); }); return Operations.cancellable(future); } } ././@LongLink0100644 0000000 0000000 00000000146 14666635064 011654 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/KeyHashingScheme.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/memcached/KeyHashingScheme.jav0100664 0000000 0000000 00000006365 14666635064 032320 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */package org.apache.hc.client5.http.impl.cache.memcached; /** * Since the {@link org.apache.hc.client5.http.cache.HttpCacheStorage} interface * expects to use variant-annotated URLs for its storage keys, but Memcached * has a maximum key size, we need to support mapping storage keys to cache * keys. Clients can implement this interface to change the way the mapping * is done (for example, to add a prefix to all cache keys to provide a form * of memcached namespacing). * * @since 4.1 */ public interface KeyHashingScheme { /** Maps a storage key to a cache key. The storage key is what * the higher-level HTTP cache uses as a key; the cache key is what * we use as a key for talking to memcached. * @param storageKey what the higher-level HTTP cache wants to use * as its key for looking up cache entries * @return a cache key suitable for use with memcached */ String hash(String storageKey); } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/HttpCacheSupport.java0100664 0000000 0000000 00000005064 14704162040 030605 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.net.URI; import java.net.URISyntaxException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; /** * HTTP cache support utilities. * * @since 5.0 * * @deprecated Do not use. This functionality is internal. */ @Deprecated public final class HttpCacheSupport { public static String getRequestUri(final HttpRequest request, final HttpHost target) { return CacheKeyGenerator.getRequestUri(target, request); } public static URI normalize(final URI requestUri) throws URISyntaxException { return CacheKeyGenerator.normalize(requestUri); } /** * Lenient URI parser that normalizes valid {@link URI}s and returns {@code null} for malformed URIs. * @deprecated Use {@link #normalizeQuietly(String)} */ @Deprecated public static URI normalizeQuetly(final String requestUri) { if (requestUri == null) { return null; } try { return normalize(new URI(requestUri)); } catch (final URISyntaxException ex) { return null; } } /** * Lenient URI parser that normalizes valid {@link URI}s and returns {@code null} for malformed URIs. * @since 5.2 */ public static URI normalizeQuietly(final String requestUri) { return CacheKeyGenerator.normalize(requestUri); } } ././@LongLink0100644 0000000 0000000 00000000153 14704162040 011630 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractBinaryAsyncCacheStorage.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/AbstractBinaryAsyncCacheStorag0100664 0000000 0000000 00000003526 14704162040 032440 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer; /** * Abstract cache backend for serialized binary objects capable of CAS (compare-and-swap) updates. * * @since 5.0 */ public abstract class AbstractBinaryAsyncCacheStorage extends AbstractSerializingAsyncCacheStorage { public AbstractBinaryAsyncCacheStorage(final int maxUpdateRetries, final HttpCacheEntrySerializer serializer) { super(maxUpdateRetries, serializer); } public AbstractBinaryAsyncCacheStorage(final int maxUpdateRetries) { super(maxUpdateRetries, HttpByteArrayCacheEntrySerializer.INSTANCE); } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CachingExec.java0100664 0000000 0000000 00000075353 15005672016 027522 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.IOException; import java.io.InputStream; import java.time.Instant; import java.util.HashMap; import java.util.Iterator; import java.util.List; import java.util.Map; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.methods.SimpleBody; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.cache.CacheResponseStatus; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheStorage; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.ByteArrayBuffer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** *

* Request executor in the request execution chain that is responsible for * transparent client-side caching. *

*

* The current implementation is conditionally * compliant with HTTP/1.1 (meaning all the MUST and MUST NOTs are obeyed), * although quite a lot, though not all, of the SHOULDs and SHOULD NOTs * are obeyed too. *

*

* Folks that would like to experiment with alternative storage backends * should look at the {@link HttpCacheStorage} interface and the related * package documentation there. You may also be interested in the provided * {@link org.apache.hc.client5.http.impl.cache.ehcache.EhcacheHttpCacheStorage * EhCache} and {@link * org.apache.hc.client5.http.impl.cache.memcached.MemcachedHttpCacheStorage * memcached} storage backends. *

*

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

* * @since 4.3 */ class CachingExec extends CachingExecBase implements ExecChainHandler { private final HttpCache responseCache; private final DefaultCacheRevalidator cacheRevalidator; private final ConditionalRequestBuilder conditionalRequestBuilder; private static final Logger LOG = LoggerFactory.getLogger(CachingExec.class); CachingExec(final HttpCache cache, final DefaultCacheRevalidator cacheRevalidator, final CacheConfig config) { super(config); this.responseCache = Args.notNull(cache, "Response cache"); this.cacheRevalidator = cacheRevalidator; this.conditionalRequestBuilder = new ConditionalRequestBuilder<>(classicHttpRequest -> ClassicRequestBuilder.copy(classicHttpRequest).build()); } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final HttpRoute route = scope.route; final HttpClientContext context = scope.clientContext; final URIAuthority authority = request.getAuthority(); final String scheme = request.getScheme(); final HttpHost target = authority != null ? new HttpHost(scheme, authority) : route.getTargetHost(); final ClassicHttpResponse response = doExecute(target, request, scope, chain); context.setRequest(request); context.setResponse(response); return response; } ClassicHttpResponse doExecute( final HttpHost target, final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { final String exchangeId = scope.exchangeId; final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); if (LOG.isDebugEnabled()) { LOG.debug("{} request via cache: {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_MISS); context.setCacheEntry(null); if (clientRequestsOurOptions(request)) { context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); return new BasicClassicHttpResponse(HttpStatus.SC_NOT_IMPLEMENTED); } final RequestCacheControl requestCacheControl; if (request.containsHeader(HttpHeaders.CACHE_CONTROL)) { requestCacheControl = CacheControlHeaderParser.INSTANCE.parse(request); } else { requestCacheControl = context.getRequestCacheControlOrDefault(); CacheControlHeaderGenerator.INSTANCE.generate(requestCacheControl, request); } if (LOG.isDebugEnabled()) { LOG.debug("Request cache control: {}", requestCacheControl); } if (!cacheableRequestPolicy.canBeServedFromCache(requestCacheControl, request)) { if (LOG.isDebugEnabled()) { LOG.debug("{} request cannot be served from cache", exchangeId); } return callBackend(target, request, scope, chain); } final CacheMatch result = responseCache.match(target, request); final CacheHit hit = result != null ? result.hit : null; final CacheHit root = result != null ? result.root : null; if (hit == null) { return handleCacheMiss(requestCacheControl, root, target, request, scope, chain); } final ResponseCacheControl responseCacheControl = CacheControlHeaderParser.INSTANCE.parse(hit.entry); context.setResponseCacheControl(responseCacheControl); if (LOG.isDebugEnabled()) { LOG.debug("{} response cache control: {}", exchangeId, responseCacheControl); } return handleCacheHit(requestCacheControl, responseCacheControl, hit, target, request, scope, chain); } private static ClassicHttpResponse convert(final SimpleHttpResponse cacheResponse) { if (cacheResponse == null) { return null; } final ClassicHttpResponse response = new BasicClassicHttpResponse(cacheResponse.getCode(), cacheResponse.getReasonPhrase()); for (final Iterator
it = cacheResponse.headerIterator(); it.hasNext(); ) { response.addHeader(it.next()); } response.setVersion(cacheResponse.getVersion() != null ? cacheResponse.getVersion() : HttpVersion.DEFAULT); final SimpleBody body = cacheResponse.getBody(); if (body != null) { final ContentType contentType = body.getContentType(); final Header h = response.getFirstHeader(HttpHeaders.CONTENT_ENCODING); final String contentEncoding = h != null ? h.getValue() : null; if (body.isText()) { response.setEntity(new StringEntity(body.getBodyText(), contentType, contentEncoding, false)); } else { response.setEntity(new ByteArrayEntity(body.getBodyBytes(), contentType, contentEncoding, false)); } } return response; } ClassicHttpResponse callBackend( final HttpHost target, final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { final String exchangeId = scope.exchangeId; final Instant requestDate = getCurrentDate(); if (LOG.isDebugEnabled()) { LOG.debug("{} calling the backend", exchangeId); } final ClassicHttpResponse backendResponse = chain.proceed(request, scope); try { return handleBackendResponse(target, request, scope, requestDate, getCurrentDate(), backendResponse); } catch (final IOException | RuntimeException ex) { backendResponse.close(); throw ex; } } private ClassicHttpResponse handleCacheHit( final RequestCacheControl requestCacheControl, final ResponseCacheControl responseCacheControl, final CacheHit hit, final HttpHost target, final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { final String exchangeId = scope.exchangeId; final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); if (LOG.isDebugEnabled()) { LOG.debug("{} cache hit: {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_HIT); cacheHits.getAndIncrement(); final Instant now = getCurrentDate(); final CacheSuitability cacheSuitability = suitabilityChecker.assessSuitability(requestCacheControl, responseCacheControl, request, hit.entry, now); if (LOG.isDebugEnabled()) { LOG.debug("{} cache suitability: {}", exchangeId, cacheSuitability); } if (cacheSuitability == CacheSuitability.FRESH || cacheSuitability == CacheSuitability.FRESH_ENOUGH) { if (LOG.isDebugEnabled()) { LOG.debug("{} cache hit is fresh enough", exchangeId); } try { final SimpleHttpResponse cacheResponse = generateCachedResponse(request, hit.entry, now); context.setCacheEntry(hit.entry); return convert(cacheResponse); } catch (final ResourceIOException ex) { if (requestCacheControl.isOnlyIfCached()) { if (LOG.isDebugEnabled()) { LOG.debug("{} request marked only-if-cached", exchangeId); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); return convert(generateGatewayTimeout()); } context.setCacheResponseStatus(CacheResponseStatus.FAILURE); return chain.proceed(request, scope); } } if (requestCacheControl.isOnlyIfCached()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cache entry not is not fresh and only-if-cached requested", exchangeId); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); return convert(generateGatewayTimeout()); } else if (cacheSuitability == CacheSuitability.MISMATCH) { if (LOG.isDebugEnabled()) { LOG.debug("{} cache entry does not match the request; calling backend", exchangeId); } return callBackend(target, request, scope, chain); } else if (request.getEntity() != null && !request.getEntity().isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} request is not repeatable; calling backend", exchangeId); } return callBackend(target, request, scope, chain); } else if (hit.entry.getStatus() == HttpStatus.SC_NOT_MODIFIED && !suitabilityChecker.isConditional(request)) { if (LOG.isDebugEnabled()) { LOG.debug("{} non-modified cache entry does not match the non-conditional request; calling backend", exchangeId); } return callBackend(target, request, scope, chain); } else if (cacheSuitability == CacheSuitability.REVALIDATION_REQUIRED) { if (LOG.isDebugEnabled()) { LOG.debug("{} revalidation required; revalidating cache entry", exchangeId); } return revalidateCacheEntryWithoutFallback(responseCacheControl, hit, target, request, scope, chain); } else if (cacheSuitability == CacheSuitability.STALE_WHILE_REVALIDATED) { if (cacheRevalidator != null) { if (LOG.isDebugEnabled()) { LOG.debug("{} serving stale with asynchronous revalidation", exchangeId); } final String revalidationExchangeId = ExecSupport.getNextExchangeId(); context.setExchangeId(revalidationExchangeId); final ExecChain.Scope fork = new ExecChain.Scope( revalidationExchangeId, scope.route, scope.originalRequest, scope.execRuntime.fork(null), HttpCacheContext.create()); if (LOG.isDebugEnabled()) { LOG.debug("{} starting asynchronous revalidation exchange {}", exchangeId, revalidationExchangeId); } cacheRevalidator.revalidateCacheEntry( hit.getEntryKey(), () -> revalidateCacheEntry(responseCacheControl, hit, target, request, fork, chain)); context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); final SimpleHttpResponse cacheResponse = responseGenerator.generateResponse(request, hit.entry); context.setCacheEntry(hit.entry); return convert(cacheResponse); } if (LOG.isDebugEnabled()) { LOG.debug("{} revalidating stale cache entry (asynchronous revalidation disabled)", exchangeId); } return revalidateCacheEntryWithFallback(requestCacheControl, responseCacheControl, hit, target, request, scope, chain); } else if (cacheSuitability == CacheSuitability.STALE) { if (LOG.isDebugEnabled()) { LOG.debug("{} revalidating stale cache entry", exchangeId); } return revalidateCacheEntryWithFallback(requestCacheControl, responseCacheControl, hit, target, request, scope, chain); } else { if (LOG.isDebugEnabled()) { LOG.debug("{} cache entry not usable; calling backend", exchangeId); } return callBackend(target, request, scope, chain); } } ClassicHttpResponse revalidateCacheEntry( final ResponseCacheControl responseCacheControl, final CacheHit hit, final HttpHost target, final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); Instant requestDate = getCurrentDate(); final ClassicHttpRequest conditionalRequest = conditionalRequestBuilder.buildConditionalRequest( responseCacheControl, request, hit.entry); ClassicHttpResponse backendResponse = chain.proceed(conditionalRequest, scope); try { Instant responseDate = getCurrentDate(); if (HttpCacheEntry.isNewer(hit.entry, backendResponse)) { backendResponse.close(); final ClassicHttpRequest unconditional = conditionalRequestBuilder.buildUnconditionalRequest( scope.originalRequest); requestDate = getCurrentDate(); backendResponse = chain.proceed(unconditional, scope); responseDate = getCurrentDate(); } final int statusCode = backendResponse.getCode(); if (statusCode == HttpStatus.SC_NOT_MODIFIED || statusCode == HttpStatus.SC_OK) { context.setCacheResponseStatus(CacheResponseStatus.VALIDATED); cacheUpdates.getAndIncrement(); } if (statusCode == HttpStatus.SC_NOT_MODIFIED) { final CacheHit updated = responseCache.update(hit, target, request, backendResponse, requestDate, responseDate); final SimpleHttpResponse cacheResponse = generateCachedResponse(request, updated.entry, responseDate); context.setCacheEntry(updated.entry); return convert(cacheResponse); } return handleBackendResponse(target, conditionalRequest, scope, requestDate, responseDate, backendResponse); } catch (final IOException | RuntimeException ex) { backendResponse.close(); throw ex; } } ClassicHttpResponse revalidateCacheEntryWithoutFallback( final ResponseCacheControl responseCacheControl, final CacheHit hit, final HttpHost target, final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws HttpException { final String exchangeId = scope.exchangeId; final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); try { return revalidateCacheEntry(responseCacheControl, hit, target, request, scope, chain); } catch (final IOException ex) { if (LOG.isDebugEnabled()) { LOG.debug("{} I/O error while revalidating cache entry", exchangeId, ex); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); return convert(generateGatewayTimeout()); } } ClassicHttpResponse revalidateCacheEntryWithFallback( final RequestCacheControl requestCacheControl, final ResponseCacheControl responseCacheControl, final CacheHit hit, final HttpHost target, final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws HttpException, IOException { final String exchangeId = scope.exchangeId; final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); final ClassicHttpResponse response; try { response = revalidateCacheEntry(responseCacheControl, hit, target, request, scope, chain); } catch (final IOException ex) { if (LOG.isDebugEnabled()) { LOG.debug("{} I/O error while revalidating cache entry", exchangeId, ex); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); if (suitabilityChecker.isSuitableIfError(requestCacheControl, responseCacheControl, hit.entry, getCurrentDate())) { if (LOG.isDebugEnabled()) { LOG.debug("{} serving stale response due to IOException and stale-if-error enabled", exchangeId); } final SimpleHttpResponse cacheResponse = responseGenerator.generateResponse(request, hit.entry); context.setCacheEntry(hit.entry); return convert(cacheResponse); } return convert(generateGatewayTimeout()); } final int status = response.getCode(); if (staleIfErrorAppliesTo(status) && suitabilityChecker.isSuitableIfError(requestCacheControl, responseCacheControl, hit.entry, getCurrentDate())) { if (LOG.isDebugEnabled()) { LOG.debug("{} serving stale response due to {} status and stale-if-error enabled", exchangeId, status); } EntityUtils.consume(response.getEntity()); context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); final SimpleHttpResponse cacheResponse = responseGenerator.generateResponse(request, hit.entry); context.setCacheEntry(hit.entry); return convert(cacheResponse); } return response; } ClassicHttpResponse handleBackendResponse( final HttpHost target, final ClassicHttpRequest request, final ExecChain.Scope scope, final Instant requestDate, final Instant responseDate, final ClassicHttpResponse backendResponse) throws IOException { final String exchangeId = scope.exchangeId; responseCache.evictInvalidatedEntries(target, request, backendResponse); if (isResponseTooBig(backendResponse.getEntity())) { if (LOG.isDebugEnabled()) { LOG.debug("{} backend response is known to be too big", exchangeId); } return backendResponse; } final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); final ResponseCacheControl responseCacheControl = CacheControlHeaderParser.INSTANCE.parse(backendResponse); context.setResponseCacheControl(responseCacheControl); final boolean cacheable = responseCachingPolicy.isResponseCacheable(responseCacheControl, request, backendResponse); if (cacheable) { storeRequestIfModifiedSinceFor304Response(request, backendResponse); if (LOG.isDebugEnabled()) { LOG.debug("{} caching backend response", exchangeId); } return cacheAndReturnResponse(target, request, scope, backendResponse, requestDate, responseDate); } if (LOG.isDebugEnabled()) { LOG.debug("{} backend response is not cacheable", exchangeId); } return backendResponse; } ClassicHttpResponse cacheAndReturnResponse( final HttpHost target, final HttpRequest request, final ExecChain.Scope scope, final ClassicHttpResponse backendResponse, final Instant requestSent, final Instant responseReceived) throws IOException { final String exchangeId = scope.exchangeId; final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); final int statusCode = backendResponse.getCode(); // handle 304 Not Modified responses if (statusCode == HttpStatus.SC_NOT_MODIFIED) { final CacheMatch result = responseCache.match(target ,request); final CacheHit hit = result != null ? result.hit : null; if (hit != null) { final CacheHit updated = responseCache.update( hit, target, request, backendResponse, requestSent, responseReceived); final SimpleHttpResponse cacheResponse = responseGenerator.generateResponse(request, updated.entry); context.setCacheEntry(hit.entry); return convert(cacheResponse); } } final ByteArrayBuffer buf; final HttpEntity entity = backendResponse.getEntity(); if (entity != null) { buf = new ByteArrayBuffer(1024); final InputStream inStream = entity.getContent(); final byte[] tmp = new byte[2048]; long total = 0; int l; while ((l = inStream.read(tmp)) != -1) { buf.append(tmp, 0, l); total += l; if (total > cacheConfig.getMaxObjectSize()) { if (LOG.isDebugEnabled()) { LOG.debug("{} backend response content length exceeds maximum", exchangeId); } backendResponse.setEntity(new CombinedEntity(entity, buf)); return backendResponse; } } } else { buf = null; } backendResponse.close(); CacheHit hit; if (cacheConfig.isFreshnessCheckEnabled() && statusCode != HttpStatus.SC_NOT_MODIFIED) { final CacheMatch result = responseCache.match(target ,request); hit = result != null ? result.hit : null; if (HttpCacheEntry.isNewer(hit != null ? hit.entry : null, backendResponse)) { if (LOG.isDebugEnabled()) { LOG.debug("{} backend already contains fresher cache entry", exchangeId); } } else { hit = responseCache.store(target, request, backendResponse, buf, requestSent, responseReceived); if (LOG.isDebugEnabled()) { LOG.debug("{} backend response successfully cached", exchangeId); } } } else { hit = responseCache.store(target, request, backendResponse, buf, requestSent, responseReceived); if (LOG.isDebugEnabled()) { LOG.debug("{} backend response successfully cached (freshness check skipped)", exchangeId); } } final SimpleHttpResponse cacheResponse = responseGenerator.generateResponse(request, hit.entry); context.setCacheEntry(hit.entry); return convert(cacheResponse); } private ClassicHttpResponse handleCacheMiss( final RequestCacheControl requestCacheControl, final CacheHit partialMatch, final HttpHost target, final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { final String exchangeId = scope.exchangeId; if (LOG.isDebugEnabled()) { LOG.debug("{} cache miss: {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } cacheMisses.getAndIncrement(); final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); if (requestCacheControl.isOnlyIfCached()) { if (LOG.isDebugEnabled()) { LOG.debug("{} request marked only-if-cached", exchangeId); } context.setCacheResponseStatus(CacheResponseStatus.CACHE_MODULE_RESPONSE); return convert(generateGatewayTimeout()); } if (partialMatch != null && partialMatch.entry.hasVariants() && request.getEntity() == null) { final List variants = responseCache.getVariants(partialMatch); if (variants != null && !variants.isEmpty()) { return negotiateResponseFromVariants(target, request, scope, chain, variants); } } return callBackend(target, request, scope, chain); } ClassicHttpResponse negotiateResponseFromVariants( final HttpHost target, final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain, final List variants) throws IOException, HttpException { final String exchangeId = scope.exchangeId; final Map variantMap = new HashMap<>(); for (final CacheHit variant : variants) { final ETag eTag = variant.entry.getETag(); if (eTag != null) { variantMap.put(eTag, variant); } } final ClassicHttpRequest conditionalRequest = conditionalRequestBuilder.buildConditionalRequestFromVariants( request, variantMap.keySet()); final Instant requestDate = getCurrentDate(); final ClassicHttpResponse backendResponse = chain.proceed(conditionalRequest, scope); try { final Instant responseDate = getCurrentDate(); if (backendResponse.getCode() != HttpStatus.SC_NOT_MODIFIED) { return handleBackendResponse(target, request, scope, requestDate, responseDate, backendResponse); } // 304 response are not expected to have an enclosed content body, but still backendResponse.close(); final ETag resultEtag = ETag.get(backendResponse); if (resultEtag == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} 304 response did not contain ETag", exchangeId); } return callBackend(target, request, scope, chain); } final CacheHit match = variantMap.get(resultEtag); if (match == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} 304 response did not contain ETag matching one sent in If-None-Match", exchangeId); } return callBackend(target, request, scope, chain); } if (HttpCacheEntry.isNewer(match.entry, backendResponse)) { final ClassicHttpRequest unconditional = conditionalRequestBuilder.buildUnconditionalRequest(request); return callBackend(target, unconditional, scope, chain); } final HttpCacheContext context = HttpCacheContext.cast(scope.clientContext); context.setCacheResponseStatus(CacheResponseStatus.VALIDATED); cacheUpdates.getAndIncrement(); final CacheHit hit = responseCache.storeFromNegotiated(match, target, request, backendResponse, requestDate, responseDate); final SimpleHttpResponse cacheResponse = generateCachedResponse(request, hit.entry, responseDate); context.setCacheEntry(hit.entry); return convert(cacheResponse); } catch (final IOException | RuntimeException ex) { backendResponse.close(); throw ex; } } } httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/schedule/0040775 0000000 0000000 00000000000 14704162040 025231 5ustar000000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/schedule/package-info.java0100664 0000000 0000000 00000002413 14666635064 030437 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Commons scheduling strategy implementations. */ package org.apache.hc.client5.http.impl.schedule; ././@LongLink0100644 0000000 0000000 00000000152 14704162040 011627 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/schedule/ImmediateSchedulingStrategy.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/schedule/ImmediateSchedulingStrategy0100664 0000000 0000000 00000003624 14704162040 032605 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.schedule; import org.apache.hc.client5.http.schedule.SchedulingStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.TimeValue; /** * Immediately schedules any operation. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class ImmediateSchedulingStrategy implements SchedulingStrategy { /** * Default instance of {@link ImmediateSchedulingStrategy}. */ public final static ImmediateSchedulingStrategy INSTANCE = new ImmediateSchedulingStrategy(); @Override public TimeValue schedule(final int attemptNumber) { return TimeValue.ZERO_MILLISECONDS; } } ././@LongLink0100644 0000000 0000000 00000000163 14666635064 011653 Lustar 0000000 0000000 httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/schedule/ExponentialBackOffSchedulingStrategy.javahttpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/schedule/ExponentialBackOffSchedulin0100664 0000000 0000000 00000010517 14666635064 032540 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.schedule; import org.apache.hc.client5.http.schedule.SchedulingStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; /** * An implementation that backs off exponentially based on the number of * consecutive failed attempts. It uses the following defaults: * 
 *      no delay in case it was never tried or didn't fail so far
 *     6 s delay for one failed attempt (= {@link #getInitialExpiry()})
 *    60 s delay for two failed attempts
 *  10 min delay for three failed attempts
 * 100 min delay for four failed attempts
 *   ~16 h delay for five failed attempts
 *    24 h delay for six or more failed attempts (= {@link #getMaxExpiry()})
 *
* * The following equation is used to calculate the delay for a specific pending operation: * 
 *     delay = {@link #getInitialExpiry()} * Math.pow({@link #getBackOffRate()},
 *     {@code consecutiveFailedAttempts} - 1))
 *
* The resulting delay won't exceed {@link #getMaxExpiry()}. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class ExponentialBackOffSchedulingStrategy implements SchedulingStrategy { public static final long DEFAULT_BACK_OFF_RATE = 10; public static final TimeValue DEFAULT_INITIAL_EXPIRY = TimeValue.ofSeconds(6); public static final TimeValue DEFAULT_MAX_EXPIRY = TimeValue.ofSeconds(86400); private final long backOffRate; private final TimeValue initialExpiry; private final TimeValue maxExpiry; public ExponentialBackOffSchedulingStrategy( final long backOffRate, final TimeValue initialExpiry, final TimeValue maxExpiry) { this.backOffRate = Args.notNegative(backOffRate, "BackOff rate"); this.initialExpiry = Args.notNull(initialExpiry, "Initial expiry"); this.maxExpiry = Args.notNull(maxExpiry, "Max expiry"); } public ExponentialBackOffSchedulingStrategy(final long backOffRate, final TimeValue initialExpiry) { this(backOffRate, initialExpiry, DEFAULT_MAX_EXPIRY); } public ExponentialBackOffSchedulingStrategy(final long backOffRate) { this(backOffRate, DEFAULT_INITIAL_EXPIRY, DEFAULT_MAX_EXPIRY); } public ExponentialBackOffSchedulingStrategy() { this(DEFAULT_BACK_OFF_RATE, DEFAULT_INITIAL_EXPIRY, DEFAULT_MAX_EXPIRY); } @Override public TimeValue schedule(final int attemptNumber) { return calculateDelay(attemptNumber); } public long getBackOffRate() { return backOffRate; } public TimeValue getInitialExpiry() { return initialExpiry; } public TimeValue getMaxExpiry() { return maxExpiry; } protected TimeValue calculateDelay(final int consecutiveFailedAttempts) { if (consecutiveFailedAttempts > 0) { final long delay = (long) (initialExpiry.toMilliseconds() * Math.pow(backOffRate, consecutiveFailedAttempts - 1)); return TimeValue.ofMilliseconds(Math.min(delay, maxExpiry.toMilliseconds())); } return TimeValue.ZERO_MILLISECONDS; } } httpclient5-cache/src/test/0040775 0000000 0000000 00000000000 14666635064 014704 5ustar000000000 0000000 httpclient5-cache/src/test/resources/0040775 0000000 0000000 00000000000 14704162037 016702 5ustar000000000 0000000 httpclient5-cache/src/test/resources/log4j2.xml0100664 0000000 0000000 00000002210 14666635064 020531 0ustar000000000 0000000 httpclient5-cache/src/test/resources/ApacheLogo.png0100664 0000000 0000000 00000104247 14666635064 021433 0ustar000000000 0000000 PNG  IHDRpK6bKGD IDATxy|e;s[irtg_E"*n,(7pAŋ( ¦ BY-&m{ڜ$gqB.^|ygwΜg&dI&dI&dI&@{L2$R Mq|ԩk9'dI&ly`!i :}yƴ_3^&dI&f[5 \\ TMds--gl\`Ⱦӧr"dI&_Wi0Wi۬9̞Wq]w{;޺765?[؅kw5$L2?!?O=T蠃/B>.бsΙW01{_h)//oi=kZbr'He l`7SRgk U:M{I&dIIP3/_~^>gΜNڔ32tLO7ws-szxiM]G2@K.^qEz "ej?in*p3MuT:jQ/Z#/]KRwŽ$y8Z}M$L2$o&Yfȓ˗/xQRxb@[vcUzl6O_Y[{ի~ZxCkds~Ybű##Ox;Y}ENk:aœ97=Vd{ohR^KD8$L2?1톪+V8ndK?x~[Z() x_xS_rʴ6HUݶLz 73gμGynͿ9:0\B@6b]U,Z[ 4E\JNC!D*cX !BjcHIxUjۢU9\iXr(ZU[6=_91Xy:bz v!g-S>d/Hz 2n忩1Z78_h٫VZ1\58ޮ߈5MڰqAZ:.2ߑϝ;w

O1L?bIv]k$N{]W3$ 얩d޼y.[ZQ:J,X… +N؊~{LJJJiM$vaI"X JمL4QBl)%/e$ %LSN':3/93JF"xXB 9nuz0G,[C4˓nN.5vT2*"Diy.k<[zOutV)/xRAk^DlQ/n6|`tYO۞cĭMMGwu*}$G̙ŋ-~WD>pGsGC=5\#>, T & G"tKiip Gy]^Wd 1&if(!VDRh#)Qk3ͼ#I6jSN5CR4( |߇Aq#BX+RZ\IYzR>qg WkSE#.)+ÃsjP3{{ ~_v=8JyY@Ϭ^0_=y^D/aE@1Hh-=֘owuuMHYġc{Ibo8oٲeȯE^UG.X HGG7pPUyޫ̊*˘nS-% "A a3HDLR(4gWJHr3($q,3kJ(|BZPK4)'lJIDt MNMb1& ]of]U,+_oo <"qŠϗ"/~ س̗Ԟ>Iv ntT6rl{sa==n3ikJp˺]4h=nUOu͞=߿L`R@M]Aǜ9s sKl2sLoGy~R[[ƘFAP՗[*KrbSW6D(nC q1@x"_BD4g*Q=3/=/:wEq\u}jP!#yqp*Y?x0Wg3guo5(;-ze~Ӿ?u?: @k}. 1DvG[s><9ʅbm|4Rw'>QD"1 Ү%|r>rUe455jje***>&guկ~WtJ5cO}XHS,r"$ſC!!GAIhЭO&Id?ҀY |pp\ؚ@O25'9gUߪ]!זH6ro/_L@^E9pu5'6!wҲQ=+AZ}(B[sb4p[շ=E. 3Iq| CblknteOس(_aK-Em "zNmMʞFPns7Nn-yuk$^^7Π})p(UqַKṂ+Aͱ%L2' ?$Aa eq:Giv4H!OYLj-פy2kAFlh_M|Kv^C);߻toqٰ8o-i'c͕%.ae{lInm]6+1 v dVͬ+8mn\.u;u b;6~E+"cF_VЏ7@y1`CB {1ion?JZx[ı[ZuNG+GS|c-ԡgM-tvjwNnmm0Z`fȧűnO$}^ HD9][@9%m͉+kkO{:WFu[m Ƿ5|weOEL8*Mo=玏ܵfMwW`iԆ)Ï{z,^8Gx9|_ Éu{9mDBq66uңx =ReD_F?xSb" x.Y!Ig%Pًrzm1Ģpa#l4ܘkA\4dzreɩї,q*?8ɖ;`rbӡ,_u*Zb ȔH+5nh*Ks+#1'7ܜ}rU;,[jժ޶Dr/ pm͏ fZ: r1mڴm͉gD߉Pi7pp>ȋJ P Lv\4րD"QꝻc+O㩜\<րD"Q+X>pX B4Ɖzi";b`kW~gҊKy E,t]|tuTdr)[k+V=g e ScpXnf\% f]Vr@~f3ufn~3-,YBˠ?!gɓe8zoGl`(h#!ndJFj^$Z=Pc\1DVu E|\ IDAT. +sL%U ogrȴOtԚgI~tM3nx]CNwD XqkX::GaeyeU]sQ[cۍ8UPф&U]wA% {Nlrn'ըsw2KD;{{M3XAjǹG/Xe]]]O be53HM1yUD"@|Q9U#[ZZU9ngk v{ 7|Tadp=p#---bul?rx&lkk9eO&_=5mڴjܳnq'2a=38ưnuZG`%`3yZr'>uS Ѣ 6 /!rReRb߻YVg3H} x @ &dK(uIi?G]^~$)Cu63 Kx0$W:8?$Q\k G_ 筴|TeEVsAiGJ19X \Zy#k[Rk' K 2y..Yϩ~UBCŢ_6e1ٳ7:Y.7UlY~Z;w 6m}^tZ=|?𺵁Zƥsu?y{/v[vA+W\֜xb1L&N@-C8\ksg~=Ef0=iO-ߐKbMJqKi"g= dLm:rXǶjժm͉灱9͚6v;Θ0icc}DxS7lMΟ~{_Zd0ӏ=,;tDdY 5c), X6/!jPPp(QaDngڋJif6ͱ(c㖁B?&c^ @?@xX#qBDއS,Vր-bJv?I'*5 R @ $5kY ꌡZˋ0 QOý\ߛb@Z*IK"=\5%@mlCTP oGftk (z=o++QC> x+.'9o.71O dй5|xCyVIG++s_@<04m qS r3%DJ,]qv땑vMW+KR5p$?g<]'S.$ +jN89JXcĀ0>ÏT}r{Ɋ囗{M;c?(n lj#*q+{[ [q҇ \Z}>;F}W/:cOQwM쎓JwD"Eul?yߣ ^' ,YQWkllp8F ㆦ[k_k:0A*cΛ9s毗/_~ d??ﻰsCe%N%_qÔaC#KaH aU+9)JQ@Qn,+ b_RӢ*1?_=5SM/af2qxeQh+a,濢p C?mR*L!/>B76닚 X/*V~饸<@98(xx|5d~B]ͯ_\۟&s.݇CU9ΐSݡZrƶcwtL8hǸCbh7} m)VmG'|׈q=%S;َ~w΄svè|@GGǻN9ZUEYf)"yW ~kEGyRU<3Ȱe#=aB tkXY8X=pاB,V@|U@4救 :(ȕ%Rҷ@|x$7[ Kap\ݔ8eĥ5ϦHqj(1tKi& 0fwG@2yD raDJr|8 Q2[yx' U&(Ggk" GiH}nv9ǎ[U~ۣSew,i@SA%G刀L CdkR#nԈ`*6@9b#zNyRǥEc =͢Ä%JVd!|;Zda1 X%on Zp(1Sr54?I-,2 9CU[X~ZϽLC)!fPm#E{/ExN%-PuW-XnmP5 4wqKr@ZEeTmMG+kDbH橵?~gk#y%nEU$ܫLnhM> jDk#-ՙv?;3D?g9ko/ŖoU j6vA8)t ,}AEXFEn;/qR/7E%ɘmqb:Bu_E__߽=wBTub. /~I$"&Vܡk,^ChXe?b*ԆqՒ#Y iiF0xz?P xdQ[s~*k&sTxvA"e\ jt$^7u1W^?۽͞=Q"bbXo^\xŷ8$>crp*sr JN PPc :l6)%#X\S:訐|n`:8x8X m !.,G2l:uZ#/i ϧ2|eigWn*}U4M}}ҼΡKߐkxM$ ǿ!Go|aGQ8k[֫iiٴ8TYyƈz(!n>>=ezא?#'"vٲe2\U T֕|?kUd^x."jv(gO\ʇMY \ݏvJa0|/KjƌhL]o6ʈK T&*1vږQKIk/X/E;f iZCZW$- M<pӣS 2 R0Y)<+Q,yoBUl i2;Q\"t b8q"nN Aȉ0.F֍|'VDW0%~ T߉<{<&8tJ⺌ӈD `| +뇳|,ɛKH'PZKfRox~ܲڊVqҁaXgyv?M 0w߳.TOUD/?6yM^sDb>KB9j֦#7FD>S_oUXq{ȃ<跑x8}}}-G'DחmkN< =ÿ9s ,Y*  N-o| a!}jx͙ C>k.R{7geV5C4(Ie\X#ZTDȘaȨykFu: pd.Q'tZ7*莳XZAӝRԍTi3Brީs)QX#TF@=Y-P0>yrx]zd}>N / ( V n@LOf\BVK^<3dNpʨe==bm0MqU4' {3#i)QF|[N+[ʢIaQBfX J_l? K?1/\Y!;>~;Nbh{bE6lHFr~ 0N+ x`(y; d ݑ *ىe& UInP]u|vWw4G=W z~̈́,t?=ahoj]gon(S8{eO$P[g}:::>d+ =?ثh>,TvsTUϽɇ_z37]-{8((LChi)Eqn̏/3Wʱ"+a KckJp`Ia*dĊ'KfL*6}4t,3߇7ݟpmi>{`1o婮Vw#g8l,Qx(1z5$aSm5a*C)<?/FŐڻ8҄pKv^k Oj)(ngJ&F7}tkw`@x<v3#9RDH3I ?)ɹicLVܝTH"H/Jg嫕[p$rFOq<0?5{n 3g``|ouyyc&{#֮]aC.7gt\(sK(޹B+j>4 jnCm3jR*LUAb퉣HUTºp 6RYQn hv~άPPzbOvw5@FЯtp p1qFd@fuZOSdǧmr*x^4SlJ&|Ǚ檖{@>Ճ1)f͚%Kz/PՅ"?BkXN4}䴹y}mZsT3GK' q&8s$\hۂ̪tEYH>?j_@պ}k9%Yy2o„_v^`U(¥жP!pk h6#ε'Px7y / g*ON\ŋ##^,.+%VHtI7'_'ߙ!`%I/**KJ'),%>zI%)Ńz)Nĉ&?3tFq3V)(ߤnm|%P^Ho/d8ClC"bM貽LƇ \`Kk'4ŖfJ*p|I9m'^A2Bw"T9xj /P}qOr#^m$ӡ!|n7s2J_Ogŕ|PQ. 0L}2~h^'d@'sKJ|ȦfA&hHQl"KWi3cbgRb|b(Q5ᘽ*䣇M IDAT7ECS_\|j'b7YPx&~xѾO-$l3ݺ؟<@3 V4v޷~Us̾e_VR-vnL }İCKJKmo۸qE4Hc m䉆ƜDo8g^B&X=ڧd[ZZZzǀݞ5A,[,D:H%׽Ӄj֦ɤ烈~=ŧO^*w\0b f9W2g,/W㱅.Ff@E;\;%c-YMs*bH)?wzH<Ͽ&S-L@X{@f? _X~@CSP=+Q4LJ%Excfr߃+>8.u_R0-0&`N n(* 9%5(u\G-kunbڄUMk뾠nuןQGp x#S/*(`PrLcsc"Tw0EHrJ p,3:&Sfx0wܡf'IT 2舚\mm/=b"JMUl+٥7qpHn}StL(5%K^XU;Esu6l\]v=7nƯeF kcqaP3b n^̯fPwZB;H 'ﶔ0=.%y\Kk(~ |`5Kش5*MpO*\/RL?;ml$ro)]1.k2yO*=ieŅ2&\I,sꉘ lcTIFHSuy}dAj~_6`)2?r*CNEn^&^ib M[` KGWDru(*R180j"3(f\| 2jKڹ7KTc=Ǿwfϛ]Ϻez4译HLՌS9;|`UA~_8(](FhA:lgMUfR55As |L1m‰u?I*Tg7*GqEk}4z-Xlǀϋ$Ujl6ִX_:EO9q,}{ W~%n8r枏k!^[b }c9vFe|9e*;\|b~ױ5+)kg^0_2؄˗ sKUo{QC~Ų|/M{ \C\?=Y ~*Yc&SEb?{h8&+IeS-e۸$YI9D'@I oCLogy-lp* Pxd6]|86-yPXaW5|܆ 8ͬ4p='ZU}&ʿ7q;n:F'ۛ;x=$KZL/'rY)Ʃ#ʙ>5i^Mnn୥\  -E՞;_b+p@-mNkkT8PVEbq{ kU80Y&ȟ\#46623{{UZGێ<=EE"'o+IUpWQo3sUJ]Cs#d#X#QTm#3P9 ü+@TY|5"r"fpNJ W_=}~[{iyzlLWoJW$-Ĕo\ O(ޛ݄pOރ XΜ{z81V?''\\8: h SrfWN |WiLqVKSth5$9_"$PN(lիSRy((g'`%|g#uXC |[X$G*y_dK߱h#T)<}/$ʘ#(S)94Wzi|UgP/ {Eh\[7 <Vij}Coa* @3oH2Ҷ9Φ- .|jz{O>ܚoIޙ1  O\ 붵ab4)?BPqGNƊO`mhi7c`5 jL OUIم{hGpFJ)0IDvD7,sEF1ǍT)媲Q,˭ - u$KwCU>#Y^Up^w*hCOz5m{1,y\g99X1Ÿ8ݴ?mw Y/smo s |#9S(^璓xO!DF:Yη3J>SX,7;xE[7XҤ^l\RHpw-K a[ .]͵KL?{ُ2+\ȋ/oŕ;Slǣy:q6&; g0IW9qsK98E9p-W&J?ֈ6 YLCn.~[gP-I8ؗ{ eɴYK3 7/{˥*5da$':QpVr sZHj-]\e9&-U7uII ;ͽ3dBpRNNl]R4yL?.T˗_4X>(#IE%> vސR07x“Dh:n`*Oi?v#UJ&/ Ȃ?~(7%沽:TR9—8rLop*9uL|ZoѴ p+4?ϑ '8o޼ ލ qD++0aILuÀ=+{ t7l,~7M${u-6{,wR|gUoNޤ{{3f1q8|=%Y홝LN61mkå/5qK43BʼTvO[)^ohMWkpmoʍVfzĒJ G;yU;pg=):4m`n/uci񭚘ybftkSI]ĉNߎ˅s7rA.w~旀•]7k1ylW3k&(8{ѯVGN>$ i J4O]<ϻC)."v˖-k׮%L2m4&N=?]Aqʦ˙W^KYؤIe83eʔ^Ijw)hLnu@8{"jh/JUx>T5b-m*$H )?iM2تFUz 2֚&͠_5?(q=Ke5fWذvuD2 I hN@1^lWόp'g_ZZ8꣏x{z{8CTZ|hiA|yq5wȖP1 Z@onwݪjI '.^ۡPhG"}3.Pe˖;sf1>)ֶc'cJUZ[,"YVD2{_E5+?]_ cԐscybzE!/B/| ɄLxgC3L1ƸdF42Ƹ:8`֬ř&cLO} w^#"6̙3gޭ#ƒ%K||(`kTb"""D$/3hTݤ54'cء"kuD/%H+FHk)^UM&LYJU 6Rե"X,7s~ `yq͉DB`_."Xk1_֞ Tcb>mYjY3k֬1xSʼϺhѦ tck]ܰ۴3* NXy}4(+z䍆;="87 a0ze}SnK%yyy%.2Ɯ TcLLU[1߷'"sRc1#"28q־8NVD$e zkmC!t U|7B1dcʕ1lei ޱz'\-Y"h?( TUժkfe9OȂ]خqg:L@ՖŤό,\`~"#dD}5F~(xWF38d*!{2]g 4f*^Y\9t^GdCCCvmm/}|Sҹk̑vq4vp/hhNT;1{xR4twcW1fJU?(9}K6,z r) |sˆMH 9{ch!H"kDYW{JuQyC pUՠ%x|&7&~&\U3:NH:iY[ܜB}R;5b֓<\0wd_OmmmI+I#f8Ln@0 S⾿#QV'Z֘8Gx,3,G-p6`"U腮&c(n=5Q-־jQ:Á/{o kO%w9Cl&2]I'y;p0kxېNJ,bnZpbk ۼOwg -w^bZAo)ZupFcGש>FbUÁG䅫pB[aP;\F4];Ns707pJb^Z~%coE;;k!v5bk 5;]M$8x^*Hok(k"jueA% 4>F4/JnN9eމ ex { IDATmQr6+T\dz|2$R չXeB$Y>2AzyljV`]y*`H ߂ F-NwJVOm _~sqLGf/'8??=bha( k[}SX:U֚@ "dC>Z< 9ʼ8w;o,^ȞP)3 8-{e=pCPh_Uat]  }Χ:X$ȃQ\qvG8H+#A̯}c>'Hcmc< *X B_=&DYUf!|,?DB573tt_YSLX ilt,l|<0l "TTUU,Trxֹe:./+6j$Pik#;Ђ7!Ri1U~dYƏ2PT0t.ZNaKcY8)2x?~ jkk};Ģ<ȫ`-ȡ ]Hd>^SS,KLb,73$@sfpvxVezIrmqTR㌦@-tb }lJ<$X|V8R,Mx۹78ZBѣ1PFFUFGY(B/w"ཪͯf(F礁cuuDl^K:MrHU mxdk@`%pG]+W5ҒP< !ʡP>8#ȀN$gݏ~-]xZ{--hAKR@F41C&z}ph5*\;O@~GpT,vHe#f6Pxàg75WV[[uvߍka8 W"牓'?#Ff8mHЩ*GuGq.!C ,B*'p`2U6Yw}ֈT!3JZ9.}:vt!UhVd4u9qLaK(:ר.rY{W66>mS#Y4xW_}|xʄHUܺ%}E*e=:I XaIW( P* V-RK#-@5"D!=gf& ,;~Gc=?krP@w3E>%MMfx7_b*xGКpSG ],YW7&+ /h~U$~Ad{F@GHߡ 7@dC.1(ғL>(`0gGu%0Pa745^X]"c[Mf4Tգ%@́466_z,{ (+2|KdT0CCH_݊1K v vCXVD"?\T vbf Z f=ֺ6תGhQ`6p1L@a3ug3|vK"zK>r (}#HHV} N44@054H$dww#L 0]T˭J"SUt^y& 07u%wn.9|\@Dds6h4 Wwo c64G |K1AurpE_ d;QafQ5A-Kv)b, eT?ĚK]kYTe]\lKٖ2:9C 'k2` Q> Mm!jF"-X_뺂X뱂~G&{3 xwJp}JueB1|XfLw0y9DZrkYxA`eoѮa;Ś.@ 9Af·]V$kPjO[߅-;ٗH$⯫ ?7h4\g.]uEͼ\ST*D"~L}ׅ/ xQ)ӦưU_8VJٝdzFxlX=Q)75EǪ=i?;9ؓ ;Aj1Uw*0;'hySScC4G뛢S9~R2CYIj9݊ik"=k6a*:dF=n*/[:[xG@֜4;)hش:(,$9":,2DEF@-"9$2sfΜANֹN9$ywas2rJ$#xTmZl+Al&rWfVG=a:\FG$heϊCEH j:I?֘{+1VETV#ŲHHUf$C{:}neWo e<;AE7~1epZN$m}BWsQ^lhHv']eTSUȡWWWOsGIzW,CiE0=E+lX fe݁٨YjGAAA&zduQbLT2A^P$^>#F9+:ܴ{aeK"z<75=چ{)666}; 8~+eR"f d-Gnnhj2l1t 21s#L*U@h꣍vlLPTlV\qm%ښ45bL_>pE^BWUWW}V7yՔXw ݯ@MNߤBo֎wf|tH# Xt~D+,Xk.2bw&ݢUUS׬` `,hllw.-ʱ{dC`Sccٿ7eNEEn:  *24z;d7°c-҄tۊӦah`AzDWZ,///@٫%[# x3 V;єܕ7ə hp 2ܜ̺n׷bs`08f2vL+]>Tl50fGNڃ" m;Ák4]2 a!i 7FeP苑`1UIw5\;vD*+CVO^nE~AW+2ܜ:\%7'V =9fOBOO"1H._5ʶٍl^t(AH ybi+j2OT6EPu<+U[JxSDp`dO7R8& B_nll|67wd|-[:}KMvQ/Cty"Fl /@ Y{VQaUaXBHXGZnYCmlp9Bc}Skտ\\Eoo.Rĝh7"u͍WO|Ew\1Au1&uK7db8$F6IϖSnժp P 2̣O7}u;(d~[Ѻ:|)GLĵDžB[K"(EJzD Á Ң(aqÁ &o1˭iTõ h4LH6X#'h]1(f-ʈ@* 9丮׏`E=#շ n9z%Cw75^J6m phvSkHyhZ'y㊜>n/OꚚvKȬ1Pqgf#GFEV^h&oochlluE=kk K8 uݬhe4Baۈ|ժVEF:YlMя vpTxx{]FOQ@*}m>D]sݢ\?V{P<4u۞nQ蠨#R$*gwzQh9cwh46t1?NީKvZ,eRy:{A2B HzOrEݞ+7ՁV]q<[ꛚwJ`X(EFe:D8Cʞ"ylYd߸_fҺ:b'>CSӈF_̕`߫ .}* Nr+duSxny~F!c*tAOpJ-']MkkznGJw,P(+Gs $uU:\q)RZu XI"{.]o2~ckkkO*ctx5Ŭ W'f@O#O :L\WG ^rNf?e=qQKK˦p0'KrP7x[(zñ\?qsѦY|-`%gx*E3WWUFĞpАH25Nu䳧Ƚ?9Lp, _L&ch1"۳[9fXǂa.[D"xX8 "2ի c|*"HI$64HyyyAAAAI$dzq'B0dRLLjZO>ֿ竭S%ٴAiO֗(Uk8hSSY9-x̄?93gN|uDngqgqgqgqgqgq?=.Y@%&p;7=@莒>yKvE[)K\2cs{{NkqyD" %R2|S{S= B)K؝cۏT.{M4"@+@ `D&Х޻HUU9p6sAqbj cXݖyPcb9Zyz{ G =V8wl#b8㌳{q@:ZߺD"P(`^JEEE~0 }gD~F{O: 0SћwRP]]=qi }涩,]>tg渾煊D"jjQP(4"KfTV:v`08=s]Lcƀ=6f*K}+|z>J{#D%@2dDn]?"Ju!EvlܘVG&yi{P֪Wv+paV|0hr~cDm3rxQ~.uRڊr TZr-"k(3Y߿D-- 7wbF'w"&noP9ȺsU'4/ ҙTu0">,ȁ (lZwrObc FU~!C)Z(*TFeXɕؘ?!V!+#RqFLÛ*@ɂ|M],z^b.kD Մ.@RAOInLgS g3;+[SPA`Wk 0E=~cq*]9>Ƨ>pd -k MQSKQY=ENQqV&J2AfA^ ܇r<$qJ`m(ޡʤHWr8Ũ,)93_@TbA܁r$9xoG8]ѳVK*]M[|WeIl*ľXW1O'3۫f<,r0mg୊$Ɛnc0[C[XUȺU3|FV΅d14.Nb狇NrMo3<TsE06!Nh^+IGwhc1"վ;=E6$Q90=ԁ%,~qA[TbLPgEM6uLʃ(~`nv<0+@^_*+=GX9h^364[*<{u>ۯ"ko7 zΖ粅-suӿSL :Ò:5Pa¯'t<~}zNu](Fϋ9wQ>YW¨݁QE/{pK|&NP(MXe~<_ŹbK?zpMT*IH%}ի}/'(/Š1<@P(D(?Lom=$I _\T9Pb=K_$(* lArO@;TP(ݍʃ|H-;NPBh4c:$kJ* e #ES!jvJlf|?4y||Tje(Q}  3jhNd}o7q+}vh l1*{9e|pX m˱C{?yG CXYZ54 rWJi )&zF QtI=я-ߨßhxw׈>I萹 q<#€^p5$TJ-DYߢIFYϛEr,VN~mTT|<3xXDvu5B||QnTU{.k02g"c#:e{k: wIq1;A> 腱TM۞F/ >U ZQ}2a wl <p+C2 v[YgEAV4 887SMEl:j^yѽctPq3'Rs @_lniYVK9.Ld>E/ +,299iO/a#:E+w!zlf@g%Q&b iSJUaGL@OCrQBdhԿ}D٣zkV&r$,IDAT#_ЈcC<5нrIJ9!Ϫzٷ&kYq[iX>=Yǵ=+T6֜2)Hoo }A.6np mmm{w[֭[77g$ G *z(? ðY)\>RKd\ׄY tI(]RCkw rkV$Jv\.Ҧ^Զ8 atN/L%=Oe|]y--(T9d,r7H !lWY,eqyUD2N8^XAmzաXd z<άEZ"Dyj璨NIzΑp^`DU4€S-T*#V~ 8+|oimmWS'nzQ.Hr^# 739@c<a4AggLВ+#(+%kPeoP VDgg|8vܗdӫ,ɺ;b͢.VMV%yF`ȍ(OC2k8{А|)@':6Rs<zYB",U::!%Ei5Ucz.6ǎ3 LL(UxލȿW9哠sQh]@JS|5ɣ̠6$2oTd“%%Ν=ժ5r)(cvyCrRџ@g1EF?Z_,k)uv`Rիܻ{zLHe>֔tP(Cej|" ak)`x ԚsA6^gUYeУE#5Y-b*X֫zI3.JE_A? rU-5tE3Fa>KWl֭[6Gc19UV#ȣyX{|G jUNoyE&ʇ-z ,hU 8دcjgT*ueXc2$Z<iLÔ\) U|1lOˎؚ(sDScLq1ԫDF5- OѶ}UݕQ{r(k v{Ζk-G.q]w1f`zzz.5Ƨ5q,m7Nּ0/ ➞3Qf[pϚZѲ#UyaiUu@~czv4b'XcB73fhزe7Q7lxGXuZJX۔b>;]{{g)L:@\No3?^G9FNj Q,U6;;;_r]wқv1m۶M8ab JDrxdmPq.PtIur|k~n׿9?ժf1:q]5p[_yNɶ<O\f̘xk79T0fE[תS*$ԽXSJO KK ~3ʾu;A6BhX^M_:qQnO11x _yVShT#Ns㿯G7/uԩSN:uԩSN:u}3HuO&$IENDB`httpclient5-cache/src/test/java/0040775 0000000 0000000 00000000000 14666635064 015625 5ustar000000000 0000000 httpclient5-cache/src/test/java/org/0040775 0000000 0000000 00000000000 14666635064 016414 5ustar000000000 0000000 httpclient5-cache/src/test/java/org/apache/0040775 0000000 0000000 00000000000 14666635064 017635 5ustar000000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/0040775 0000000 0000000 00000000000 14666635064 020227 5ustar000000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/0040775 0000000 0000000 00000000000 14666635064 021572 5ustar000000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/0040775 0000000 0000000 00000000000 14666635064 022551 5ustar000000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/cache/0040775 0000000 0000000 00000000000 15005672016 023576 5ustar000000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/cache/TestHttpCacheEntryFactory.java0100664 0000000 0000000 00000042212 14704162040 031510 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import java.time.Instant; import java.util.HashSet; import java.util.Set; import org.apache.hc.client5.http.HeadersMatcher; import org.apache.hc.client5.http.impl.cache.ContainsHeaderMatcher; import org.apache.hc.client5.http.impl.cache.HttpCacheEntryMatcher; import org.apache.hc.client5.http.impl.cache.HttpTestUtils; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.message.HeaderGroup; import org.hamcrest.MatcherAssert; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestHttpCacheEntryFactory { private Instant requestDate; private Instant responseDate; private HttpCacheEntry entry; private Instant now; private Instant oneSecondAgo; private Instant twoSecondsAgo; private Instant eightSecondsAgo; private Instant tenSecondsAgo; private HttpHost host; private HttpRequest request; private HttpResponse response; private HttpCacheEntryFactory impl; @BeforeEach void setUp() { requestDate = Instant.now().minusSeconds(1); responseDate = Instant.now(); now = Instant.now(); oneSecondAgo = now.minusSeconds(1); twoSecondsAgo = now.minusSeconds(2); eightSecondsAgo = now.minusSeconds(8); tenSecondsAgo = now.minusSeconds(10); host = new HttpHost("foo.example.com"); request = new BasicHttpRequest("GET", "/stuff"); response = new BasicHttpResponse(HttpStatus.SC_NOT_MODIFIED, "Not Modified"); impl = new HttpCacheEntryFactory(); } @Test void testFilterHopByHopAndConnectionSpecificHeaders() { response.setHeaders( new BasicHeader(HttpHeaders.CONNECTION, "blah, blah, this, that"), new BasicHeader("Blah", "huh?"), new BasicHeader("BLAH", "huh?"), new BasicHeader("this", "huh?"), new BasicHeader("That", "huh?"), new BasicHeader("Keep-Alive", "timeout, max=20"), new BasicHeader("X-custom", "my stuff"), new BasicHeader(HttpHeaders.CONTENT_TYPE, ContentType.TEXT_PLAIN.toString()), new BasicHeader(HttpHeaders.CONTENT_LENGTH, "111")); final HeaderGroup filteredHeaders = HttpCacheEntryFactory.filterHopByHopHeaders(response); MatcherAssert.assertThat(filteredHeaders.getHeaders(), HeadersMatcher.same( new BasicHeader("X-custom", "my stuff"), new BasicHeader(HttpHeaders.CONTENT_TYPE, ContentType.TEXT_PLAIN.toString()) )); } @Test void testHeadersAreMergedCorrectly() { entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(responseDate)), new BasicHeader("ETag", "\"etag\"")); final HeaderGroup mergedHeaders = impl.mergeHeaders(entry, response); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("Date", DateUtils.formatStandardDate(responseDate))); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("ETag", "\"etag\"")); } @Test void testNewerHeadersReplaceExistingHeaders() { entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(requestDate)), new BasicHeader("Cache-Control", "private"), new BasicHeader("ETag", "\"etag\""), new BasicHeader("Last-Modified", DateUtils.formatStandardDate(requestDate)), new BasicHeader("Cache-Control", "max-age=0")); response.setHeaders( new BasicHeader("Last-Modified", DateUtils.formatStandardDate(responseDate)), new BasicHeader("Cache-Control", "public")); final HeaderGroup mergedHeaders = impl.mergeHeaders(entry, response); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("Date", DateUtils.formatStandardDate(requestDate))); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("ETag", "\"etag\"")); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("Last-Modified", DateUtils.formatStandardDate(responseDate))); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("Cache-Control", "public")); } @Test void testNewHeadersAreAddedByMerge() { entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(requestDate)), new BasicHeader("ETag", "\"etag\"")); response.setHeaders( new BasicHeader("Last-Modified", DateUtils.formatStandardDate(responseDate)), new BasicHeader("Cache-Control", "public")); final HeaderGroup mergedHeaders = impl.mergeHeaders(entry, response); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("Date", DateUtils.formatStandardDate(requestDate))); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("ETag", "\"etag\"")); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("Last-Modified", DateUtils.formatStandardDate(responseDate))); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("Cache-Control", "public")); } @Test void entryWithMalformedDateIsStillUpdated() { entry = HttpTestUtils.makeCacheEntry(tenSecondsAgo, eightSecondsAgo, new BasicHeader("ETag", "\"old\""), new BasicHeader("Date", "bad-date")); response.setHeader("ETag", "\"new\""); response.setHeader("Date", DateUtils.formatStandardDate(twoSecondsAgo)); final HeaderGroup mergedHeaders = impl.mergeHeaders(entry, response); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("ETag", "\"new\"")); } @Test void entryIsStillUpdatedByResponseWithMalformedDate() { entry = HttpTestUtils.makeCacheEntry(tenSecondsAgo, eightSecondsAgo, new BasicHeader("ETag", "\"old\""), new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); response.setHeader("ETag", "\"new\""); response.setHeader("Date", "bad-date"); final HeaderGroup mergedHeaders = impl.mergeHeaders(entry, response); MatcherAssert.assertThat(mergedHeaders, ContainsHeaderMatcher.contains("ETag", "\"new\"")); } @Test void testUpdateCacheEntryReturnsDifferentEntryInstance() { entry = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry newEntry = impl.createUpdated(requestDate, responseDate, host, request, response, entry); Assertions.assertNotSame(newEntry, entry); } @Test void testCreateRootVariantEntry() { request.setHeaders( new BasicHeader("Keep-Alive", "timeout, max=20"), new BasicHeader("X-custom", "my stuff"), new BasicHeader(HttpHeaders.ACCEPT, "stuff"), new BasicHeader(HttpHeaders.ACCEPT_LANGUAGE, "en, de") ); response.setHeaders( new BasicHeader(HttpHeaders.TRANSFER_ENCODING, "identity"), new BasicHeader(HttpHeaders.CONNECTION, "Keep-Alive, Blah"), new BasicHeader("Blah", "huh?"), new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(twoSecondsAgo)), new BasicHeader(HttpHeaders.VARY, "Stuff"), new BasicHeader(HttpHeaders.ETAG, "\"some-etag\""), new BasicHeader("X-custom", "my stuff") ); final HttpCacheEntry newEntry = impl.create(tenSecondsAgo, oneSecondAgo, host, request, response, HttpTestUtils.makeRandomResource(1024)); final Set variants = new HashSet<>(); variants.add("variant1"); variants.add("variant2"); variants.add("variant3"); final HttpCacheEntry newRoot = impl.createRoot(newEntry, variants); MatcherAssert.assertThat(newRoot, HttpCacheEntryMatcher.equivalent( HttpTestUtils.makeCacheEntry( tenSecondsAgo, oneSecondAgo, Method.GET, "http://foo.example.com:80/stuff", new Header[]{ new BasicHeader("X-custom", "my stuff"), new BasicHeader(HttpHeaders.ACCEPT, "stuff"), new BasicHeader(HttpHeaders.ACCEPT_LANGUAGE, "en, de") }, HttpStatus.SC_NOT_MODIFIED, new Header[]{ new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(twoSecondsAgo)), new BasicHeader(HttpHeaders.VARY, "Stuff"), new BasicHeader(HttpHeaders.ETAG, "\"some-etag\""), new BasicHeader("X-custom", "my stuff") }, variants ))); Assertions.assertTrue(newRoot.hasVariants()); Assertions.assertNull(newRoot.getResource()); } @Test void testCreateResourceEntry() { request.setHeaders( new BasicHeader("Keep-Alive", "timeout, max=20"), new BasicHeader("X-custom", "my stuff"), new BasicHeader(HttpHeaders.ACCEPT, "stuff"), new BasicHeader(HttpHeaders.ACCEPT_LANGUAGE, "en, de"), new BasicHeader(HttpHeaders.AUTHORIZATION, "Super secret") ); response.setHeaders( new BasicHeader(HttpHeaders.TRANSFER_ENCODING, "identity"), new BasicHeader(HttpHeaders.CONNECTION, "Keep-Alive, Blah"), new BasicHeader("Blah", "huh?"), new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(twoSecondsAgo)), new BasicHeader(HttpHeaders.ETAG, "\"some-etag\""), new BasicHeader("X-custom", "my stuff") ); final Resource resource = HttpTestUtils.makeRandomResource(128); final HttpCacheEntry newEntry = impl.create(tenSecondsAgo, oneSecondAgo, host, request, response, resource); MatcherAssert.assertThat(newEntry, HttpCacheEntryMatcher.equivalent( HttpTestUtils.makeCacheEntry( tenSecondsAgo, oneSecondAgo, Method.GET, "http://foo.example.com:80/stuff", new Header[]{ new BasicHeader("X-custom", "my stuff"), new BasicHeader(HttpHeaders.ACCEPT, "stuff"), new BasicHeader(HttpHeaders.ACCEPT_LANGUAGE, "en, de") }, HttpStatus.SC_NOT_MODIFIED, new Header[]{ new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(twoSecondsAgo)), new BasicHeader(HttpHeaders.ETAG, "\"some-etag\""), new BasicHeader("X-custom", "my stuff") }, resource ))); Assertions.assertFalse(newEntry.hasVariants()); } @Test void testCreateUpdatedResourceEntry() { final Resource resource = HttpTestUtils.makeRandomResource(128); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry( tenSecondsAgo, twoSecondsAgo, Method.GET, "/stuff", new Header[]{ new BasicHeader("X-custom", "my stuff"), new BasicHeader(HttpHeaders.ACCEPT, "stuff"), new BasicHeader(HttpHeaders.ACCEPT_LANGUAGE, "en, de") }, HttpStatus.SC_NOT_MODIFIED, new Header[]{ new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(twoSecondsAgo)), new BasicHeader(HttpHeaders.ETAG, "\"some-etag\""), new BasicHeader("X-custom", "my stuff"), new BasicHeader("Cache-Control", "max-age=0") }, resource ); response.setHeaders( new BasicHeader(HttpHeaders.ETAG, "\"some-new-etag\""), new BasicHeader("Last-Modified", DateUtils.formatStandardDate(oneSecondAgo)), new BasicHeader("Cache-Control", "public") ); request.setHeaders( new BasicHeader("X-custom", "my other stuff"), new BasicHeader(HttpHeaders.ACCEPT, "stuff, other-stuff"), new BasicHeader(HttpHeaders.ACCEPT_LANGUAGE, "en, de") ); final HttpCacheEntry updatedEntry = impl.createUpdated(tenSecondsAgo, oneSecondAgo, host, request, response, entry); MatcherAssert.assertThat(updatedEntry, HttpCacheEntryMatcher.equivalent( HttpTestUtils.makeCacheEntry( tenSecondsAgo, oneSecondAgo, Method.GET, "http://foo.example.com:80/stuff", new Header[]{ new BasicHeader("X-custom", "my other stuff"), new BasicHeader(HttpHeaders.ACCEPT, "stuff, other-stuff"), new BasicHeader(HttpHeaders.ACCEPT_LANGUAGE, "en, de") }, HttpStatus.SC_NOT_MODIFIED, new Header[]{ new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(twoSecondsAgo)), new BasicHeader("X-custom", "my stuff"), new BasicHeader(HttpHeaders.ETAG, "\"some-new-etag\""), new BasicHeader("Last-Modified", DateUtils.formatStandardDate(oneSecondAgo)), new BasicHeader("Cache-Control", "public") }, resource ))); Assertions.assertFalse(updatedEntry.hasVariants()); } @Test void testUpdateNotModifiedIfResponseOlder() { entry = HttpTestUtils.makeCacheEntry(twoSecondsAgo, now, new BasicHeader("Date", DateUtils.formatStandardDate(oneSecondAgo)), new BasicHeader("ETag", "\"new-etag\"")); response.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); response.setHeader("ETag", "\"old-etag\""); final HttpCacheEntry newEntry = impl.createUpdated(Instant.now(), Instant.now(), host, request, response, entry); Assertions.assertSame(newEntry, entry); } @Test void testUpdateHasLatestRequestAndResponseDates() { entry = HttpTestUtils.makeCacheEntry(tenSecondsAgo, eightSecondsAgo); final HttpCacheEntry updated = impl.createUpdated(twoSecondsAgo, oneSecondAgo, host, request, response, entry); Assertions.assertEquals(twoSecondsAgo, updated.getRequestInstant()); Assertions.assertEquals(oneSecondAgo, updated.getResponseInstant()); } @Test void cannotUpdateFromANon304OriginResponse() { entry = HttpTestUtils.makeCacheEntry(); response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); Assertions.assertThrows(IllegalArgumentException.class, () -> impl.createUpdated(Instant.now(), Instant.now(), host, request, response, entry)); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/cache/ManagedHttpCacheStorageTest.java0100664 0000000 0000000 00000006554 14666635064 031773 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; 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 org.apache.hc.client5.http.impl.cache.CacheConfig; import org.apache.hc.client5.http.impl.cache.HttpTestUtils; import org.apache.hc.client5.http.impl.cache.ManagedHttpCacheStorage; import org.apache.hc.core5.http.HttpStatus; import org.junit.jupiter.api.Test; class ManagedHttpCacheStorageTest { @Test void putEntry() throws ResourceIOException { final CacheConfig cacheConfig = getCacheConfig(); try (final ManagedHttpCacheStorage cacheStorage = new ManagedHttpCacheStorage(cacheConfig)) { final String key = "foo"; final HttpCacheEntry value = HttpTestUtils.makeCacheEntry(); cacheStorage.putEntry(key, value); assertEquals(HttpStatus.SC_OK, cacheStorage.getEntry(key).getStatus()); } } @Test void isActive() throws ResourceIOException { final CacheConfig cacheConfig = getCacheConfig(); final ManagedHttpCacheStorage cacheStorage = new ManagedHttpCacheStorage(cacheConfig); final String key = "foo"; final HttpCacheEntry value = HttpTestUtils.makeCacheEntry(); cacheStorage.putEntry(key, value); assertTrue(cacheStorage.isActive()); cacheStorage.close(); assertFalse(cacheStorage.isActive()); } @Test void cacheDisableThrowsIllegalStateException() { final CacheConfig cacheConfig = getCacheConfig(); final ManagedHttpCacheStorage cacheStorage = new ManagedHttpCacheStorage(cacheConfig); final String key = "foo"; final HttpCacheEntry value = HttpTestUtils.makeCacheEntry(); cacheStorage.close(); assertFalse(cacheStorage.isActive()); assertThrows(IllegalStateException.class, () -> cacheStorage.putEntry(key, value)); } private CacheConfig getCacheConfig() { return CacheConfig.custom() .setSharedCache(true) .setMaxObjectSize(262144) //256kb .build(); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/cache/example/0040775 0000000 0000000 00000000000 14704162040 025225 5ustar000000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/cache/example/ClientCacheControl.java0100664 0000000 0000000 00000016554 14704162040 031603 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache.example; import org.apache.hc.client5.http.cache.CacheContextBuilder; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.client5.http.impl.cache.CacheConfig; import org.apache.hc.client5.http.impl.cache.CachingHttpClients; import org.apache.hc.client5.http.impl.cache.HeapResourceFactory; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.message.StatusLine; /** * This is an example demonstrating how to control execution of cache * operation and determine its outcome using the classic HTTP cache API. */ public class ClientCacheControl { public static void main(final String[] args) throws Exception { final HttpHost target = new HttpHost("https", "www.apache.org"); try (final CloseableHttpClient httpclient = CachingHttpClients.custom() .setCacheConfig(CacheConfig.custom() .setMaxObjectSize(200000) .setHeuristicCachingEnabled(true) .build()) .setResourceFactory(HeapResourceFactory.INSTANCE) .build()) { final ClassicHttpRequest httpget1 = ClassicRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); // Use default cache control final HttpCacheContext context = CacheContextBuilder.create() .setCacheControl(RequestCacheControl.DEFAULT) .build(); System.out.println("Executing request " + httpget1.getMethod() + " " + httpget1.getUri()); httpclient.execute(httpget1, context, response -> { System.out.println("----------------------------------------"); System.out.println(httpget1 + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); System.out.println("Cache status: " + context.getCacheResponseStatus()); System.out.println("Request cache control: " + context.getRequestCacheControlOrDefault()); System.out.println("Response cache control: " + context.getResponseCacheControlOrDefault()); final HttpCacheEntry cacheEntry = context.getCacheEntry(); if (cacheEntry != null) { System.out.println("Cache entry resource: " + cacheEntry.getResource()); System.out.println("Date: " + cacheEntry.getInstant()); System.out.println("Expires: " + cacheEntry.getExpires()); System.out.println("Last modified: " + cacheEntry.getLastModified()); } return null; }); final ClassicHttpRequest httpget2 = ClassicRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); // Ensure a custom freshness for the cache entry context.setRequestCacheControl(RequestCacheControl.builder() .setMinFresh(100) .build()); System.out.println("Executing request " + httpget2.getMethod() + " " + httpget2.getUri()); httpclient.execute(httpget2, context, response -> { System.out.println("----------------------------------------"); System.out.println(httpget2 + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); System.out.println("Cache status: " + context.getCacheResponseStatus()); System.out.println("Request cache control: " + context.getRequestCacheControlOrDefault()); System.out.println("Response cache control: " + context.getResponseCacheControlOrDefault()); final HttpCacheEntry cacheEntry = context.getCacheEntry(); if (cacheEntry != null) { System.out.println("Cache entry resource: " + cacheEntry.getResource()); System.out.println("Date: " + cacheEntry.getInstant()); System.out.println("Expires: " + cacheEntry.getExpires()); System.out.println("Last modified: " + cacheEntry.getLastModified()); } return null; }); Thread.sleep(2000); final ClassicHttpRequest httpget3 = ClassicRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); // Try to force cache entry re-validation context.setRequestCacheControl(RequestCacheControl.builder() .setMaxAge(0) .build()); System.out.println("Executing request " + httpget3.getMethod() + " " + httpget3.getUri()); httpclient.execute(httpget3, context, response -> { System.out.println("----------------------------------------"); System.out.println(httpget3 + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); System.out.println("Cache status: " + context.getCacheResponseStatus()); System.out.println("Request cache control: " + context.getRequestCacheControlOrDefault()); System.out.println("Response cache control: " + context.getResponseCacheControlOrDefault()); final HttpCacheEntry cacheEntry = context.getCacheEntry(); if (cacheEntry != null) { System.out.println("Cache entry resource: " + cacheEntry.getResource()); System.out.println("Date: " + cacheEntry.getInstant()); System.out.println("Expires: " + cacheEntry.getExpires()); System.out.println("Last modified: " + cacheEntry.getLastModified()); } return null; }); } } } ././@LongLink0100644 0000000 0000000 00000000146 14704162040 011632 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/cache/example/AsyncClientCacheControl.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/cache/example/AsyncClientCacheControl.jav0100664 0000000 0000000 00000023652 14704162040 032435 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache.example; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.cache.CacheContextBuilder; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.cache.CacheConfig; import org.apache.hc.client5.http.impl.cache.CachingHttpAsyncClients; import org.apache.hc.client5.http.impl.cache.HeapResourceFactory; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.io.CloseMode; /** * This is an example demonstrating how to control execution of cache * operation and determine its outcome using the async HTTP cache API. */ public class AsyncClientCacheControl { public static void main(final String[] args) throws Exception { final HttpHost target = new HttpHost("https", "www.apache.org"); try (final CloseableHttpAsyncClient httpclient = CachingHttpAsyncClients.custom() .setCacheConfig(CacheConfig.custom() .setMaxObjectSize(200000) .setHeuristicCachingEnabled(true) .build()) .setResourceFactory(HeapResourceFactory.INSTANCE) .build()) { httpclient.start(); final SimpleHttpRequest httpget1 = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); // Use default cache control final HttpCacheContext context = CacheContextBuilder.create() .setCacheControl(RequestCacheControl.DEFAULT) .build(); System.out.println("Executing request " + httpget1.getMethod() + " " + httpget1.getUri()); final Future future = httpclient.execute( SimpleRequestProducer.create(httpget1), SimpleResponseConsumer.create(), context, new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(httpget1 + "->" + new StatusLine(response)); System.out.println("Cache status: " + context.getCacheResponseStatus()); System.out.println("Request cache control: " + context.getRequestCacheControlOrDefault()); System.out.println("Response cache control: " + context.getResponseCacheControlOrDefault()); final HttpCacheEntry cacheEntry = context.getCacheEntry(); if (cacheEntry != null) { System.out.println("Cache entry resource: " + cacheEntry.getResource()); System.out.println("Date: " + cacheEntry.getInstant()); System.out.println("Expires: " + cacheEntry.getExpires()); System.out.println("Last modified: " + cacheEntry.getLastModified()); } } @Override public void failed(final Exception ex) { System.out.println(httpget1 + "->" + ex); } @Override public void cancelled() { System.out.println(httpget1 + " cancelled"); } }); future.get(); final SimpleHttpRequest httpget2 = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); // Ensure a custom freshness for the cache entry context.setRequestCacheControl(RequestCacheControl.builder() .setMinFresh(100) .build()); System.out.println("Executing request " + httpget2.getMethod() + " " + httpget2.getUri()); final Future future2 = httpclient.execute( SimpleRequestProducer.create(httpget2), SimpleResponseConsumer.create(), context, new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(httpget2 + "->" + new StatusLine(response)); System.out.println("Cache status: " + context.getCacheResponseStatus()); System.out.println("Request cache control: " + context.getRequestCacheControlOrDefault()); System.out.println("Response cache control: " + context.getResponseCacheControlOrDefault()); final HttpCacheEntry cacheEntry = context.getCacheEntry(); if (cacheEntry != null) { System.out.println("Cache entry resource: " + cacheEntry.getResource()); System.out.println("Date: " + cacheEntry.getInstant()); System.out.println("Expires: " + cacheEntry.getExpires()); System.out.println("Last modified: " + cacheEntry.getLastModified()); } } @Override public void failed(final Exception ex) { System.out.println(httpget2 + "->" + ex); } @Override public void cancelled() { System.out.println(httpget2 + " cancelled"); } }); future2.get(); Thread.sleep(2000); final SimpleHttpRequest httpget3 = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); // Try to force cache entry re-validation context.setRequestCacheControl(RequestCacheControl.builder() .setMaxAge(0) .build()); System.out.println("Executing request " + httpget3.getMethod() + " " + httpget3.getUri()); final Future future3 = httpclient.execute( SimpleRequestProducer.create(httpget3), SimpleResponseConsumer.create(), context, new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(httpget3 + "->" + new StatusLine(response)); System.out.println("Cache status: " + context.getCacheResponseStatus()); System.out.println("Request cache control: " + context.getRequestCacheControlOrDefault()); System.out.println("Response cache control: " + context.getResponseCacheControlOrDefault()); final HttpCacheEntry cacheEntry = context.getCacheEntry(); if (cacheEntry != null) { System.out.println("Cache entry resource: " + cacheEntry.getResource()); System.out.println("Date: " + cacheEntry.getInstant()); System.out.println("Expires: " + cacheEntry.getExpires()); System.out.println("Last modified: " + cacheEntry.getLastModified()); } } @Override public void failed(final Exception ex) { System.out.println(httpget3 + "->" + ex); } @Override public void cancelled() { System.out.println(httpget3 + " cancelled"); } }); future3.get(); httpclient.close(CloseMode.GRACEFUL); } } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/cache/TestHttpCacheEntry.java0100664 0000000 0000000 00000027766 15005672016 030205 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cache; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNotEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertSame; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.Mockito.mock; import java.time.Instant; import java.time.LocalDate; import java.time.Month; import java.time.ZoneId; import java.time.temporal.ChronoField; import java.util.Collection; import java.util.HashSet; import java.util.Set; import org.apache.hc.client5.http.impl.cache.HttpTestUtils; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.HeaderGroup; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestHttpCacheEntry { private Instant now; private Instant elevenSecondsAgo; private Instant nineSecondsAgo; private Resource mockResource; private HttpCacheEntry entry; @BeforeEach void setUp() { now = Instant.now(); elevenSecondsAgo = now.minusSeconds(11); nineSecondsAgo = now.minusSeconds(9); mockResource = mock(Resource.class); } private HttpCacheEntry makeEntry(final Header... headers) { return new HttpCacheEntry(elevenSecondsAgo, nineSecondsAgo, "GET", "/", HttpTestUtils.headers(), HttpStatus.SC_OK, HttpTestUtils.headers(headers), mockResource, null); } private HttpCacheEntry makeEntry(final Instant requestDate, final Instant responseDate, final int status, final Header[] headers, final Resource resource, final Collection variants) { return new HttpCacheEntry(requestDate, responseDate, "GET", "/", HttpTestUtils.headers(), status, HttpTestUtils.headers(headers), resource, variants); } private HttpCacheEntry makeEntry(final Instant requestDate, final Instant responseDate, final int status, final Header... headers) { return new HttpCacheEntry(requestDate, responseDate, "GET", "/", HttpTestUtils.headers(), status, HttpTestUtils.headers(headers), mockResource, null); } @Test void testGetHeadersReturnsCorrectHeaders() { entry = makeEntry( new BasicHeader("bar", "barValue1"), new BasicHeader("bar", "barValue2")); assertEquals(2, entry.getHeaders("bar").length); } @Test void testGetFirstHeaderReturnsCorrectHeader() { entry = makeEntry( new BasicHeader("bar", "barValue1"), new BasicHeader("bar", "barValue2")); assertEquals("barValue1", entry.getFirstHeader("bar").getValue()); } @Test void testGetHeadersReturnsEmptyArrayIfNoneMatch() { entry = makeEntry( new BasicHeader("foo", "fooValue"), new BasicHeader("bar", "barValue1"), new BasicHeader("bar", "barValue2")); assertEquals(0, entry.getHeaders("baz").length); } @Test void testGetFirstHeaderReturnsNullIfNoneMatch() { entry = makeEntry( new BasicHeader("foo", "fooValue"), new BasicHeader("bar", "barValue1"), new BasicHeader("bar", "barValue2")); assertNull(entry.getFirstHeader("quux")); } @Test void testGetMethodReturnsCorrectRequestMethod() { entry = makeEntry( new BasicHeader("foo", "fooValue"), new BasicHeader("bar", "barValue1"), new BasicHeader("bar", "barValue2")); assertEquals(Method.GET.name(), entry.getRequestMethod()); } @Test void statusCodeComesFromOriginalStatusLine() { entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK); assertEquals(HttpStatus.SC_OK, entry.getStatus()); } @Test void canGetOriginalRequestDate() { final Instant requestDate = Instant.now(); entry = makeEntry(requestDate, Instant.now(), HttpStatus.SC_OK); assertEquals(requestDate, entry.getRequestInstant()); } @Test void canGetOriginalResponseDate() { final Instant responseDate = Instant.now(); entry = makeEntry(Instant.now(), responseDate, HttpStatus.SC_OK); assertEquals(responseDate, entry.getResponseInstant()); } @Test void canGetOriginalResource() { entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK); assertSame(mockResource, entry.getResource()); } @Test void canGetOriginalHeaders() { final Header[] headers = { new BasicHeader("Server", "MockServer/1.0"), new BasicHeader("Date", DateUtils.formatStandardDate(now)) }; entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK, headers, mockResource, null); final Header[] result = entry.getHeaders(); assertEquals(headers.length, result.length); for (int i = 0; i < headers.length; i++) { assertEquals(headers[i], result[i]); } } @Test void canRetrieveOriginalVariantMap() { final Set variants = new HashSet<>(); variants.add("A"); variants.add("B"); variants.add("C"); entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK, new Header[]{}, mockResource, variants); final Set result = entry.getVariants(); assertEquals(3, result.size()); assertTrue(result.contains("A")); assertTrue(result.contains("B")); assertTrue(result.contains("C")); assertFalse(result.contains("D")); } @Test void retrievedVariantMapIsNotModifiable() { final Set variants = new HashSet<>(); variants.add("A"); variants.add("B"); variants.add("C"); entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK, new Header[]{}, mockResource, variants); final Set result = entry.getVariants(); Assertions.assertThrows(UnsupportedOperationException.class, () -> result.remove("A")); Assertions.assertThrows(UnsupportedOperationException.class, () -> result.add("D")); } @Test void canConvertToString() { entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK); assertNotNull(entry.toString()); assertNotEquals("", entry.toString()); } @Test void testMissingDateHeaderIsIgnored() { entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK); assertNull(entry.getInstant()); } @Test void testMalformedDateHeaderIsIgnored() { entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK, new BasicHeader("Date", "asdf")); assertNull(entry.getInstant()); } @Test void testValidDateHeaderIsParsed() { final Instant date = Instant.now().with(ChronoField.MILLI_OF_SECOND, 0); entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK, new BasicHeader("Date", DateUtils.formatStandardDate(date))); final Instant dateHeaderValue = entry.getInstant(); assertNotNull(dateHeaderValue); assertEquals(date, dateHeaderValue); } @Test void testEpochDateHeaderIsParsed() { entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK, new BasicHeader("Date", DateUtils.formatStandardDate(Instant.EPOCH))); final Instant dateHeaderValue = entry.getInstant(); assertNotNull(dateHeaderValue); assertEquals(Instant.EPOCH, dateHeaderValue); } @Test void testDateParsedOnce() { final Instant date = Instant.now().with(ChronoField.MILLI_OF_SECOND, 0); entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK, new BasicHeader("Date", DateUtils.formatStandardDate(date))); final Instant dateHeaderValue = entry.getInstant(); assertNotNull(dateHeaderValue); assertSame(dateHeaderValue, entry.getInstant()); assertSame(dateHeaderValue, entry.getInstant()); } @Test void testExpiresParsedOnce() { final Instant date = Instant.now().with(ChronoField.MILLI_OF_SECOND, 0); entry = makeEntry(Instant.now(), Instant.now(), HttpStatus.SC_OK, new BasicHeader("Last-Modified", DateUtils.formatStandardDate(date))); final Instant lastModifiedHeaderValue = entry.getLastModified(); assertNotNull(lastModifiedHeaderValue); assertSame(lastModifiedHeaderValue, entry.getLastModified()); assertSame(lastModifiedHeaderValue, entry.getLastModified()); } private static Instant createInstant(final int year, final Month month, final int day) { return LocalDate.of(year, month, day).atStartOfDay(ZoneId.of("GMT")).toInstant(); } @Test void testIsCacheEntryNewer() { assertFalse(HttpCacheEntry.isNewer(null, null)); entry = makeEntry(); final HeaderGroup message = new HeaderGroup(); assertFalse(HttpCacheEntry.isNewer(entry, message)); entry = makeEntry(new BasicHeader(HttpHeaders.DATE, "huh?")); message.setHeader(new BasicHeader(HttpHeaders.DATE, "eh?")); assertFalse(HttpCacheEntry.isNewer(entry, message)); entry = makeEntry(new BasicHeader(HttpHeaders.DATE, "huh?")); message.setHeader(new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(createInstant(2017, Month.DECEMBER, 26)))); assertFalse(HttpCacheEntry.isNewer(entry, message)); entry = makeEntry(new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(createInstant(2017, Month.DECEMBER, 27)))); message.setHeader(new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(createInstant(2017, Month.DECEMBER, 26)))); assertTrue(HttpCacheEntry.isNewer(entry, message)); entry = makeEntry(new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(createInstant(2017, Month.DECEMBER, 25)))); message.setHeader(new BasicHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(createInstant(2017, Month.DECEMBER, 26)))); assertFalse(HttpCacheEntry.isNewer(entry, message)); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/schedule/0040775 0000000 0000000 00000000000 14704162040 024323 5ustar000000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/schedule/TestConcurrentCountMap.java0100664 0000000 0000000 00000003447 14704162040 031624 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.schedule; import static org.hamcrest.MatcherAssert.assertThat; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Test; class TestConcurrentCountMap { private static final String IDENTIFIER = "some-identifier"; private final ConcurrentCountMap map = new ConcurrentCountMap<>(); @Test void testBasics() { map.increaseCount(IDENTIFIER); map.increaseCount(IDENTIFIER); assertThat(map.getCount(IDENTIFIER), CoreMatchers.equalTo(2)); map.resetCount(IDENTIFIER); assertThat(map.getCount(IDENTIFIER), CoreMatchers.equalTo(0)); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/0040775 0000000 0000000 00000000000 14666635064 023512 5ustar000000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/0040775 0000000 0000000 00000000000 15005672016 024537 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000146 14704162040 011632 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCacheableRequestPolicy.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCacheableRequestPolicy.jav0100664 0000000 0000000 00000010441 14704162040 032452 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestCacheableRequestPolicy { private CacheableRequestPolicy policy; @BeforeEach void setUp() { policy = new CacheableRequestPolicy(); } @Test void testIsGetServableFromCache() { final BasicHttpRequest request = new BasicHttpRequest("GET", "someUri"); final RequestCacheControl cacheControl = RequestCacheControl.builder().build(); Assertions.assertTrue(policy.canBeServedFromCache(cacheControl, request)); } @Test void testIsGetWithCacheControlServableFromCache() { final BasicHttpRequest request = new BasicHttpRequest("GET", "someUri"); final RequestCacheControl cacheControl = RequestCacheControl.builder() .setNoCache(true) .build(); Assertions.assertFalse(policy.canBeServedFromCache(cacheControl, request)); final RequestCacheControl cacheControl2 = RequestCacheControl.builder() .setNoStore(true) .setMaxAge(20) .build(); Assertions.assertFalse(policy.canBeServedFromCache(cacheControl2, request)); } @Test void testIsHeadServableFromCache() { final BasicHttpRequest request = new BasicHttpRequest("HEAD", "someUri"); final RequestCacheControl cacheControl = RequestCacheControl.builder().build(); Assertions.assertTrue(policy.canBeServedFromCache(cacheControl, request)); final RequestCacheControl cacheControl2 = RequestCacheControl.builder() .setMaxAge(20) .build(); Assertions.assertTrue(policy.canBeServedFromCache(cacheControl2, request)); } @Test void testIsHeadWithCacheControlServableFromCache() { final BasicHttpRequest request = new BasicHttpRequest("HEAD", "someUri"); final RequestCacheControl cacheControl = RequestCacheControl.builder() .setNoCache(true) .build(); Assertions.assertFalse(policy.canBeServedFromCache(cacheControl, request)); request.addHeader("Cache-Control", "no-store"); request.addHeader("Cache-Control", "max-age=20"); final RequestCacheControl cacheControl2 = RequestCacheControl.builder() .setNoStore(true) .setMaxAge(20) .build(); Assertions.assertFalse(policy.canBeServedFromCache(cacheControl2, request)); } @Test void testIsArbitraryMethodServableFromCache() { final BasicHttpRequest request = new BasicHttpRequest("TRACE", "someUri"); final RequestCacheControl cacheControl = RequestCacheControl.builder() .build(); Assertions.assertFalse(policy.canBeServedFromCache(cacheControl, request)); final BasicHttpRequest request2 = new BasicHttpRequest("huh", "someUri"); Assertions.assertFalse(policy.canBeServedFromCache(cacheControl, request2)); } } ././@LongLink0100644 0000000 0000000 00000000161 15005672016 011633 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestHttpByteArrayCacheEntrySerializer.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestHttpByteArrayCacheEntrySer0100664 0000000 0000000 00000053464 15005672016 032515 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.IOException; import java.io.InputStream; import java.net.URL; import java.nio.charset.StandardCharsets; import java.time.Instant; import java.util.HashSet; import java.util.Set; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheEntrySerializer; import org.apache.hc.client5.http.cache.HttpCacheStorageEntry; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.util.ByteArrayBuffer; import org.hamcrest.MatcherAssert; import org.hamcrest.Matchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestHttpByteArrayCacheEntrySerializer { private HttpCacheEntrySerializer httpCacheEntrySerializer; @BeforeEach void before() { httpCacheEntrySerializer = HttpByteArrayCacheEntrySerializer.INSTANCE; } @Test void testSimpleSerializeAndDeserialize() throws Exception { final String content = "Hello World"; final ContentType contentType = ContentType.TEXT_PLAIN.withCharset(StandardCharsets.UTF_8); final HttpCacheEntry cacheEntry = new HttpCacheEntry(Instant.now(), Instant.now(), "GET", "/stuff", HttpTestUtils.headers(), HttpStatus.SC_OK, HttpTestUtils.headers(new BasicHeader(HttpHeaders.CONTENT_TYPE, contentType.toString())), new HeapResource(content.getBytes(contentType.getCharset())), null); final HttpCacheStorageEntry storageEntry = new HttpCacheStorageEntry("unique-cache-key", cacheEntry); final byte[] serialized = httpCacheEntrySerializer.serialize(storageEntry); final HttpCacheStorageEntry deserialized = httpCacheEntrySerializer.deserialize(serialized); MatcherAssert.assertThat(deserialized.getKey(), Matchers.equalTo(storageEntry.getKey())); MatcherAssert.assertThat(deserialized.getContent(), HttpCacheEntryMatcher.equivalent(storageEntry.getContent())); } @Test void testSerializeAndDeserializeLargeContent() throws Exception { final ContentType contentType = ContentType.IMAGE_JPEG; final HeapResource resource = load(getClass().getResource("/ApacheLogo.png")); final HttpCacheEntry cacheEntry = new HttpCacheEntry(Instant.now(), Instant.now(), "GET", "/stuff", HttpTestUtils.headers(), HttpStatus.SC_OK, HttpTestUtils.headers(new BasicHeader(HttpHeaders.CONTENT_TYPE, contentType.toString())), resource, null); final HttpCacheStorageEntry storageEntry = new HttpCacheStorageEntry("unique-cache-key", cacheEntry); final byte[] serialized = httpCacheEntrySerializer.serialize(storageEntry); final HttpCacheStorageEntry deserialized = httpCacheEntrySerializer.deserialize(serialized); MatcherAssert.assertThat(deserialized.getKey(), Matchers.equalTo(storageEntry.getKey())); MatcherAssert.assertThat(deserialized.getContent(), HttpCacheEntryMatcher.equivalent(storageEntry.getContent())); } /** * Deserialize a cache entry in a bad format, expecting an exception. */ @Test void testInvalidCacheEntry() throws Exception { // This file is a JPEG not a cache entry, so should fail to deserialize final HeapResource resource = load(getClass().getResource("/ApacheLogo.png")); Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(resource.get())); } /** * Deserialize truncated cache entries. */ @Test void testTruncatedCacheEntry() { final String content1 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Resource-Length: 11\n" + "HC-Request-Instant: 1686210849596\n" + "HC-Response-Instant: 1686210849596\n" + "\n" + "GET /stuff HTTP/1.1\n" + "\n" + "HTTP/1.1 200 \n" + "Content-Type: text/plain; charset=UTF-8\n" + "Cache-control: public, max-age=31536000\n" + "\n" + "Huh?"; final byte[] bytes1 = content1.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception1 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes1)); Assertions.assertEquals("Unexpected end of cache content", exception1.getMessage()); final String content2 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Resource-Length: 11\n" + "HC-Request-Instant: 1686210849596\n" + "HC-Response-Instant: 1686210849596\n" + "\n" + "GET /stuff HTTP/1.1\n" + "\n" + "HTTP/1.1 200 \n" + "Content-Type: text/plain; charset=UTF-8\n" + "Cache-control: public, max-age=31536000\n"; final byte[] bytes2 = content2.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception2 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes2)); Assertions.assertEquals("Unexpected end of stream", exception2.getMessage()); final String content3 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Resource-Length: 11\n" + "HC-Request-Instant: 1686210849596\n" + "HC-Response-Instant: 1686210849596\n" + "\n" + "GET /stuff HTTP/1.1\n" + "\n"; final byte[] bytes3 = content3.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception3 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes3)); Assertions.assertEquals("Unexpected end of stream", exception3.getMessage()); final String content4 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Resource-Length: 11\n" + "HC-Request-Instant: 1686210849596\n" + "HC-Response-Instant: 1686210849596\n"; final byte[] bytes4 = content4.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception4 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes4)); Assertions.assertEquals("Unexpected end of stream", exception4.getMessage()); final String content5 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n"; final byte[] bytes5 = content5.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception5 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes5)); Assertions.assertEquals("Unexpected end of stream", exception5.getMessage()); final String content6 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n"; final byte[] bytes6 = content6.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception6 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes6)); Assertions.assertEquals("Unexpected end of stream", exception6.getMessage()); final String content7 = "HttpClient CacheEntry 1\n"; final byte[] bytes7 = content7.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception7 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes7)); Assertions.assertEquals("Unexpected cache entry version line", exception7.getMessage()); } /** * Deserialize cache entries with a missing mandatory header. */ @Test void testMissingHeaderCacheEntry() { final String content1 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Resource-Length: 11\n" + "HC-Response-Instant: 1686210849596\n" + "\n" + "GET /stuff HTTP/1.1\n" + "\n" + "HTTP/1.1 200 \n" + "Content-Type: text/plain; charset=UTF-8\n" + "Cache-control: public, max-age=31536000\n" + "\n" + "Hello World"; final byte[] bytes1 = content1.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception1 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes1)); Assertions.assertEquals("Invalid cache header format", exception1.getMessage()); final String content2 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Resource-Length: 11\n" + "HC-Request-Instant: 1686210849596\n" + "\n" + "GET /stuff HTTP/1.1\n" + "\n" + "HTTP/1.1 200 \n" + "Content-Type: text/plain; charset=UTF-8\n" + "Cache-control: public, max-age=31536000\n" + "\n" + "Hello World"; final byte[] bytes2 = content2.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception2 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes2)); Assertions.assertEquals("Invalid cache header format", exception2.getMessage()); } /** * Deserialize cache entries with an invalid header value. */ @Test void testInvalidHeaderCacheEntry() { final String content1 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Resource-Length: 11\n" + "HC-Request-Instant: boom\n" + "HC-Response-Instant: 1686210849596\n" + "\n" + "GET /stuff HTTP/1.1\n" + "\n" + "HTTP/1.1 200 \n" + "Content-Type: text/plain; charset=UTF-8\n" + "Cache-control: public, max-age=31536000\n" + "\n" + "Hello World"; final byte[] bytes1 = content1.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception1 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes1)); Assertions.assertEquals("Invalid cache header format", exception1.getMessage()); final String content2 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Resource-Length: 11\n" + "HC-Request-Instant: 1686210849596\n" + "HC-Response-Instant: boom\n" + "\n" + "GET /stuff HTTP/1.1\n" + "\n" + "HTTP/1.1 200 \n" + "Content-Type: text/plain; charset=UTF-8\n" + "Cache-control: public, max-age=31536000\n" + "\n" + "Hello World"; final byte[] bytes2 = content2.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception2 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes2)); Assertions.assertEquals("Invalid cache header format", exception2.getMessage()); } /** * Deserialize cache entries with an invalid request line. */ @Test void testInvalidRequestLineCacheEntry() { final String content1 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Resource-Length: 11\n" + "HC-Request-Instant: 1686210849596\n" + "HC-Response-Instant: 1686210849596\n" + "\n" + "GET boom\n" + "\n" + "HTTP/1.1 200 \n" + "Content-Type: text/plain; charset=UTF-8\n" + "Cache-control: public, max-age=31536000\n" + "\n" + "Hello World"; final byte[] bytes1 = content1.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception1 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes1)); Assertions.assertEquals("Invalid cache header format", exception1.getMessage()); } /** * Deserialize cache entries with an invalid request line. */ @Test void testInvalidStatusLineCacheEntry() { final String content1 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Resource-Length: 11\n" + "HC-Request-Instant: 1686210849596\n" + "HC-Response-Instant: 1686210849596\n" + "\n" + "GET /stuff HTTP/1.1\n" + "\n" + "HTTP/1.1 boom \n" + "Content-Type: text/plain; charset=UTF-8\n" + "Cache-control: public, max-age=31536000\n" + "\n" + "Hello World"; final byte[] bytes1 = content1.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception1 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes1)); Assertions.assertEquals("Invalid cache header format", exception1.getMessage()); } /** * Serialize and deserialize a cache entry with no headers. */ @Test void noHeadersTest() throws Exception { final String content = "Hello World"; final ContentType contentType = ContentType.TEXT_PLAIN.withCharset(StandardCharsets.UTF_8); final HttpCacheEntry cacheEntry = new HttpCacheEntry(Instant.now(), Instant.now(), "GET", "/stuff", HttpTestUtils.headers(), HttpStatus.SC_OK, HttpTestUtils.headers(), new HeapResource(content.getBytes(contentType.getCharset())), null); final HttpCacheStorageEntry storageEntry = new HttpCacheStorageEntry("unique-cache-key", cacheEntry); final byte[] serialized = httpCacheEntrySerializer.serialize(storageEntry); final HttpCacheStorageEntry deserialized = httpCacheEntrySerializer.deserialize(serialized); MatcherAssert.assertThat(deserialized.getKey(), Matchers.equalTo(storageEntry.getKey())); MatcherAssert.assertThat(deserialized.getContent(), HttpCacheEntryMatcher.equivalent(storageEntry.getContent())); } /** * Serialize and deserialize a cache entry with an empty body. */ @Test void emptyBodyTest() throws Exception { final HttpCacheEntry cacheEntry = new HttpCacheEntry(Instant.now(), Instant.now(), "GET", "/stuff", HttpTestUtils.headers(), HttpStatus.SC_OK, HttpTestUtils.headers(), new HeapResource(new byte[] {}), null); final HttpCacheStorageEntry storageEntry = new HttpCacheStorageEntry("unique-cache-key", cacheEntry); final byte[] serialized = httpCacheEntrySerializer.serialize(storageEntry); final HttpCacheStorageEntry deserialized = httpCacheEntrySerializer.deserialize(serialized); MatcherAssert.assertThat(deserialized.getKey(), Matchers.equalTo(storageEntry.getKey())); MatcherAssert.assertThat(deserialized.getContent(), HttpCacheEntryMatcher.equivalent(storageEntry.getContent())); } /** * Serialize and deserialize a cache entry with no body. */ @Test void noBodyTest() throws Exception { final HttpCacheEntry cacheEntry = new HttpCacheEntry(Instant.now(), Instant.now(), "GET", "/stuff", HttpTestUtils.headers(), HttpStatus.SC_OK, HttpTestUtils.headers(), null, null); final HttpCacheStorageEntry storageEntry = new HttpCacheStorageEntry("unique-cache-key", cacheEntry); final byte[] serialized = httpCacheEntrySerializer.serialize(storageEntry); final HttpCacheStorageEntry deserialized = httpCacheEntrySerializer.deserialize(serialized); MatcherAssert.assertThat(deserialized.getKey(), Matchers.equalTo(storageEntry.getKey())); MatcherAssert.assertThat(deserialized.getContent(), HttpCacheEntryMatcher.equivalent(storageEntry.getContent())); } /** * Serialize and deserialize a cache entry with a variant map. */ @Test void testSimpleVariantMap() throws Exception { final String content = "Hello World"; final ContentType contentType = ContentType.TEXT_PLAIN.withCharset(StandardCharsets.UTF_8); final Set variants = new HashSet<>(); variants.add("{Accept-Encoding=gzip}"); variants.add("{Accept-Encoding=compress}"); final HttpCacheEntry cacheEntry = new HttpCacheEntry(Instant.now(), Instant.now(), "GET", "/stuff", HttpTestUtils.headers(), HttpStatus.SC_OK, HttpTestUtils.headers(new BasicHeader(HttpHeaders.CONTENT_TYPE, contentType.toString())), new HeapResource(content.getBytes(contentType.getCharset())), variants); final HttpCacheStorageEntry storageEntry = new HttpCacheStorageEntry("unique-cache-key", cacheEntry); final byte[] serialized = httpCacheEntrySerializer.serialize(storageEntry); final HttpCacheStorageEntry deserialized = httpCacheEntrySerializer.deserialize(serialized); MatcherAssert.assertThat(deserialized.getKey(), Matchers.equalTo(storageEntry.getKey())); MatcherAssert.assertThat(deserialized.getContent(), HttpCacheEntryMatcher.equivalent(storageEntry.getContent())); } /** * Deserialize cache entries with trailing garbage. */ @Test void testDeserializeCacheEntryWithTrailingGarbage() { final String content1 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Resource-Length: 11\n" + "HC-Request-Instant: 1686210849596\n" + "HC-Response-Instant: 1686210849596\n" + "\n" + "GET /stuff HTTP/1.1\n" + "\n" + "HTTP/1.1 200 \n" + "Content-Type: text/plain; charset=UTF-8\n" + "Cache-control: public, max-age=31536000\n" + "\n" + "Hello World..... Rubbish"; final byte[] bytes1 = content1.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception1 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes1)); Assertions.assertEquals("Unexpected content at the end of cache content", exception1.getMessage()); final String content2 = HttpByteArrayCacheEntrySerializer.HC_CACHE_VERSION_LINE + "\n" + "HC-Key: unique-cache-key\n" + "HC-Request-Instant: 1686210849596\n" + "HC-Response-Instant: 1686210849596\n" + "\n" + "GET /stuff HTTP/1.1\n" + "\n" + "HTTP/1.1 200 \n" + "Content-Type: text/plain; charset=UTF-8\n" + "Cache-control: public, max-age=31536000\n" + "\n" + "Rubbish"; final byte[] bytes2 = content2.getBytes(StandardCharsets.UTF_8); final ResourceIOException exception2 = Assertions.assertThrows(ResourceIOException.class, () -> httpCacheEntrySerializer.deserialize(bytes2)); Assertions.assertEquals("Unexpected content at the end of cache content", exception2.getMessage()); } static HeapResource load(final URL resource) throws IOException { try (final InputStream in = resource.openStream()) { final ByteArrayBuffer buf = new ByteArrayBuffer(1024); final byte[] tmp = new byte[2048]; int len; while ((len = in.read(tmp)) != -1) { buf.append(tmp, 0, len); } return new HeapResource(buf.toByteArray()); } } } ././@LongLink0100644 0000000 0000000 00000000145 14740035240 011632 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestResponseCachingPolicy.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestResponseCachingPolicy.java0100664 0000000 0000000 00000126503 14740035240 032476 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertTrue; import java.time.Duration; import java.time.Instant; import java.time.temporal.ChronoUnit; import java.util.Random; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.client5.http.classic.methods.HttpOptions; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestResponseCachingPolicy { private ResponseCachingPolicy policy; private HttpResponse response; private HttpRequest request; private final int[] acceptableCodes = new int[] { HttpStatus.SC_OK, HttpStatus.SC_NON_AUTHORITATIVE_INFORMATION, HttpStatus.SC_MULTIPLE_CHOICES, HttpStatus.SC_MOVED_PERMANENTLY, HttpStatus.SC_GONE }; private Instant now; private Instant tenSecondsFromNow; private Instant sixSecondsAgo; private ResponseCacheControl responseCacheControl; @BeforeEach void setUp() { now = Instant.now(); sixSecondsAgo = now.minusSeconds(6); tenSecondsFromNow = now.plusSeconds(10); policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("GET","/"); response = new BasicHttpResponse(HttpStatus.SC_OK, ""); response.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); response.setHeader("Content-Length", "0"); responseCacheControl = ResponseCacheControl.builder().build(); } @Test void testGetCacheable() { policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest(Method.GET, "/"); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testHeadCacheable() { policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest(Method.HEAD, "/"); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testArbitraryMethodNotCacheable() { request = new BasicHttpRequest("PUT", "/"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); request = new BasicHttpRequest("huh", "/"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesToRequestsWithAuthorizationHeadersAreNotCacheableBySharedCache() { request = new BasicHttpRequest("GET","/"); request.setHeader("Authorization", StandardAuthScheme.BASIC + " dXNlcjpwYXNzd2Q="); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesToRequestsWithAuthorizationHeadersAreCacheableByNonSharedCache() { policy = new ResponseCachingPolicy(false, false, false); request = new BasicHttpRequest("GET","/"); request.setHeader("Authorization", StandardAuthScheme.BASIC + " dXNlcjpwYXNzd2Q="); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testAuthorizedResponsesWithSMaxAgeAreCacheable() { request = new BasicHttpRequest("GET","/"); request.setHeader("Authorization", StandardAuthScheme.BASIC + " dXNlcjpwYXNzd2Q="); responseCacheControl = ResponseCacheControl.builder() .setSharedMaxAge(3600) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testAuthorizedResponsesWithCacheControlPublicAreCacheable() { request = new BasicHttpRequest("GET","/"); request.setHeader("Authorization", StandardAuthScheme.BASIC + " dXNlcjpwYXNzd2Q="); responseCacheControl = ResponseCacheControl.builder() .setCachePublic(true) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testAuthorizedResponsesWithCacheControlMaxAgeAreNotCacheable() { request = new BasicHttpRequest("GET","/"); request.setHeader("Authorization", StandardAuthScheme.BASIC + " dXNlcjpwYXNzd2Q="); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(3600) .build(); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void test203ResponseCodeIsCacheable() { response.setCode(HttpStatus.SC_NON_AUTHORITATIVE_INFORMATION); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void test206ResponseCodeIsNotCacheable() { response.setCode(HttpStatus.SC_PARTIAL_CONTENT); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void test300ResponseCodeIsCacheable() { response.setCode(HttpStatus.SC_MULTIPLE_CHOICES); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void test301ResponseCodeIsCacheable() { response.setCode(HttpStatus.SC_MOVED_PERMANENTLY); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void test410ResponseCodeIsCacheable() { response.setCode(HttpStatus.SC_GONE); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testPlain302ResponseCodeIsNotCacheable() { response.setCode(HttpStatus.SC_MOVED_TEMPORARILY); response.removeHeaders("Expires"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testPlain303ResponseCodeIsNotCacheableUnderDefaultBehavior() { response.setCode(HttpStatus.SC_SEE_OTHER); response.removeHeaders("Expires"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testPlain303ResponseCodeIsNotCacheableEvenIf303CachingEnabled() { policy = new ResponseCachingPolicy(true, false, true); response.setCode(HttpStatus.SC_SEE_OTHER); response.removeHeaders("Expires"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testPlain307ResponseCodeIsNotCacheable() { response.setCode(HttpStatus.SC_TEMPORARY_REDIRECT); response.removeHeaders("Expires"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testNon206WithExplicitExpiresIsCacheable() { final int status = getRandomStatus(); response.setCode(status); response.setHeader("Expires", DateUtils.formatStandardDate(Instant.now().plus(1, ChronoUnit.HOURS))); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testNon206WithMaxAgeIsCacheable() { final int status = getRandomStatus(); response.setCode(status); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(0) .build(); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testMissingCacheControlHeader() { final int status = getRandomStatus(); response.setCode(status); response.removeHeaders(HttpHeaders.CACHE_CONTROL); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testNon206WithSMaxAgeIsCacheable() { final int status = getRandomStatus(); response.setCode(status); responseCacheControl = ResponseCacheControl.builder() .setSharedMaxAge(1) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testNon206WithMustRevalidateIsCacheable() { final int status = getRandomStatus(); response.setCode(status); responseCacheControl = ResponseCacheControl.builder() .setMustRevalidate(true) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testNon206WithProxyRevalidateIsCacheable() { final int status = getRandomStatus(); response.setCode(status); responseCacheControl = ResponseCacheControl.builder() .setProxyRevalidate(true) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testNon206WithPublicCacheControlIsCacheable() { final int status = getRandomStatus(); response.setCode(status); responseCacheControl = ResponseCacheControl.builder() .setCachePublic(true) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testNon206WithPrivateCacheControlIsNotCacheableBySharedCache() { final int status = getRandomStatus(); response.setCode(status); responseCacheControl = ResponseCacheControl.builder() .setCachePrivate(true) .build(); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void test200ResponseWithPrivateCacheControlIsCacheableByNonSharedCache() { policy = new ResponseCachingPolicy(false, false, false); response.setCode(HttpStatus.SC_OK); responseCacheControl = ResponseCacheControl.builder() .setCachePrivate(true) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testControlNoCacheCacheable() { responseCacheControl = ResponseCacheControl.builder() .setNoCache(true) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testControlNoStoreNotCacheable() { responseCacheControl = ResponseCacheControl.builder() .setNoStore(true) .build(); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testControlNoStoreEmbeddedInListCacheable() { responseCacheControl = ResponseCacheControl.builder() .setCachePublic(true) .setNoStore(true) .build(); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testControlNoCacheEmbeddedInListCacheable() { responseCacheControl = ResponseCacheControl.builder() .setCachePublic(true) .setNoCache(true) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testControlNoCacheEmbeddedInListAfterFirstHeaderCacheable() { responseCacheControl = ResponseCacheControl.builder() .setMaxAge(20) .setCachePublic(true) .setNoCache(true) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testControlNoStoreEmbeddedInListAfterFirstHeaderCacheable() { responseCacheControl = ResponseCacheControl.builder() .setMaxAge(20) .setCachePublic(true) .setNoStore(true) .build(); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testControlAnyCacheControlCacheable() { responseCacheControl = ResponseCacheControl.builder() .setMaxAge(10) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); response = new BasicHttpResponse(HttpStatus.SC_OK, ""); response.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); response.setHeader("Content-Length", "0"); responseCacheControl = ResponseCacheControl.builder() .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testControlWithout200Cacheable() { HttpResponse response404 = new BasicHttpResponse(HttpStatus.SC_NOT_FOUND, ""); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response404)); response404 = new BasicHttpResponse(HttpStatus.SC_GATEWAY_TIMEOUT, ""); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response404)); } @Test void testVaryStarIsNotCacheable() { response.setHeader("Vary", "*"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testVaryStarIsNotCacheableUsingSharedPublicCache() { policy = new ResponseCachingPolicy(true, false, false); request.setHeader("Authorization", StandardAuthScheme.BASIC + " QWxhZGRpbjpvcGVuIHNlc2FtZQ=="); response.setHeader("Vary", "*"); responseCacheControl = ResponseCacheControl.builder() .setCachePublic(true) .build(); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testRequestWithVaryHeaderCacheable() { response.addHeader("Vary", "Accept-Encoding"); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testIsArbitraryMethodCacheableUsingSharedPublicCache() { policy = new ResponseCachingPolicy(true, false, false); request = new HttpOptions("http://foo.example.com/"); request.setHeader("Authorization", StandardAuthScheme.BASIC + " QWxhZGRpbjpvcGVuIHNlc2FtZQ=="); response.setCode(HttpStatus.SC_NO_CONTENT); responseCacheControl = ResponseCacheControl.builder() .setCachePublic(true) .build(); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesWithMultipleAgeHeadersAreCacheable() { response.addHeader("Age", "3"); response.addHeader("Age", "5"); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesWithMultipleAgeHeadersAreNotCacheableUsingSharedPublicCache() { policy = new ResponseCachingPolicy(true, false, false); request.setHeader("Authorization", StandardAuthScheme.BASIC + " QWxhZGRpbjpvcGVuIHNlc2FtZQ=="); response.addHeader("Age", "3"); response.addHeader("Age", "5"); responseCacheControl = ResponseCacheControl.builder() .setCachePublic(true) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesWithMultipleDateHeadersAreNotCacheable() { response.addHeader("Date", DateUtils.formatStandardDate(now)); response.addHeader("Date", DateUtils.formatStandardDate(sixSecondsAgo)); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesWithMultipleDateHeadersAreNotCacheableUsingSharedPublicCache() { policy = new ResponseCachingPolicy(true, false, false); request.setHeader("Authorization", StandardAuthScheme.BASIC + " QWxhZGRpbjpvcGVuIHNlc2FtZQ=="); response.addHeader("Date", DateUtils.formatStandardDate(now)); response.addHeader("Date", DateUtils.formatStandardDate(sixSecondsAgo)); responseCacheControl = ResponseCacheControl.builder() .setCachePublic(true) .build(); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesWithMalformedDateHeadersAreNotCacheable() { response.addHeader("Date", "garbage"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesWithMalformedDateHeadersAreNotCacheableUsingSharedPublicCache() { policy = new ResponseCachingPolicy(true, false, false); request.setHeader("Authorization", StandardAuthScheme.BASIC + " QWxhZGRpbjpvcGVuIHNlc2FtZQ=="); response.addHeader("Date", "garbage"); responseCacheControl = ResponseCacheControl.builder() .setCachePublic(true) .build(); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesWithMultipleExpiresHeadersAreNotCacheable() { response.addHeader("Expires", DateUtils.formatStandardDate(now)); response.addHeader("Expires", DateUtils.formatStandardDate(sixSecondsAgo)); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesWithMultipleExpiresHeadersAreNotCacheableUsingSharedPublicCache() { policy = new ResponseCachingPolicy(true, false, false); request.setHeader("Authorization", StandardAuthScheme.BASIC + " QWxhZGRpbjpvcGVuIHNlc2FtZQ=="); response.addHeader("Expires", DateUtils.formatStandardDate(now)); response.addHeader("Expires", DateUtils.formatStandardDate(sixSecondsAgo)); responseCacheControl = ResponseCacheControl.builder() .setCachePublic(true) .build(); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesThatAreSmallEnoughAreCacheable() { response.setHeader("Content-Length", "0"); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesToGETWithQueryParamsButNoExplicitCachingAreNotCacheable() { request = new BasicHttpRequest("GET", "/foo?s=bar"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesToHEADWithQueryParamsButNoExplicitCachingAreNotCacheable() { request = new BasicHttpRequest("HEAD", "/foo?s=bar"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesToGETWithQueryParamsButNoExplicitCachingAreNotCacheableEvenWhen1_0QueryCachingDisabled() { policy = new ResponseCachingPolicy(true, true, false); request = new BasicHttpRequest("GET", "/foo?s=bar"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesToHEADWithQueryParamsButNoExplicitCachingAreNotCacheableEvenWhen1_0QueryCachingDisabled() { policy = new ResponseCachingPolicy(true, true, false); request = new BasicHttpRequest("HEAD", "/foo?s=bar"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesToGETWithQueryParamsAndExplicitCachingAreCacheable() { request = new BasicHttpRequest("GET", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesToHEADWithQueryParamsAndExplicitCachingAreCacheable() { policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesToGETWithQueryParamsAndExplicitCachingAreCacheableEvenWhen1_0QueryCachingDisabled() { policy = new ResponseCachingPolicy(true, true, false); request = new BasicHttpRequest("GET", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testResponsesToHEADWithQueryParamsAndExplicitCachingAreCacheableEvenWhen1_0QueryCachingDisabled() { policy = new ResponseCachingPolicy(true, true, false); request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void getsWithQueryParametersDirectlyFrom1_0OriginsAreNotCacheable() { request = new BasicHttpRequest("GET", "/foo?s=bar"); response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); response.setVersion(HttpVersion.HTTP_1_0); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void headsWithQueryParametersDirectlyFrom1_0OriginsAreNotCacheable() { request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); response.setVersion(HttpVersion.HTTP_1_0); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void getsWithQueryParametersDirectlyFrom1_0OriginsAreNotCacheableEvenWithSetting() { policy = new ResponseCachingPolicy(true, true, false); request = new BasicHttpRequest("GET", "/foo?s=bar"); response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); response.setVersion(HttpVersion.HTTP_1_0); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void headsWithQueryParametersDirectlyFrom1_0OriginsAreNotCacheableEvenWithSetting() { policy = new ResponseCachingPolicy(true, true, false); request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); response.setVersion(HttpVersion.HTTP_1_0); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void getsWithQueryParametersDirectlyFrom1_0OriginsAreCacheableWithExpires() { request = new BasicHttpRequest("GET", "/foo?s=bar"); response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); response.setVersion(HttpVersion.HTTP_1_0); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void headsWithQueryParametersDirectlyFrom1_0OriginsAreCacheableWithExpires() { policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); response.setVersion(HttpVersion.HTTP_1_0); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void getsWithQueryParametersDirectlyFrom1_0OriginsCanBeNotCacheableEvenWithExpires() { policy = new ResponseCachingPolicy(true, true, false); request = new BasicHttpRequest("GET", "/foo?s=bar"); response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); response.setVersion(HttpVersion.HTTP_1_0); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void headsWithQueryParametersDirectlyFrom1_0OriginsCanBeNotCacheableEvenWithExpires() { policy = new ResponseCachingPolicy(true, true, false); request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); response.setVersion(HttpVersion.HTTP_1_0); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void getsWithQueryParametersFrom1_0OriginsViaProxiesAreNotCacheable() { request = new BasicHttpRequest("GET", "/foo?s=bar"); response.setHeader(HttpHeaders.VIA, "1.0 someproxy"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void headsWithQueryParametersFrom1_0OriginsViaProxiesAreNotCacheable() { request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response.setHeader(HttpHeaders.VIA, "1.0 someproxy"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void getsWithQueryParametersFrom1_0OriginsViaProxiesAreCacheableWithExpires() { request = new BasicHttpRequest("GET", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); response.setHeader(HttpHeaders.VIA, "1.0 someproxy"); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void headsWithQueryParametersFrom1_0OriginsViaProxiesAreCacheableWithExpires() { policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); response.setHeader(HttpHeaders.VIA, "1.0 someproxy"); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void getsWithQueryParametersFrom1_0OriginsViaProxiesCanNotBeCacheableEvenWithExpires() { policy = new ResponseCachingPolicy(true, true, true); request = new BasicHttpRequest("GET", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); response.setHeader(HttpHeaders.VIA, "1.0 someproxy"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void headsWithQueryParametersFrom1_0OriginsViaProxiesCanNotBeCacheableEvenWithExpires() { policy = new ResponseCachingPolicy(true, true, true); request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); response.setHeader(HttpHeaders.VIA, "1.0 someproxy"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void getsWithQueryParametersFrom1_0OriginsViaExplicitProxiesAreCacheableWithExpires() { request = new BasicHttpRequest("GET", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); response.setHeader(HttpHeaders.VIA, "HTTP/1.0 someproxy"); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void headsWithQueryParametersFrom1_0OriginsViaExplicitProxiesAreCacheableWithExpires() { policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); response.setHeader(HttpHeaders.VIA, "HTTP/1.0 someproxy"); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void getsWithQueryParametersFrom1_0OriginsViaExplicitProxiesCanNotBeCacheableEvenWithExpires() { policy = new ResponseCachingPolicy(true, true, true); request = new BasicHttpRequest("GET", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); response.setHeader(HttpHeaders.VIA, "HTTP/1.0 someproxy"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void headsWithQueryParametersFrom1_0OriginsViaExplicitProxiesCanNotBeCacheableEvenWithExpires() { policy = new ResponseCachingPolicy(true, true, true); request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); response.setHeader(HttpHeaders.VIA, "HTTP/1.0 someproxy"); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void getsWithQueryParametersFrom1_1OriginsVia1_0ProxiesAreCacheableWithExpires() { request = new BasicHttpRequest("GET", "/foo?s=bar"); response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); response.setVersion(HttpVersion.HTTP_1_0); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); response.setHeader(HttpHeaders.VIA, "1.1 someproxy"); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void headsWithQueryParametersFrom1_1OriginsVia1_0ProxiesAreCacheableWithExpires() { policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("HEAD", "/foo?s=bar"); response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); response.setVersion(HttpVersion.HTTP_1_0); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsFromNow)); response.setHeader(HttpHeaders.VIA, "1.1 someproxy"); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void notCacheableIfExpiresEqualsDateAndNoCacheControl() { response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(now)); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void notCacheableIfExpiresPrecedesDateAndNoCacheControl() { response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Expires", DateUtils.formatStandardDate(sixSecondsAgo)); Assertions.assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void test302WithExplicitCachingHeaders() { response.setCode(HttpStatus.SC_MOVED_TEMPORARILY); response.setHeader("Date", DateUtils.formatStandardDate(now)); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(300) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void test303WithExplicitCachingHeadersWhenPermittedByConfig() { // HTTPbis working group says ok if explicitly indicated by // response headers policy = new ResponseCachingPolicy(true, false, true); response.setCode(HttpStatus.SC_SEE_OTHER); response.setHeader("Date", DateUtils.formatStandardDate(now)); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(300) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void test307WithExplicitCachingHeaders() { response.setCode(HttpStatus.SC_TEMPORARY_REDIRECT); response.setHeader("Date", DateUtils.formatStandardDate(now)); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(300) .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void otherStatusCodesAreCacheableWithExplicitCachingHeaders() { response.setCode(HttpStatus.SC_NOT_FOUND); response.setHeader("Date", DateUtils.formatStandardDate(now)); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(300) .build(); assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testIsResponseCacheableNullCacheControl() { // Set up test data final Duration tenSecondsFromNow = Duration.ofSeconds(10); response = new BasicHttpResponse(HttpStatus.SC_OK, ""); response.setHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(Instant.now())); response.setHeader(HttpHeaders.EXPIRES, DateUtils.formatStandardDate(Instant.now().plus(tenSecondsFromNow))); // Create ResponseCachingPolicy instance and test the method policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("GET", "/foo"); assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testIsResponseCacheableNotNullCacheControlSmaxAge60() { // Set up test data final Duration tenSecondsFromNow = Duration.ofSeconds(10); response = new BasicHttpResponse(HttpStatus.SC_OK, ""); response.setHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(Instant.now())); response.setHeader(HttpHeaders.EXPIRES, DateUtils.formatStandardDate(Instant.now().plus(tenSecondsFromNow))); // Create ResponseCachingPolicy instance and test the method policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("GET", "/foo"); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(60) .build(); assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testIsResponseCacheableNotNullCacheControlMaxAge60() { // Set up test data final Duration tenSecondsFromNow = Duration.ofSeconds(10); response = new BasicHttpResponse(HttpStatus.SC_OK, ""); response.setHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(Instant.now())); response.setHeader(HttpHeaders.EXPIRES, DateUtils.formatStandardDate(Instant.now().plus(tenSecondsFromNow))); // Create ResponseCachingPolicy instance and test the method policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("GET", "/foo"); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(60) .build(); assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testIsResponseCacheableNotExsiresAndDate() { // Set up test data final Duration tenSecondsFromNow = Duration.ofSeconds(10); response = new BasicHttpResponse(HttpStatus.SC_OK, ""); response.setHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(Instant.now())); response.setHeader(HttpHeaders.EXPIRES, DateUtils.formatStandardDate(Instant.now().plus(tenSecondsFromNow))); // Create ResponseCachingPolicy instance and test the method policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("GET", "/foo"); assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } private int getRandomStatus() { final int rnd = new Random().nextInt(acceptableCodes.length); return acceptableCodes[rnd]; } @Test void testIsResponseCacheable() { request = new BasicHttpRequest("GET","/foo?s=bar"); // HTTPbis working group says ok if explicitly indicated by // response headers policy = new ResponseCachingPolicy(true, false, true); response.setCode(HttpStatus.SC_OK); response.setHeader("Date", DateUtils.formatStandardDate(now)); assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testIsResponseCacheableNoCache() { // Set up test data response = new BasicHttpResponse(HttpStatus.SC_OK, ""); response.setHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(Instant.now())); // Create ResponseCachingPolicy instance and test the method policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("GET", "/foo"); responseCacheControl = ResponseCacheControl.builder() .setNoCache(true) .build(); assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testIsResponseCacheableNoStore() { // Set up test data response = new BasicHttpResponse(HttpStatus.SC_OK, ""); response.setHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(Instant.now())); // Create ResponseCachingPolicy instance and test the method policy = new ResponseCachingPolicy(true, false, false); request = new BasicHttpRequest("GET", "/foo"); responseCacheControl = ResponseCacheControl.builder() .setNoStore(true) .build(); assertFalse(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testImmutableAndFreshResponseIsCacheable() { responseCacheControl = ResponseCacheControl.builder() .setImmutable(true) .setMaxAge(3600) // set this to a value that ensures the response is still fresh .build(); Assertions.assertTrue(policy.isResponseCacheable(responseCacheControl, request, response)); } @Test void testPublicWithAuthorizationIsCacheable() { request = new BasicHttpRequest("GET", "/resource"); request.setHeader(HttpHeaders.AUTHORIZATION, "Basic dXNlcjpwYXNzd2Q="); response.setHeader("Cache-Control", "public"); responseCacheControl = ResponseCacheControl.builder() .setCachePublic(true) .build(); final boolean isCacheable = policy.isResponseCacheable(responseCacheControl, request, response); Assertions.assertTrue(isCacheable, "Response with public directive and Authorization header should be cacheable in shared cache."); } @Test void testSMaxageWithAuthorizationIsCacheable() { request = new BasicHttpRequest("GET", "/resource"); request.setHeader(HttpHeaders.AUTHORIZATION, "Basic dXNlcjpwYXNzd2Q="); response.setHeader("Cache-Control", "s-maxage=60"); responseCacheControl = ResponseCacheControl.builder() .setSharedMaxAge(60) .build(); final boolean isCacheable = policy.isResponseCacheable(responseCacheControl, request, response); Assertions.assertTrue(isCacheable, "Response with s-maxage and Authorization header should be cacheable in shared cache."); } @Test void testNoDirectivesWithAuthorizationNotCacheable() { request = new BasicHttpRequest("GET", "/resource"); request.setHeader(HttpHeaders.AUTHORIZATION, "Basic dXNlcjpwYXNzd2Q="); response.setHeader("Cache-Control", ""); responseCacheControl = ResponseCacheControl.builder() .build(); final boolean isCacheable = policy.isResponseCacheable(responseCacheControl, request, response); Assertions.assertFalse(isCacheable, "Response without must-revalidate, public, or s-maxage should not be cacheable with Authorization header."); } @Test void testMustRevalidateWithAuthorizationIsCacheable() { request = new BasicHttpRequest("GET", "/resource"); request.setHeader(HttpHeaders.AUTHORIZATION, "Basic dXNlcjpwYXNzd2Q="); response.setHeader("Cache-Control", "must-revalidate"); responseCacheControl = ResponseCacheControl.builder() .setMustRevalidate(true) .build(); final boolean isCacheable = policy.isResponseCacheable(responseCacheControl, request, response); Assertions.assertTrue(isCacheable, "Response with must-revalidate and Authorization header should be cacheable in shared cache."); } }././@LongLink0100644 0000000 0000000 00000000147 14704162040 011633 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestHttpCacheJiraNumber1147.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestHttpCacheJiraNumber1147.ja0100664 0000000 0000000 00000013517 14704162040 032052 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.mockito.ArgumentMatchers.isA; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.reset; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import java.io.File; import java.time.Instant; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.cache.CacheResponseStatus; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.cache.HttpCacheStorage; import org.apache.hc.client5.http.cache.ResourceFactory; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mockito; class TestHttpCacheJiraNumber1147 { private File cacheDir; private void removeCache() { if (this.cacheDir != null) { final File[] files = this.cacheDir.listFiles(); for (final File cacheFile : files) { cacheFile.delete(); } this.cacheDir.delete(); this.cacheDir = null; } } @BeforeEach void setUp() throws Exception { cacheDir = File.createTempFile("cachedir", ""); if (cacheDir.exists()) { cacheDir.delete(); } cacheDir.mkdir(); } @AfterEach void cleanUp() { removeCache(); } @Test void testIssue1147() throws Exception { final CacheConfig cacheConfig = CacheConfig.custom() .setSharedCache(true) .setMaxObjectSize(262144) //256kb .build(); final ResourceFactory resourceFactory = new FileResourceFactory(cacheDir); final HttpCacheStorage httpCacheStorage = new ManagedHttpCacheStorage(cacheConfig); final ExecChain mockExecChain = mock(ExecChain.class); final ExecRuntime mockEndpoint = mock(ExecRuntime.class); final HttpHost target = new HttpHost("somehost", 80); final HttpRoute route = new HttpRoute(target); final ClassicHttpRequest get = new HttpGet("http://somehost/"); final HttpCacheContext context = HttpCacheContext.create(); final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); response.setEntity(HttpTestUtils.makeBody(128)); response.setHeader("Content-Length", "128"); response.setHeader("ETag", "\"etag\""); response.setHeader("Cache-Control", "public, max-age=3600"); response.setHeader("Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); when(mockExecChain.proceed( isA(ClassicHttpRequest.class), isA(ExecChain.Scope.class))).thenReturn(response); final BasicHttpCache cache = new BasicHttpCache(resourceFactory, httpCacheStorage); final ExecChainHandler t = createCachingExecChain(cache, cacheConfig); final ExecChain.Scope scope = new ExecChain.Scope("teset", route, get, mockEndpoint, context); final ClassicHttpResponse response1 = t.execute(get, scope, mockExecChain); Assertions.assertEquals(200, response1.getCode()); EntityUtils.consume(response1.getEntity()); verify(mockExecChain).proceed(isA(ClassicHttpRequest.class), isA(ExecChain.Scope.class)); removeCache(); reset(mockExecChain); when(mockExecChain.proceed(isA(ClassicHttpRequest.class), isA(ExecChain.Scope.class))).thenReturn(response); final ClassicHttpResponse response2 = t.execute(get, scope, mockExecChain); Assertions.assertEquals(200, response2.getCode()); EntityUtils.consume(response2.getEntity()); verify(mockExecChain, Mockito.times(1)).proceed( isA(ClassicHttpRequest.class), isA(ExecChain.Scope.class)); Assertions.assertEquals(CacheResponseStatus.FAILURE, context.getCacheResponseStatus()); } protected ExecChainHandler createCachingExecChain(final BasicHttpCache cache, final CacheConfig config) { return new CachingExec(cache, null, config); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCacheSupport.java0100664 0000000 0000000 00000004231 14704162040 030633 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Unit tests for {@link CacheSupport}. */ class TestCacheSupport { @Test void testParseDeltaSeconds() { Assertions.assertEquals(1234L, CacheSupport.deltaSeconds("1234")); Assertions.assertEquals(0L, CacheSupport.deltaSeconds("0")); Assertions.assertEquals(-1L, CacheSupport.deltaSeconds("-1")); Assertions.assertEquals(-1L, CacheSupport.deltaSeconds("-100")); Assertions.assertEquals(-1L, CacheSupport.deltaSeconds("")); Assertions.assertEquals(-1L, CacheSupport.deltaSeconds(null)); Assertions.assertEquals(0L, CacheSupport.deltaSeconds("huh?")); Assertions.assertEquals(2147483648L, CacheSupport.deltaSeconds("2147483648")); Assertions.assertEquals(2147483648L, CacheSupport.deltaSeconds("2147483649")); Assertions.assertEquals(2147483648L, CacheSupport.deltaSeconds("214748364712")); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestBasicHttpCache.java0100664 0000000 0000000 00000107327 14704162040 031052 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; 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.assertNull; import static org.junit.jupiter.api.Assertions.assertSame; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.verifyNoMoreInteractions; import java.net.URI; import java.time.Instant; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; import java.util.stream.Collectors; import org.apache.hc.client5.http.HeadersMatcher; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.util.ByteArrayBuffer; import org.hamcrest.MatcherAssert; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mockito; class TestBasicHttpCache { private HttpHost host; private Instant now; private Instant tenSecondsAgo; private SimpleHttpCacheStorage backing; private BasicHttpCache impl; @BeforeEach void setUp() { host = new HttpHost("foo.example.com"); now = Instant.now(); tenSecondsAgo = now.minusSeconds(10); backing = Mockito.spy(new SimpleHttpCacheStorage()); impl = new BasicHttpCache(new HeapResourceFactory(), backing); } @Test void testGetCacheEntryReturnsNullOnCacheMiss() { final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest request = new HttpGet("http://foo.example.com/bar"); final CacheMatch result = impl.match(host, request); assertNull(result); } @Test void testGetCacheEntryFetchesFromCacheOnCacheHitIfNoVariants() { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(); assertFalse(entry.hasVariants()); final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest request = new HttpGet("http://foo.example.com/bar"); final String key = CacheKeyGenerator.INSTANCE.generateKey(host, request); backing.map.put(key,entry); final CacheMatch result = impl.match(host, request); assertNotNull(result); assertNotNull(result.hit); assertSame(entry, result.hit.entry); } @Test void testGetCacheEntryReturnsNullIfNoVariantInCache() { final HttpRequest origRequest = new HttpGet("http://foo.example.com/bar"); origRequest.setHeader("Accept-Encoding","gzip"); final ByteArrayBuffer buf = HttpTestUtils.makeRandomBuffer(128); final HttpResponse origResponse = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); origResponse.setHeader("Date", DateUtils.formatStandardDate(now)); origResponse.setHeader("Cache-Control", "max-age=3600, public"); origResponse.setHeader("ETag", "\"etag\""); origResponse.setHeader("Vary", "Accept-Encoding"); origResponse.setHeader("Content-Encoding","gzip"); impl.store(host, origRequest, origResponse, buf, now, now); final HttpRequest request = new HttpGet("http://foo.example.com/bar"); final CacheMatch result = impl.match(host, request); assertNotNull(result); assertNull(result.hit); } @Test void testGetCacheEntryReturnsVariantIfPresentInCache() { final HttpRequest origRequest = new HttpGet("http://foo.example.com/bar"); origRequest.setHeader("Accept-Encoding","gzip"); final ByteArrayBuffer buf = HttpTestUtils.makeRandomBuffer(128); final HttpResponse origResponse = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); origResponse.setHeader("Date", DateUtils.formatStandardDate(now)); origResponse.setHeader("Cache-Control", "max-age=3600, public"); origResponse.setHeader("ETag", "\"etag\""); origResponse.setHeader("Vary", "Accept-Encoding"); origResponse.setHeader("Content-Encoding","gzip"); impl.store(host, origRequest, origResponse, buf, now, now); final HttpRequest request = new HttpGet("http://foo.example.com/bar"); request.setHeader("Accept-Encoding","gzip"); final CacheMatch result = impl.match(host, request); assertNotNull(result); assertNotNull(result.hit); } @Test void testGetCacheEntryReturnsVariantWithMostRecentDateHeader() { final HttpRequest origRequest = new HttpGet("http://foo.example.com/bar"); origRequest.setHeader("Accept-Encoding", "gzip"); final ByteArrayBuffer buf = HttpTestUtils.makeRandomBuffer(128); // Create two response variants with different Date headers final HttpResponse origResponse1 = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); origResponse1.setHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(now.minusSeconds(3600))); origResponse1.setHeader(HttpHeaders.CACHE_CONTROL, "max-age=3600, public"); origResponse1.setHeader(HttpHeaders.ETAG, "\"etag1\""); origResponse1.setHeader(HttpHeaders.VARY, "Accept-Encoding"); final HttpResponse origResponse2 = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); origResponse2.setHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(now)); origResponse2.setHeader(HttpHeaders.CACHE_CONTROL, "max-age=3600, public"); origResponse2.setHeader(HttpHeaders.ETAG, "\"etag2\""); origResponse2.setHeader(HttpHeaders.VARY, "Accept-Encoding"); // Store the two variants in cache impl.store(host, origRequest, origResponse1, buf, now, now); impl.store(host, origRequest, origResponse2, buf, now, now); final HttpRequest request = new HttpGet("http://foo.example.com/bar"); request.setHeader("Accept-Encoding", "gzip"); final CacheMatch result = impl.match(host, request); assertNotNull(result); assertNotNull(result.hit); final HttpCacheEntry entry = result.hit.entry; assertNotNull(entry); // Retrieve the ETag header value from the original response and assert that // the returned cache entry has the same ETag value final String expectedEtag = origResponse2.getFirstHeader(HttpHeaders.ETAG).getValue(); final String actualEtag = entry.getFirstHeader(HttpHeaders.ETAG).getValue(); assertEquals(expectedEtag, actualEtag); } @Test void testGetVariantsRootNoVariants() { final HttpCacheEntry root = HttpTestUtils.makeCacheEntry(); final List variants = impl.getVariants(new CacheHit("root-key", root)); assertNotNull(variants); assertEquals(0, variants.size()); } @Test void testGetVariantsRootNonExistentVariants() { final Set varinats = new HashSet<>(); varinats.add("variant1"); varinats.add("variant2"); final HttpCacheEntry root = HttpTestUtils.makeCacheEntry(varinats); final List variants = impl.getVariants(new CacheHit("root-key", root)); assertNotNull(variants); assertEquals(0, variants.size()); } @Test void testGetVariantCacheEntriesReturnsAllVariants() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final URI uri = new URI("http://foo.example.com/bar"); final HttpRequest req1 = new HttpGet(uri); req1.setHeader("Accept-Encoding", "gzip"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(uri); final HttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "max-age=3600, public"); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Vary", "Accept-Encoding"); resp1.setHeader("Content-Encoding","gzip"); final HttpRequest req2 = new HttpGet(uri); req2.setHeader("Accept-Encoding", "identity"); final HttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600, public"); resp2.setHeader("ETag", "\"etag2\""); resp2.setHeader("Vary", "Accept-Encoding"); resp2.setHeader("Content-Encoding","gzip"); final CacheHit hit1 = impl.store(host, req1, resp1, null, now, now); final CacheHit hit2 = impl.store(host, req2, resp2, null, now, now); final Set variants = new HashSet<>(); variants.add("{accept-encoding=gzip}"); variants.add("{accept-encoding=identity}"); final Map variantMap = impl.getVariants(new CacheHit(hit1.rootKey, HttpTestUtils.makeCacheEntry(variants))).stream() .collect(Collectors.toMap(CacheHit::getEntryKey, e -> e.entry)); assertNotNull(variantMap); assertEquals(2, variantMap.size()); MatcherAssert.assertThat(variantMap.get("{accept-encoding=gzip}" + rootKey), HttpCacheEntryMatcher.equivalent(hit1.entry)); MatcherAssert.assertThat(variantMap.get("{accept-encoding=identity}" + rootKey), HttpCacheEntryMatcher.equivalent(hit2.entry)); } @Test void testUpdateCacheEntry() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final URI uri = new URI("http://foo.example.com/bar"); final HttpRequest req1 = new HttpGet(uri); final HttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "max-age=3600, public"); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Content-Encoding","gzip"); final HttpRequest revalidate = new HttpGet(uri); revalidate.setHeader("If-None-Match","\"etag1\""); final HttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600, public"); final CacheHit hit1 = impl.store(host, req1, resp1, null, now, now); Assertions.assertNotNull(hit1); Assertions.assertEquals(1, backing.map.size()); Assertions.assertSame(hit1.entry, backing.map.get(hit1.getEntryKey())); final CacheHit updated = impl.update(hit1, host, req1, resp2, now, now); Assertions.assertNotNull(updated); Assertions.assertEquals(1, backing.map.size()); Assertions.assertSame(updated.entry, backing.map.get(hit1.getEntryKey())); MatcherAssert.assertThat( updated.entry.getHeaders(), HeadersMatcher.same( new BasicHeader("Server", "MockOrigin/1.0"), new BasicHeader("ETag", "\"etag1\""), new BasicHeader("Content-Encoding","gzip"), new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("Cache-Control", "max-age=3600, public") )); } @Test void testUpdateVariantCacheEntry() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final URI uri = new URI("http://foo.example.com/bar"); final HttpRequest req1 = new HttpGet(uri); req1.setHeader("User-Agent", "agent1"); final HttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "max-age=3600, public"); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Content-Encoding","gzip"); resp1.setHeader("Vary", "User-Agent"); final HttpRequest revalidate = new HttpGet(uri); revalidate.setHeader("If-None-Match","\"etag1\""); final HttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600, public"); final CacheHit hit1 = impl.store(host, req1, resp1, null, now, now); Assertions.assertNotNull(hit1); Assertions.assertEquals(2, backing.map.size()); Assertions.assertSame(hit1.entry, backing.map.get(hit1.getEntryKey())); final CacheHit updated = impl.update(hit1, host, req1, resp2, now, now); Assertions.assertNotNull(updated); Assertions.assertEquals(2, backing.map.size()); Assertions.assertSame(updated.entry, backing.map.get(hit1.getEntryKey())); MatcherAssert.assertThat( updated.entry.getHeaders(), HeadersMatcher.same( new BasicHeader("Server", "MockOrigin/1.0"), new BasicHeader("ETag", "\"etag1\""), new BasicHeader("Content-Encoding","gzip"), new BasicHeader("Vary","User-Agent"), new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("Cache-Control", "max-age=3600, public") )); } @Test void testUpdateCacheEntryTurnsVariant() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final URI uri = new URI("http://foo.example.com/bar"); final HttpRequest req1 = new HttpGet(uri); req1.setHeader("User-Agent", "agent1"); final HttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "max-age=3600, public"); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Content-Encoding","gzip"); final HttpRequest revalidate = new HttpGet(uri); revalidate.setHeader("If-None-Match","\"etag1\""); final HttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600, public"); resp2.setHeader("Vary", "User-Agent"); final CacheHit hit1 = impl.store(host, req1, resp1, null, now, now); Assertions.assertNotNull(hit1); Assertions.assertEquals(1, backing.map.size()); Assertions.assertSame(hit1.entry, backing.map.get(hit1.getEntryKey())); final CacheHit updated = impl.update(hit1, host, req1, resp2, now, now); Assertions.assertNotNull(updated); Assertions.assertEquals(2, backing.map.size()); MatcherAssert.assertThat( updated.entry.getHeaders(), HeadersMatcher.same( new BasicHeader("Server", "MockOrigin/1.0"), new BasicHeader("ETag", "\"etag1\""), new BasicHeader("Content-Encoding","gzip"), new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("Cache-Control", "max-age=3600, public"), new BasicHeader("Vary","User-Agent"))); } @Test void testStoreFromNegotiatedVariant() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final URI uri = new URI("http://foo.example.com/bar"); final HttpRequest req1 = new HttpGet(uri); req1.setHeader("User-Agent", "agent1"); final HttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "max-age=3600, public"); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Content-Encoding","gzip"); resp1.setHeader("Vary", "User-Agent"); final CacheHit hit1 = impl.store(host, req1, resp1, null, now, now); Assertions.assertNotNull(hit1); Assertions.assertEquals(2, backing.map.size()); Assertions.assertSame(hit1.entry, backing.map.get(hit1.getEntryKey())); final HttpRequest req2 = new HttpGet(uri); req2.setHeader("User-Agent", "agent2"); final HttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600, public"); final CacheHit hit2 = impl.storeFromNegotiated(hit1, host, req2, resp2, now, now); Assertions.assertNotNull(hit2); Assertions.assertEquals(3, backing.map.size()); MatcherAssert.assertThat( hit2.entry.getHeaders(), HeadersMatcher.same( new BasicHeader("Server", "MockOrigin/1.0"), new BasicHeader("ETag", "\"etag1\""), new BasicHeader("Content-Encoding","gzip"), new BasicHeader("Vary","User-Agent"), new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("Cache-Control", "max-age=3600, public"))); } @Test void testInvalidatesUnsafeRequests() throws Exception { final HttpRequest request = new BasicHttpRequest("POST","/path"); final String key = CacheKeyGenerator.INSTANCE.generateKey(host, request); final HttpResponse response = HttpTestUtils.make200Response(); backing.putEntry(key, HttpTestUtils.makeCacheEntry()); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(key); verify(backing).removeEntry(key); Assertions.assertNull(backing.getEntry(key)); } @Test void testDoesNotInvalidateSafeRequests() { final HttpRequest request1 = new BasicHttpRequest("GET","/"); final HttpResponse response1 = HttpTestUtils.make200Response(); impl.evictInvalidatedEntries(host, request1, response1); verifyNoMoreInteractions(backing); final HttpRequest request2 = new BasicHttpRequest("HEAD","/"); final HttpResponse response2 = HttpTestUtils.make200Response(); impl.evictInvalidatedEntries(host, request2, response2); verifyNoMoreInteractions(backing); } @Test void testInvalidatesUnsafeRequestsWithVariants() throws Exception { final HttpRequest request = new BasicHttpRequest("POST","/path"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(host, request); final Set variants = new HashSet<>(); variants.add("{var1}"); variants.add("{var2}"); final String variantKey1 = "{var1}" + rootKey; final String variantKey2 = "{var2}" + rootKey; final HttpResponse response = HttpTestUtils.make200Response(); backing.putEntry(rootKey, HttpTestUtils.makeCacheEntry(variants)); backing.putEntry(variantKey1, HttpTestUtils.makeCacheEntry()); backing.putEntry(variantKey2, HttpTestUtils.makeCacheEntry()); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(rootKey); verify(backing).removeEntry(rootKey); verify(backing).removeEntry(variantKey1); verify(backing).removeEntry(variantKey2); Assertions.assertNull(backing.getEntry(rootKey)); Assertions.assertNull(backing.getEntry(variantKey1)); Assertions.assertNull(backing.getEntry(variantKey2)); } @Test void testInvalidateUriSpecifiedByContentLocationAndFresher() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(host, request); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(rootKey, HttpTestUtils.makeCacheEntry()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"old-etag\"") )); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(rootKey); verify(backing).removeEntry(rootKey); verify(backing).getEntry(contentKey); verify(backing).removeEntry(contentKey); } @Test void testInvalidateUriSpecifiedByLocationAndFresher() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(host, request); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Location", contentUri.toASCIIString()); backing.putEntry(rootKey, HttpTestUtils.makeCacheEntry()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"old-etag\"") )); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(rootKey); verify(backing).removeEntry(rootKey); verify(backing).getEntry(contentKey); verify(backing).removeEntry(contentKey); } @Test void testDoesNotInvalidateForUnsuccessfulResponse() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final HttpResponse response = HttpTestUtils.make500Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); impl.evictInvalidatedEntries(host, request, response); verifyNoMoreInteractions(backing); } @Test void testInvalidateUriSpecifiedByContentLocationNonCanonical() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(host, request); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(rootKey, HttpTestUtils.makeCacheEntry()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"old-etag\""))); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(rootKey); verify(backing).removeEntry(rootKey); verify(backing).getEntry(contentKey); verify(backing).removeEntry(contentKey); Assertions.assertNull(backing.getEntry(rootKey)); Assertions.assertNull(backing.getEntry(contentKey)); } @Test void testInvalidateUriSpecifiedByContentLocationRelative() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(host, request); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", "/bar"); backing.putEntry(rootKey, HttpTestUtils.makeCacheEntry()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"old-etag\""))); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(rootKey); verify(backing).removeEntry(rootKey); verify(backing).getEntry(contentKey); verify(backing).removeEntry(contentKey); Assertions.assertNull(backing.getEntry(rootKey)); Assertions.assertNull(backing.getEntry(contentKey)); } @Test void testDoesNotInvalidateUriSpecifiedByContentLocationOtherOrigin() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/"); final URI contentUri = new URIBuilder() .setHost("bar.example.com") .setPath("/") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry()); impl.evictInvalidatedEntries(host, request, response); verify(backing, Mockito.never()).getEntry(contentKey); verify(backing, Mockito.never()).removeEntry(contentKey); } @Test void testDoesNotInvalidateUriSpecifiedByContentLocationIfEtagsMatch() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"same-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"same-etag\""))); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(contentKey); verify(backing, Mockito.never()).removeEntry(contentKey); } @Test void testDoesNotInvalidateUriSpecifiedByContentLocationIfOlder() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("ETag", "\"old-etag\""))); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(contentKey); verify(backing, Mockito.never()).removeEntry(contentKey); } @Test void testDoesNotInvalidateUriSpecifiedByContentLocationIfResponseHasNoEtag() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.removeHeaders("ETag"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"old-etag\""))); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(contentKey); verify(backing, Mockito.never()).removeEntry(contentKey); } @Test void testDoesNotInvalidateUriSpecifiedByContentLocationIfEntryHasNoEtag() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag", "\"some-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)))); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(contentKey); verify(backing, Mockito.never()).removeEntry(contentKey); } @Test void testInvalidatesUriSpecifiedByContentLocationIfResponseHasNoDate() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag", "\"new-etag\""); response.removeHeaders("Date"); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("ETag", "\"old-etag\""), new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)))); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(contentKey); verify(backing).removeEntry(contentKey); } @Test void testInvalidatesUriSpecifiedByContentLocationIfEntryHasNoDate() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("ETag", "\"old-etag\""))); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(contentKey); verify(backing).removeEntry(contentKey); } @Test void testInvalidatesUriSpecifiedByContentLocationIfResponseHasMalformedDate() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", "huh?"); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("ETag", "\"old-etag\""), new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)))); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(contentKey); verify(backing).removeEntry(contentKey); } @Test void testInvalidatesUriSpecifiedByContentLocationIfEntryHasMalformedDate() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("ETag", "\"old-etag\""), new BasicHeader("Date", "huh?"))); impl.evictInvalidatedEntries(host, request, response); verify(backing).getEntry(contentKey); verify(backing).removeEntry(contentKey); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/HttpTestUtils.java0100664 0000000 0000000 00000037476 15005672016 030220 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.InputStream; import java.time.Duration; import java.time.Instant; import java.util.Collection; import java.util.Iterator; import java.util.Objects; import java.util.Random; import java.util.concurrent.CountDownLatch; import java.util.function.Consumer; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpMessage; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.HeaderGroup; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.util.ByteArrayBuffer; import org.junit.jupiter.api.Assertions; public class HttpTestUtils { /* * Assertions.asserts that two request or response bodies are byte-equivalent. */ public static boolean equivalent(final HttpEntity e1, final HttpEntity e2) throws Exception { final InputStream i1 = e1.getContent(); final InputStream i2 = e2.getContent(); if (i1 == null && i2 == null) { return true; } if (i1 == null || i2 == null) { return false; // avoid possible NPEs below } int b1 = -1; while ((b1 = i1.read()) != -1) { if (b1 != i2.read()) { return false; } } return -1 == i2.read(); } /* * Retrieves the full header value by combining multiple headers and * separating with commas, canonicalizing whitespace along the way. */ public static String getCanonicalHeaderValue(final HttpMessage r, final String name) { final int n = r.countHeaders(name); r.getFirstHeader(name); if (n == 0) { return null; } else if (n == 1) { final Header h = r.getFirstHeader(name); return h != null ? h.getValue() : null; } else { final StringBuilder buf = new StringBuilder(); for (final Iterator

it = r.headerIterator(name); it.hasNext(); ) { if (buf.length() > 0) { buf.append(", "); } final Header header = it.next(); if (header != null) { buf.append(header.getValue().trim()); } } return buf.toString(); } } /* * Assertions.asserts that all the headers appearing in r1 also appear in r2 * with the same canonical header values. */ public static boolean isEndToEndHeaderSubset(final HttpMessage r1, final HttpMessage r2) { for (final Header h : r1.getHeaders()) { if (!MessageSupport.isHopByHop(h.getName())) { final String r1val = getCanonicalHeaderValue(r1, h.getName()); final String r2val = getCanonicalHeaderValue(r2, h.getName()); if (!Objects.equals(r1val, r2val)) { return false; } } } return true; } /* * Assertions.asserts that message {@code r2} represents exactly the same * message as {@code r1}, except for hop-by-hop headers. "When a cache * is semantically transparent, the client receives exactly the same * response (except for hop-by-hop headers) that it would have received had * its request been handled directly by the origin server." */ public static boolean semanticallyTransparent( final ClassicHttpResponse r1, final ClassicHttpResponse r2) throws Exception { final boolean statusLineEquivalent = Objects.equals(r1.getReasonPhrase(), r2.getReasonPhrase()) && r1.getCode() == r2.getCode(); if (!statusLineEquivalent) { return false; } final boolean headerEquivalent = isEndToEndHeaderSubset(r1, r2); if (!headerEquivalent) { return false; } final boolean entityEquivalent = equivalent(r1.getEntity(), r2.getEntity()); if (!entityEquivalent) { return false; } return true; } /* Assertions.asserts that protocol versions equivalent. */ public static boolean equivalent(final ProtocolVersion v1, final ProtocolVersion v2) { return Objects.equals(v1 != null ? v1 : HttpVersion.DEFAULT, v2 != null ? v2 : HttpVersion.DEFAULT ); } /* Assertions.asserts that two requests are morally equivalent. */ public static boolean equivalent(final HttpRequest r1, final HttpRequest r2) { return equivalent(r1.getVersion(), r2.getVersion()) && Objects.equals(r1.getMethod(), r2.getMethod()) && Objects.equals(r1.getRequestUri(), r2.getRequestUri()) && isEndToEndHeaderSubset(r1, r2); } /* Assertions.asserts that two requests are morally equivalent. */ public static boolean equivalent(final HttpResponse r1, final HttpResponse r2) { return equivalent(r1.getVersion(), r2.getVersion()) && r1.getCode() == r2.getCode() && Objects.equals(r1.getReasonPhrase(), r2.getReasonPhrase()) && isEndToEndHeaderSubset(r1, r2); } public static byte[] makeRandomBytes(final int nbytes) { final byte[] bytes = new byte[nbytes]; new Random().nextBytes(bytes); return bytes; } public static Resource makeRandomResource(final int nbytes) { final byte[] bytes = new byte[nbytes]; new Random().nextBytes(bytes); return new HeapResource(bytes); } public static Resource makeNullResource() { return null; } public static ByteArrayBuffer makeRandomBuffer(final int nbytes) { final ByteArrayBuffer buf = new ByteArrayBuffer(nbytes); buf.setLength(nbytes); new Random().nextBytes(buf.array()); return buf; } /** Generates a response body with random content. * @param nbytes length of the desired response body * @return an {@link HttpEntity} */ public static HttpEntity makeBody(final int nbytes) { return new ByteArrayEntity(makeRandomBytes(nbytes), null); } public static HeaderGroup headers(final Header... headers) { final HeaderGroup headerGroup = new HeaderGroup(); if (headers != null && headers.length > 0) { headerGroup.setHeaders(headers); } return headerGroup; } public static HttpCacheEntry makeCacheEntry(final Instant requestDate, final Instant responseDate, final Method method, final String requestUri, final Header[] requestHeaders, final int status, final Header[] responseHeaders, final Collection variants) { return new HttpCacheEntry( requestDate, responseDate, method.name(), requestUri, headers(requestHeaders), status, headers(responseHeaders), null, variants); } public static HttpCacheEntry makeCacheEntry(final Instant requestDate, final Instant responseDate, final Method method, final String requestUri, final Header[] requestHeaders, final int status, final Header[] responseHeaders, final Resource resource) { return new HttpCacheEntry( requestDate, responseDate, method.name(), requestUri, headers(requestHeaders), status, headers(responseHeaders), resource, null); } public static HttpCacheEntry makeCacheEntry(final Instant requestDate, final Instant responseDate, final int status, final Header[] responseHeaders, final Collection variants) { return makeCacheEntry( requestDate, responseDate, Method.GET, "/", null, status, responseHeaders, variants); } public static HttpCacheEntry makeCacheEntry(final Instant requestDate, final Instant responseDate, final int status, final Header[] responseHeaders, final Resource resource) { return makeCacheEntry( requestDate, responseDate, Method.GET, "/", null, status, responseHeaders, resource); } public static Header[] getStockHeaders(final Instant when) { return new Header[] { new BasicHeader("Date", DateUtils.formatStandardDate(when)), new BasicHeader("Server", "MockServer/1.0") }; } public static HttpCacheEntry makeCacheEntry(final Instant requestDate, final Instant responseDate) { final Duration diff = Duration.between(requestDate, responseDate); final Instant when = requestDate.plusMillis(diff.toMillis() / 2); return makeCacheEntry(requestDate, responseDate, getStockHeaders(when)); } public static HttpCacheEntry makeCacheEntry(final Instant requestDate, final Instant responseDate, final Header[] headers, final byte[] bytes) { return makeCacheEntry(requestDate, responseDate, HttpStatus.SC_OK, headers, new HeapResource(bytes)); } public static HttpCacheEntry makeCacheEntry(final Instant requestDate, final Instant responseDate, final Header... headers) { return makeCacheEntry(requestDate, responseDate, headers, makeRandomBytes(128)); } public static HttpCacheEntry makeCacheEntry(final Instant requestDate, final Instant responseDate, final Header[] headers, final Collection variants) { return makeCacheEntry(requestDate, responseDate, Method.GET, "/", null, HttpStatus.SC_OK, headers, variants); } public static HttpCacheEntry makeCacheEntry(final Collection variants) { final Instant now = Instant.now(); return makeCacheEntry(now, now, new Header[] {}, variants); } public static HttpCacheEntry makeCacheEntry(final Header[] headers, final byte[] bytes) { final Instant now = Instant.now(); return makeCacheEntry(now, now, headers, bytes); } public static HttpCacheEntry makeCacheEntry(final byte[] bytes) { final Instant now = Instant.now(); return makeCacheEntry(getStockHeaders(now), bytes); } public static HttpCacheEntry makeCacheEntry(final Header... headers) { return makeCacheEntry(headers, makeRandomBytes(128)); } public static HttpCacheEntry makeCacheEntry() { final Instant now = Instant.now(); return makeCacheEntry(now, now); } public static ClassicHttpResponse make200Response() { final ClassicHttpResponse out = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); out.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); out.setHeader("Server", "MockOrigin/1.0"); out.setHeader("Content-Length", "128"); out.setEntity(makeBody(128)); return out; } public static final ClassicHttpResponse make200Response(final Instant date, final String cacheControl) { final ClassicHttpResponse response = HttpTestUtils.make200Response(); response.setHeader("Date", DateUtils.formatStandardDate(date)); response.setHeader("Cache-Control",cacheControl); response.setHeader("Etag","\"etag\""); return response; } public static ClassicHttpResponse make304Response() { return new BasicClassicHttpResponse(HttpStatus.SC_NOT_MODIFIED, "Not modified"); } public static ClassicHttpRequest makeDefaultRequest() { return new BasicClassicHttpRequest(Method.GET.toString(), "/"); } public static ClassicHttpRequest makeDefaultHEADRequest() { return new BasicClassicHttpRequest(Method.HEAD.toString(), "/"); } public static ClassicHttpResponse make500Response() { return new BasicClassicHttpResponse(HttpStatus.SC_INTERNAL_SERVER_ERROR, "Internal Server Error"); } public static FutureCallback countDown(final CountDownLatch latch, final Consumer consumer) { return new FutureCallback() { @Override public void completed(final T result) { if (consumer != null) { consumer.accept(result); } latch.countDown(); } @Override public void failed(final Exception ex) { latch.countDown(); Assertions.fail(ex); } @Override public void cancelled() { latch.countDown(); Assertions.fail("Unexpected cancellation"); } }; } public static FutureCallback countDown(final CountDownLatch latch) { return countDown(latch, null); } } ././@LongLink0100644 0000000 0000000 00000000164 15005672016 011636 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestAbstractSerializingAsyncCacheStorage.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestAbstractSerializingAsyncCa0100664 0000000 0000000 00000051057 15005672016 032535 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.hamcrest.MatcherAssert.assertThat; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import java.util.Arrays; import java.util.Collection; import java.util.HashMap; import java.util.Map; import java.util.concurrent.atomic.AtomicInteger; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheStorageEntry; import org.apache.hc.client5.http.cache.HttpCacheUpdateException; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Answers; import org.mockito.ArgumentCaptor; import org.mockito.ArgumentMatchers; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; import org.mockito.stubbing.Answer; class TestAbstractSerializingAsyncCacheStorage { @Mock private Cancellable cancellable; @Mock private FutureCallback operationCallback; @Mock private FutureCallback cacheEntryCallback; @Mock private FutureCallback> bulkCacheEntryCallback; private AbstractBinaryAsyncCacheStorage impl; public static byte[] serialize(final String key, final HttpCacheEntry value) throws ResourceIOException { return HttpByteArrayCacheEntrySerializer.INSTANCE.serialize(new HttpCacheStorageEntry(key, value)); } @BeforeEach @SuppressWarnings("unchecked") void setUp() { MockitoAnnotations.openMocks(this); impl = Mockito.mock(AbstractBinaryAsyncCacheStorage.class, Mockito.withSettings().defaultAnswer(Answers.CALLS_REAL_METHODS).useConstructor(3)); } @Test void testCachePut() throws Exception { final String key = "foo"; final HttpCacheEntry value = HttpTestUtils.makeCacheEntry(); Mockito.when(impl.digestToStorageKey(key)).thenReturn("bar"); Mockito.when(impl.store( ArgumentMatchers.eq("bar"), ArgumentMatchers.any(), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(2); callback.completed(true); return cancellable; }); impl.putEntry(key, value, operationCallback); final ArgumentCaptor argumentCaptor = ArgumentCaptor.forClass(byte[].class); Mockito.verify(impl).store(ArgumentMatchers.eq("bar"), argumentCaptor.capture(), ArgumentMatchers.any()); Assertions.assertArrayEquals(serialize(key, value), argumentCaptor.getValue()); Mockito.verify(operationCallback).completed(Boolean.TRUE); } @Test void testCacheGetNullEntry() { final String key = "foo"; Mockito.when(impl.digestToStorageKey(key)).thenReturn("bar"); Mockito.when(impl.restore(ArgumentMatchers.eq("bar"), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(1); callback.completed(null); return cancellable; }); impl.getEntry(key, cacheEntryCallback); final ArgumentCaptor argumentCaptor = ArgumentCaptor.forClass(HttpCacheEntry.class); Mockito.verify(cacheEntryCallback).completed(argumentCaptor.capture()); assertThat(argumentCaptor.getValue(), CoreMatchers.nullValue()); Mockito.verify(impl).restore(ArgumentMatchers.eq("bar"), ArgumentMatchers.any()); } @Test void testCacheGet() { final String key = "foo"; final HttpCacheEntry value = HttpTestUtils.makeCacheEntry(); Mockito.when(impl.digestToStorageKey(key)).thenReturn("bar"); Mockito.when(impl.restore(ArgumentMatchers.eq("bar"), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(1); callback.completed(serialize(key, value)); return cancellable; }); impl.getEntry(key, cacheEntryCallback); final ArgumentCaptor argumentCaptor = ArgumentCaptor.forClass(HttpCacheEntry.class); Mockito.verify(cacheEntryCallback).completed(argumentCaptor.capture()); final HttpCacheEntry resultingEntry = argumentCaptor.getValue(); assertThat(resultingEntry, HttpCacheEntryMatcher.equivalent(value)); Mockito.verify(impl).restore(ArgumentMatchers.eq("bar"), ArgumentMatchers.any()); } @Test void testCacheGetKeyMismatch() { final String key = "foo"; final HttpCacheEntry value = HttpTestUtils.makeCacheEntry(); Mockito.when(impl.digestToStorageKey(key)).thenReturn("bar"); Mockito.when(impl.restore(ArgumentMatchers.eq("bar"), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(1); callback.completed(serialize("not-foo", value)); return cancellable; }); impl.getEntry(key, cacheEntryCallback); final ArgumentCaptor argumentCaptor = ArgumentCaptor.forClass(HttpCacheEntry.class); Mockito.verify(cacheEntryCallback).completed(argumentCaptor.capture()); assertThat(argumentCaptor.getValue(), CoreMatchers.nullValue()); Mockito.verify(impl).restore(ArgumentMatchers.eq("bar"), ArgumentMatchers.any()); } @Test void testCacheRemove() { final String key = "foo"; Mockito.when(impl.digestToStorageKey(key)).thenReturn("bar"); Mockito.when(impl.delete( ArgumentMatchers.eq("bar"), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(1); callback.completed(true); return cancellable; }); impl.removeEntry(key, operationCallback); Mockito.verify(impl).delete("bar", operationCallback); Mockito.verify(operationCallback).completed(Boolean.TRUE); } @Test void testCacheUpdateNullEntry() { final String key = "foo"; final HttpCacheEntry updatedValue = HttpTestUtils.makeCacheEntry(); Mockito.when(impl.digestToStorageKey(key)).thenReturn("bar"); Mockito.when(impl.getForUpdateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(1); callback.completed(null); return cancellable; }); Mockito.when(impl.store( ArgumentMatchers.eq("bar"), ArgumentMatchers.any(), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(2); callback.completed(true); return cancellable; }); impl.updateEntry(key, existing -> { assertThat(existing, CoreMatchers.nullValue()); return updatedValue; }, operationCallback); Mockito.verify(impl).getForUpdateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.any()); Mockito.verify(impl).store(ArgumentMatchers.eq("bar"), ArgumentMatchers.any(), ArgumentMatchers.any()); Mockito.verify(operationCallback).completed(Boolean.TRUE); } @Test void testCacheCASUpdate() throws Exception { final String key = "foo"; final HttpCacheEntry existingValue = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry updatedValue = HttpTestUtils.makeCacheEntry(); Mockito.when(impl.digestToStorageKey(key)).thenReturn("bar"); Mockito.when(impl.getForUpdateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(1); callback.completed("stuff"); return cancellable; }); Mockito.when(impl.getStorageObject("stuff")).thenReturn(serialize(key, existingValue)); Mockito.when(impl.updateCAS( ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any(), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(3); callback.completed(true); return cancellable; }); impl.updateEntry(key, existing -> updatedValue, operationCallback); Mockito.verify(impl).getForUpdateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.any()); Mockito.verify(impl).getStorageObject("stuff"); Mockito.verify(impl).updateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any(), ArgumentMatchers.any()); Mockito.verify(operationCallback).completed(Boolean.TRUE); } @Test void testCacheCASUpdateKeyMismatch() throws Exception { final String key = "foo"; final HttpCacheEntry existingValue = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry updatedValue = HttpTestUtils.makeCacheEntry(); Mockito.when(impl.digestToStorageKey(key)).thenReturn("bar"); Mockito.when(impl.getForUpdateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.any())).thenAnswer( (Answer) invocation -> { final FutureCallback callback = invocation.getArgument(1); callback.completed("stuff"); return cancellable; }); Mockito.when(impl.getStorageObject("stuff")).thenReturn(serialize("not-foo", existingValue)); Mockito.when(impl.store( ArgumentMatchers.eq("bar"), ArgumentMatchers.any(), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(2); callback.completed(true); return cancellable; }); impl.updateEntry(key, existing -> { assertThat(existing, CoreMatchers.nullValue()); return updatedValue; }, operationCallback); Mockito.verify(impl).getForUpdateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.any()); Mockito.verify(impl).getStorageObject("stuff"); Mockito.verify(impl, Mockito.never()).updateCAS( ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any(), ArgumentMatchers.any()); Mockito.verify(impl).store(ArgumentMatchers.eq("bar"), ArgumentMatchers.any(), ArgumentMatchers.any()); Mockito.verify(operationCallback).completed(Boolean.TRUE); } @Test void testSingleCacheUpdateRetry() throws Exception { final String key = "foo"; final HttpCacheEntry existingValue = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry updatedValue = HttpTestUtils.makeCacheEntry(); Mockito.when(impl.digestToStorageKey(key)).thenReturn("bar"); Mockito.when(impl.getForUpdateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.any())).thenAnswer( (Answer) invocation -> { final FutureCallback callback = invocation.getArgument(1); callback.completed("stuff"); return cancellable; }); Mockito.when(impl.getStorageObject("stuff")).thenReturn(serialize(key, existingValue)); final AtomicInteger count = new AtomicInteger(0); Mockito.when(impl.updateCAS( ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any(), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(3); if (count.incrementAndGet() == 1) { callback.completed(false); } else { callback.completed(true); } return cancellable; }); impl.updateEntry(key, existing -> updatedValue, operationCallback); Mockito.verify(impl, Mockito.times(2)).getForUpdateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.any()); Mockito.verify(impl, Mockito.times(2)).getStorageObject("stuff"); Mockito.verify(impl, Mockito.times(2)).updateCAS( ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any(), ArgumentMatchers.any()); Mockito.verify(operationCallback).completed(Boolean.TRUE); } @Test void testCacheUpdateFail() throws Exception { final String key = "foo"; final HttpCacheEntry existingValue = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry updatedValue = HttpTestUtils.makeCacheEntry(); Mockito.when(impl.digestToStorageKey(key)).thenReturn("bar"); Mockito.when(impl.getForUpdateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.any())).thenAnswer( (Answer) invocation -> { final FutureCallback callback = invocation.getArgument(1); callback.completed("stuff"); return cancellable; }); Mockito.when(impl.getStorageObject("stuff")).thenReturn(serialize(key, existingValue)); final AtomicInteger count = new AtomicInteger(0); Mockito.when(impl.updateCAS( ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any(), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final FutureCallback callback = invocation.getArgument(3); if (count.incrementAndGet() <= 3) { callback.completed(false); } else { callback.completed(true); } return cancellable; }); impl.updateEntry(key, existing -> updatedValue, operationCallback); Mockito.verify(impl, Mockito.times(3)).getForUpdateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.any()); Mockito.verify(impl, Mockito.times(3)).getStorageObject("stuff"); Mockito.verify(impl, Mockito.times(3)).updateCAS( ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any(), ArgumentMatchers.any()); Mockito.verify(operationCallback).failed(ArgumentMatchers.any()); } @Test @SuppressWarnings("unchecked") void testBulkGet() { final String key1 = "foo this"; final String key2 = "foo that"; final String storageKey1 = "bar this"; final String storageKey2 = "bar that"; final HttpCacheEntry value1 = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry value2 = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key1)).thenReturn(storageKey1); when(impl.digestToStorageKey(key2)).thenReturn(storageKey2); when(impl.bulkRestore( ArgumentMatchers.anyCollection(), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final Collection keys = invocation.getArgument(0); final FutureCallback> callback = invocation.getArgument(1); final Map resultMap = new HashMap<>(); if (keys.contains(storageKey1)) { resultMap.put(storageKey1, serialize(key1, value1)); } if (keys.contains(storageKey2)) { resultMap.put(storageKey2, serialize(key2, value2)); } callback.completed(resultMap); return cancellable; }); impl.getEntries(Arrays.asList(key1, key2), bulkCacheEntryCallback); final ArgumentCaptor> argumentCaptor = ArgumentCaptor.forClass(Map.class); Mockito.verify(bulkCacheEntryCallback).completed(argumentCaptor.capture()); final Map entryMap = argumentCaptor.getValue(); assertThat(entryMap, CoreMatchers.notNullValue()); assertThat(entryMap.get(key1), HttpCacheEntryMatcher.equivalent(value1)); assertThat(entryMap.get(key2), HttpCacheEntryMatcher.equivalent(value2)); verify(impl, Mockito.times(2)).digestToStorageKey(key1); verify(impl, Mockito.times(2)).digestToStorageKey(key2); verify(impl).bulkRestore( ArgumentMatchers.eq(Arrays.asList(storageKey1, storageKey2)), ArgumentMatchers.any()); } @Test @SuppressWarnings("unchecked") void testBulkGetKeyMismatch() { final String key1 = "foo this"; final String key2 = "foo that"; final String storageKey1 = "bar this"; final String storageKey2 = "bar that"; final HttpCacheEntry value1 = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry value2 = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key1)).thenReturn(storageKey1); when(impl.digestToStorageKey(key2)).thenReturn(storageKey2); when(impl.bulkRestore( ArgumentMatchers.anyCollection(), ArgumentMatchers.any())).thenAnswer((Answer) invocation -> { final Collection keys = invocation.getArgument(0); final FutureCallback> callback = invocation.getArgument(1); final Map resultMap = new HashMap<>(); if (keys.contains(storageKey1)) { resultMap.put(storageKey1, serialize(key1, value1)); } if (keys.contains(storageKey2)) { resultMap.put(storageKey2, serialize("not foo", value2)); } callback.completed(resultMap); return cancellable; }); impl.getEntries(Arrays.asList(key1, key2), bulkCacheEntryCallback); final ArgumentCaptor> argumentCaptor = ArgumentCaptor.forClass(Map.class); Mockito.verify(bulkCacheEntryCallback).completed(argumentCaptor.capture()); final Map entryMap = argumentCaptor.getValue(); assertThat(entryMap, CoreMatchers.notNullValue()); assertThat(entryMap.get(key1), HttpCacheEntryMatcher.equivalent(value1)); assertThat(entryMap.get(key2), CoreMatchers.nullValue()); verify(impl, Mockito.times(2)).digestToStorageKey(key1); verify(impl, Mockito.times(2)).digestToStorageKey(key2); verify(impl).bulkRestore( ArgumentMatchers.eq(Arrays.asList(storageKey1, storageKey2)), ArgumentMatchers.any()); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestBasicHttpAsyncCache.java0100664 0000000 0000000 00000127107 14704162040 032046 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; 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.assertNull; import static org.junit.jupiter.api.Assertions.assertSame; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.verifyNoMoreInteractions; import java.net.URI; import java.time.Instant; import java.util.Collection; import java.util.HashSet; import java.util.Map; import java.util.Set; import java.util.concurrent.CountDownLatch; import java.util.concurrent.atomic.AtomicReference; import java.util.stream.Collectors; import org.apache.hc.client5.http.HeadersMatcher; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.util.ByteArrayBuffer; import org.hamcrest.MatcherAssert; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mockito; class TestBasicHttpAsyncCache { private HttpHost host; private Instant now; private Instant tenSecondsAgo; private SimpleHttpAsyncCacheStorage backing; private BasicHttpAsyncCache impl; @BeforeEach void setUp() { host = new HttpHost("foo.example.com"); now = Instant.now(); tenSecondsAgo = now.minusSeconds(10); backing = Mockito.spy(new SimpleHttpAsyncCacheStorage()); impl = new BasicHttpAsyncCache(HeapResourceFactory.INSTANCE, backing); } @Test void testGetCacheEntryReturnsNullOnCacheMiss() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest request = new HttpGet("http://foo.example.com/bar"); final CountDownLatch latch1 = new CountDownLatch(1); final AtomicReference resultRef = new AtomicReference<>(); impl.match(host, request, HttpTestUtils.countDown(latch1, resultRef::set)); latch1.await(); assertNull(resultRef.get()); } @Test void testGetCacheEntryFetchesFromCacheOnCacheHitIfNoVariants() throws Exception { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(); assertFalse(entry.hasVariants()); final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest request = new HttpGet("http://foo.example.com/bar"); final String key = CacheKeyGenerator.INSTANCE.generateKey(host, request); backing.map.put(key,entry); final CountDownLatch latch1 = new CountDownLatch(1); final AtomicReference resultRef = new AtomicReference<>(); impl.match(host, request, HttpTestUtils.countDown(latch1, resultRef::set)); latch1.await(); final CacheMatch result = resultRef.get(); assertNotNull(result); assertNotNull(result.hit); assertSame(entry, result.hit.entry); } @Test void testGetCacheEntryReturnsNullIfNoVariantInCache() throws Exception { final HttpRequest origRequest = new HttpGet("http://foo.example.com/bar"); origRequest.setHeader("Accept-Encoding","gzip"); final ByteArrayBuffer buf = HttpTestUtils.makeRandomBuffer(128); final HttpResponse origResponse = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); origResponse.setHeader("Date", DateUtils.formatStandardDate(now)); origResponse.setHeader("Cache-Control", "max-age=3600, public"); origResponse.setHeader("ETag", "\"etag\""); origResponse.setHeader("Vary", "Accept-Encoding"); origResponse.setHeader("Content-Encoding","gzip"); final CountDownLatch latch1 = new CountDownLatch(1); impl.store(host, origRequest, origResponse, buf, now, now, HttpTestUtils.countDown(latch1)); latch1.await(); final HttpRequest request = new HttpGet("http://foo.example.com/bar"); final CountDownLatch latch2 = new CountDownLatch(1); final AtomicReference resultRef = new AtomicReference<>(); impl.match(host, request, HttpTestUtils.countDown(latch2, resultRef::set)); latch2.await(); final CacheMatch result = resultRef.get(); assertNotNull(result); assertNull(result.hit); } @Test void testGetCacheEntryReturnsVariantIfPresentInCache() throws Exception { final HttpRequest origRequest = new HttpGet("http://foo.example.com/bar"); origRequest.setHeader("Accept-Encoding","gzip"); final ByteArrayBuffer buf = HttpTestUtils.makeRandomBuffer(128); final HttpResponse origResponse = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); origResponse.setHeader("Date", DateUtils.formatStandardDate(now)); origResponse.setHeader("Cache-Control", "max-age=3600, public"); origResponse.setHeader("ETag", "\"etag\""); origResponse.setHeader("Vary", "Accept-Encoding"); origResponse.setHeader("Content-Encoding","gzip"); final CountDownLatch latch1 = new CountDownLatch(1); impl.store(host, origRequest, origResponse, buf, now, now, HttpTestUtils.countDown(latch1)); latch1.await(); final HttpRequest request = new HttpGet("http://foo.example.com/bar"); request.setHeader("Accept-Encoding","gzip"); final CountDownLatch latch2 = new CountDownLatch(1); final AtomicReference resultRef = new AtomicReference<>(); impl.match(host, request, HttpTestUtils.countDown(latch2, resultRef::set)); latch2.await(); final CacheMatch result = resultRef.get(); assertNotNull(result); assertNotNull(result.hit); } @Test void testGetCacheEntryReturnsVariantWithMostRecentDateHeader() throws Exception { final HttpRequest origRequest = new HttpGet("http://foo.example.com/bar"); origRequest.setHeader("Accept-Encoding", "gzip"); final ByteArrayBuffer buf = HttpTestUtils.makeRandomBuffer(128); // Create two response variants with different Date headers final HttpResponse origResponse1 = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); origResponse1.setHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(now.minusSeconds(3600))); origResponse1.setHeader(HttpHeaders.CACHE_CONTROL, "max-age=3600, public"); origResponse1.setHeader(HttpHeaders.ETAG, "\"etag1\""); origResponse1.setHeader(HttpHeaders.VARY, "Accept-Encoding"); final HttpResponse origResponse2 = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); origResponse2.setHeader(HttpHeaders.DATE, DateUtils.formatStandardDate(now)); origResponse2.setHeader(HttpHeaders.CACHE_CONTROL, "max-age=3600, public"); origResponse2.setHeader(HttpHeaders.ETAG, "\"etag2\""); origResponse2.setHeader(HttpHeaders.VARY, "Accept-Encoding"); // Store the two variants in cache final CountDownLatch latch1 = new CountDownLatch(2); impl.store(host, origRequest, origResponse1, buf, now, now, HttpTestUtils.countDown(latch1)); impl.store(host, origRequest, origResponse2, buf, now, now, HttpTestUtils.countDown(latch1)); latch1.await(); final HttpRequest request = new HttpGet("http://foo.example.com/bar"); request.setHeader("Accept-Encoding", "gzip"); final CountDownLatch latch2 = new CountDownLatch(1); final AtomicReference resultRef = new AtomicReference<>(); impl.match(host, request, HttpTestUtils.countDown(latch2, resultRef::set)); latch2.await(); final CacheMatch result = resultRef.get(); assertNotNull(result); assertNotNull(result.hit); final HttpCacheEntry entry = result.hit.entry; assertNotNull(entry); // Retrieve the ETag header value from the original response and assert that // the returned cache entry has the same ETag value final String expectedEtag = origResponse2.getFirstHeader(HttpHeaders.ETAG).getValue(); final String actualEtag = entry.getFirstHeader(HttpHeaders.ETAG).getValue(); assertEquals(expectedEtag, actualEtag); } @Test void testGetVariantsRootNoVariants() throws Exception { final HttpCacheEntry root = HttpTestUtils.makeCacheEntry(); final CountDownLatch latch1 = new CountDownLatch(1); final AtomicReference> resultRef = new AtomicReference<>(); impl.getVariants(new CacheHit("root-key", root), HttpTestUtils.countDown(latch1, resultRef::set)); latch1.await(); final Collection variants = resultRef.get(); assertNotNull(variants); assertEquals(0, variants.size()); } @Test void testGetVariantsRootNonExistentVariants() throws Exception { final Set varinats = new HashSet<>(); varinats.add("variant1"); varinats.add("variant2"); final HttpCacheEntry root = HttpTestUtils.makeCacheEntry(varinats); final CountDownLatch latch1 = new CountDownLatch(1); final AtomicReference> resultRef = new AtomicReference<>(); impl.getVariants(new CacheHit("root-key", root), HttpTestUtils.countDown(latch1, resultRef::set)); latch1.await(); final Collection variants = resultRef.get(); assertNotNull(variants); assertEquals(0, variants.size()); } @Test void testGetVariantCacheEntriesReturnsAllVariants() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final URI uri = new URI("http://foo.example.com/bar"); final HttpRequest req1 = new HttpGet(uri); req1.setHeader("Accept-Encoding", "gzip"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(uri); final HttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "max-age=3600, public"); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Vary", "Accept-Encoding"); resp1.setHeader("Content-Encoding","gzip"); final HttpRequest req2 = new HttpGet(uri); req2.setHeader("Accept-Encoding", "identity"); final HttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600, public"); resp2.setHeader("ETag", "\"etag2\""); resp2.setHeader("Vary", "Accept-Encoding"); resp2.setHeader("Content-Encoding","gzip"); final CountDownLatch latch1 = new CountDownLatch(2); final AtomicReference resultRef1 = new AtomicReference<>(); final AtomicReference resultRef2 = new AtomicReference<>(); impl.store(host, req1, resp1, null, now, now, HttpTestUtils.countDown(latch1, resultRef1::set)); impl.store(host, req2, resp2, null, now, now, HttpTestUtils.countDown(latch1, resultRef2::set)); latch1.await(); final CacheHit hit1 = resultRef1.get(); final CacheHit hit2 = resultRef2.get(); final Set variants = new HashSet<>(); variants.add("{accept-encoding=gzip}"); variants.add("{accept-encoding=identity}"); final CountDownLatch latch2 = new CountDownLatch(1); final AtomicReference> resultRef3 = new AtomicReference<>(); impl.getVariants(new CacheHit(hit1.rootKey, HttpTestUtils.makeCacheEntry(variants)), HttpTestUtils.countDown(latch2, resultRef3::set)); latch2.await(); final Map variantMap = resultRef3.get().stream() .collect(Collectors.toMap(CacheHit::getEntryKey, e -> e.entry)); assertNotNull(variantMap); assertEquals(2, variantMap.size()); MatcherAssert.assertThat(variantMap.get("{accept-encoding=gzip}" + rootKey), HttpCacheEntryMatcher.equivalent(hit1.entry)); MatcherAssert.assertThat(variantMap.get("{accept-encoding=identity}" + rootKey), HttpCacheEntryMatcher.equivalent(hit2.entry)); } @Test void testUpdateCacheEntry() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final URI uri = new URI("http://foo.example.com/bar"); final HttpRequest req1 = new HttpGet(uri); final HttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "max-age=3600, public"); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Content-Encoding","gzip"); final HttpRequest revalidate = new HttpGet(uri); revalidate.setHeader("If-None-Match","\"etag1\""); final HttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600, public"); final CountDownLatch latch1 = new CountDownLatch(1); final AtomicReference resultRef1 = new AtomicReference<>(); impl.store(host, req1, resp1, null, now, now, HttpTestUtils.countDown(latch1, resultRef1::set)); latch1.await(); final CacheHit hit1 = resultRef1.get(); Assertions.assertNotNull(hit1); Assertions.assertEquals(1, backing.map.size()); Assertions.assertSame(hit1.entry, backing.map.get(hit1.getEntryKey())); final CountDownLatch latch2 = new CountDownLatch(1); final AtomicReference resultRef2 = new AtomicReference<>(); impl.update(hit1, host, req1, resp2, now, now, HttpTestUtils.countDown(latch2, resultRef2::set)); latch2.await(); final CacheHit updated = resultRef2.get(); Assertions.assertNotNull(updated); Assertions.assertEquals(1, backing.map.size()); Assertions.assertSame(updated.entry, backing.map.get(hit1.getEntryKey())); MatcherAssert.assertThat( updated.entry.getHeaders(), HeadersMatcher.same( new BasicHeader("Server", "MockOrigin/1.0"), new BasicHeader("ETag", "\"etag1\""), new BasicHeader("Content-Encoding","gzip"), new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("Cache-Control", "max-age=3600, public") )); } @Test void testUpdateVariantCacheEntry() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final URI uri = new URI("http://foo.example.com/bar"); final HttpRequest req1 = new HttpGet(uri); req1.setHeader("User-Agent", "agent1"); final HttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "max-age=3600, public"); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Content-Encoding","gzip"); resp1.setHeader("Vary", "User-Agent"); final HttpRequest revalidate = new HttpGet(uri); revalidate.setHeader("If-None-Match","\"etag1\""); final HttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600, public"); final CountDownLatch latch1 = new CountDownLatch(1); final AtomicReference resultRef1 = new AtomicReference<>(); impl.store(host, req1, resp1, null, now, now, HttpTestUtils.countDown(latch1, resultRef1::set)); latch1.await(); final CacheHit hit1 = resultRef1.get(); Assertions.assertNotNull(hit1); Assertions.assertEquals(2, backing.map.size()); Assertions.assertSame(hit1.entry, backing.map.get(hit1.getEntryKey())); final CountDownLatch latch2 = new CountDownLatch(1); final AtomicReference resultRef2 = new AtomicReference<>(); impl.update(hit1, host, req1, resp2, now, now, HttpTestUtils.countDown(latch2, resultRef2::set)); latch2.await(); final CacheHit updated = resultRef2.get(); Assertions.assertNotNull(updated); Assertions.assertEquals(2, backing.map.size()); Assertions.assertSame(updated.entry, backing.map.get(hit1.getEntryKey())); MatcherAssert.assertThat( updated.entry.getHeaders(), HeadersMatcher.same( new BasicHeader("Server", "MockOrigin/1.0"), new BasicHeader("ETag", "\"etag1\""), new BasicHeader("Content-Encoding","gzip"), new BasicHeader("Vary","User-Agent"), new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("Cache-Control", "max-age=3600, public") )); } @Test void testUpdateCacheEntryTurnsVariant() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final URI uri = new URI("http://foo.example.com/bar"); final HttpRequest req1 = new HttpGet(uri); req1.setHeader("User-Agent", "agent1"); final HttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "max-age=3600, public"); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Content-Encoding","gzip"); final HttpRequest revalidate = new HttpGet(uri); revalidate.setHeader("If-None-Match","\"etag1\""); final HttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600, public"); resp2.setHeader("Vary", "User-Agent"); final CountDownLatch latch1 = new CountDownLatch(1); final AtomicReference resultRef1 = new AtomicReference<>(); impl.store(host, req1, resp1, null, now, now, HttpTestUtils.countDown(latch1, resultRef1::set)); latch1.await(); final CacheHit hit1 = resultRef1.get(); Assertions.assertNotNull(hit1); Assertions.assertEquals(1, backing.map.size()); Assertions.assertSame(hit1.entry, backing.map.get(hit1.getEntryKey())); final CountDownLatch latch2 = new CountDownLatch(1); final AtomicReference resultRef2 = new AtomicReference<>(); impl.update(hit1, host, req1, resp2, now, now, HttpTestUtils.countDown(latch2, resultRef2::set)); latch2.await(); final CacheHit updated = resultRef2.get(); Assertions.assertNotNull(updated); Assertions.assertEquals(2, backing.map.size()); MatcherAssert.assertThat( updated.entry.getHeaders(), HeadersMatcher.same( new BasicHeader("Server", "MockOrigin/1.0"), new BasicHeader("ETag", "\"etag1\""), new BasicHeader("Content-Encoding","gzip"), new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("Cache-Control", "max-age=3600, public"), new BasicHeader("Vary","User-Agent"))); } @Test void testStoreFromNegotiatedVariant() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final URI uri = new URI("http://foo.example.com/bar"); final HttpRequest req1 = new HttpGet(uri); req1.setHeader("User-Agent", "agent1"); final HttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "max-age=3600, public"); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Content-Encoding","gzip"); resp1.setHeader("Vary", "User-Agent"); final CountDownLatch latch1 = new CountDownLatch(1); final AtomicReference resultRef1 = new AtomicReference<>(); impl.store(host, req1, resp1, null, now, now, HttpTestUtils.countDown(latch1, resultRef1::set)); latch1.await(); final CacheHit hit1 = resultRef1.get(); Assertions.assertNotNull(hit1); Assertions.assertEquals(2, backing.map.size()); Assertions.assertSame(hit1.entry, backing.map.get(hit1.getEntryKey())); final HttpRequest req2 = new HttpGet(uri); req2.setHeader("User-Agent", "agent2"); final HttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600, public"); final CountDownLatch latch2 = new CountDownLatch(1); final AtomicReference resultRef2 = new AtomicReference<>(); impl.storeFromNegotiated(hit1, host, req2, resp2, now, now, HttpTestUtils.countDown(latch2, resultRef2::set)); final CacheHit hit2 = resultRef2.get(); Assertions.assertNotNull(hit2); Assertions.assertEquals(3, backing.map.size()); MatcherAssert.assertThat( hit2.entry.getHeaders(), HeadersMatcher.same( new BasicHeader("Server", "MockOrigin/1.0"), new BasicHeader("ETag", "\"etag1\""), new BasicHeader("Content-Encoding","gzip"), new BasicHeader("Vary","User-Agent"), new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("Cache-Control", "max-age=3600, public"))); } @Test void testInvalidatesUnsafeRequests() throws Exception { final HttpRequest request = new BasicHttpRequest("POST", "/path"); final HttpResponse response = HttpTestUtils.make200Response(); final String key = CacheKeyGenerator.INSTANCE.generateKey(host, request); backing.putEntry(key, HttpTestUtils.makeCacheEntry()); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(key), Mockito.any()); verify(backing).removeEntry(Mockito.eq(key), Mockito.any()); Assertions.assertNull(backing.getEntry(key)); } @Test void testDoesNotInvalidateSafeRequests() throws Exception { final HttpRequest request1 = new BasicHttpRequest("GET", "/"); final HttpResponse response1 = HttpTestUtils.make200Response(); final CountDownLatch latch1 = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request1, response1, HttpTestUtils.countDown(latch1)); latch1.await(); verifyNoMoreInteractions(backing); final HttpRequest request2 = new BasicHttpRequest("HEAD", "/"); final HttpResponse response2 = HttpTestUtils.make200Response(); final CountDownLatch latch2 = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request2, response2, HttpTestUtils.countDown(latch2)); latch2.await(); verifyNoMoreInteractions(backing); } @Test void testInvalidatesUnsafeRequestsWithVariants() throws Exception { final HttpRequest request = new BasicHttpRequest("POST", "/path"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(host, request); final Set variants = new HashSet<>(); variants.add("{var1}"); variants.add("{var2}"); final String variantKey1 = "{var1}" + rootKey; final String variantKey2 = "{var2}" + rootKey; final HttpResponse response = HttpTestUtils.make200Response(); backing.putEntry(rootKey, HttpTestUtils.makeCacheEntry(variants)); backing.putEntry(variantKey1, HttpTestUtils.makeCacheEntry()); backing.putEntry(variantKey2, HttpTestUtils.makeCacheEntry()); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(rootKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(rootKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(variantKey1), Mockito.any()); verify(backing).removeEntry(Mockito.eq(variantKey2), Mockito.any()); Assertions.assertNull(backing.getEntry(rootKey)); Assertions.assertNull(backing.getEntry(variantKey1)); Assertions.assertNull(backing.getEntry(variantKey2)); } @Test void testInvalidateUriSpecifiedByContentLocationAndFresher() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(host, request); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(rootKey, HttpTestUtils.makeCacheEntry()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"old-etag\"") )); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(rootKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(rootKey), Mockito.any()); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(contentKey), Mockito.any()); } @Test void testInvalidateUriSpecifiedByLocationAndFresher() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(host, request); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Location", contentUri.toASCIIString()); backing.putEntry(rootKey, HttpTestUtils.makeCacheEntry()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"old-etag\"") )); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(rootKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(rootKey), Mockito.any()); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(contentKey), Mockito.any()); } @Test void testDoesNotInvalidateForUnsuccessfulResponse() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final HttpResponse response = HttpTestUtils.make500Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verifyNoMoreInteractions(backing); } @Test void testInvalidateUriSpecifiedByContentLocationNonCanonical() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(host, request); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(rootKey, HttpTestUtils.makeCacheEntry()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"old-etag\""))); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(rootKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(rootKey), Mockito.any()); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(contentKey), Mockito.any()); Assertions.assertNull(backing.getEntry(rootKey)); Assertions.assertNull(backing.getEntry(contentKey)); } @Test void testInvalidateUriSpecifiedByContentLocationRelative() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final String rootKey = CacheKeyGenerator.INSTANCE.generateKey(host, request); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", "/bar"); backing.putEntry(rootKey, HttpTestUtils.makeCacheEntry()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"old-etag\""))); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(rootKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(rootKey), Mockito.any()); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(contentKey), Mockito.any()); Assertions.assertNull(backing.getEntry(rootKey)); Assertions.assertNull(backing.getEntry(contentKey)); } @Test void testDoesNotInvalidateUriSpecifiedByContentLocationOtherOrigin() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/"); final URI contentUri = new URIBuilder() .setHost("bar.example.com") .setPath("/") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry()); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing, Mockito.never()).getEntry(contentKey); verify(backing, Mockito.never()).removeEntry(Mockito.eq(contentKey), Mockito.any()); } @Test void testDoesNotInvalidateUriSpecifiedByContentLocationIfEtagsMatch() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"same-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"same-etag\""))); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing, Mockito.never()).removeEntry(Mockito.eq(contentKey), Mockito.any()); } @Test void testDoesNotInvalidateUriSpecifiedByContentLocationIfOlder() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("ETag", "\"old-etag\""))); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing, Mockito.never()).removeEntry(Mockito.eq(contentKey), Mockito.any()); } @Test void testDoesNotInvalidateUriSpecifiedByContentLocationIfResponseHasNoEtag() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.removeHeaders("ETag"); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"old-etag\""))); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing, Mockito.never()).removeEntry(Mockito.eq(contentKey), Mockito.any()); } @Test void testDoesNotInvalidateUriSpecifiedByContentLocationIfEntryHasNoEtag() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag", "\"some-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)))); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing, Mockito.never()).removeEntry(Mockito.eq(contentKey), Mockito.any()); } @Test void testInvalidatesUriSpecifiedByContentLocationIfResponseHasNoDate() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag", "\"new-etag\""); response.removeHeaders("Date"); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("ETag", "\"old-etag\""), new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)))); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(contentKey), Mockito.any()); } @Test void testInvalidatesUriSpecifiedByContentLocationIfEntryHasNoDate() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("ETag", "\"old-etag\""))); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(contentKey), Mockito.any()); } @Test void testInvalidatesUriSpecifiedByContentLocationIfResponseHasMalformedDate() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", "huh?"); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("ETag", "\"old-etag\""), new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)))); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(contentKey), Mockito.any()); } @Test void testInvalidatesUriSpecifiedByContentLocationIfEntryHasMalformedDate() throws Exception { final HttpRequest request = new BasicHttpRequest("PUT", "/foo"); final URI contentUri = new URIBuilder() .setHttpHost(host) .setPath("/bar") .build(); final String contentKey = CacheKeyGenerator.INSTANCE.generateKey(contentUri); final HttpResponse response = HttpTestUtils.make200Response(); response.setHeader("ETag","\"new-etag\""); response.setHeader("Date", DateUtils.formatStandardDate(now)); response.setHeader("Content-Location", contentUri.toASCIIString()); backing.putEntry(contentKey, HttpTestUtils.makeCacheEntry( new BasicHeader("ETag", "\"old-etag\""), new BasicHeader("Date", "huh?"))); final CountDownLatch latch = new CountDownLatch(1); impl.evictInvalidatedEntries(host, request, response, HttpTestUtils.countDown(latch)); latch.await(); verify(backing).getEntry(Mockito.eq(contentKey), Mockito.any()); verify(backing).removeEntry(Mockito.eq(contentKey), Mockito.any()); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestFileResourceFactory.java0100664 0000000 0000000 00000005707 14704162040 032163 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.net.URI; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestFileResourceFactory { CacheKeyGenerator keyGenerator; @BeforeEach void setUp() { keyGenerator = new CacheKeyGenerator(); } @Test void testViaValueLookup() throws Exception { final String requestId = keyGenerator.generateKey(new URI("http://localhost/stuff")); Assertions.assertEquals( "blah%20blah@http%3A%2F%2Flocalhost%3A80%2Fstuff", FileResourceFactory.generateUniqueCacheFileName(requestId, "blah blah", null, 0, 0)); Assertions.assertEquals( "blah-blah@http%3A%2F%2Flocalhost%3A80%2Fstuff", FileResourceFactory.generateUniqueCacheFileName(requestId, "blah-blah", null, 0, 0)); Assertions.assertEquals( "blah%40blah@http%3A%2F%2Flocalhost%3A80%2Fstuff", FileResourceFactory.generateUniqueCacheFileName(requestId, "blah@blah", null, 0, 0)); Assertions.assertEquals( "039058c6f2c0cb492c533b0a4d14ef77cc0f78abccced5287d84a1a2011cfb81@http%3A%2F%2Flocalhost%3A80%2Fstuff", FileResourceFactory.generateUniqueCacheFileName(requestId, null, new byte[]{1, 2, 3}, 0, 3)); Assertions.assertEquals( "039058c6f2c0cb492c533b0a4d14ef77cc0f78abccced5287d84a1a2011cfb81@http%3A%2F%2Flocalhost%3A80%2Fstuff", FileResourceFactory.generateUniqueCacheFileName(requestId, null, new byte[]{1, 2, 3, 4, 5}, 0, 3)); Assertions.assertEquals( "http%3A%2F%2Flocalhost%3A80%2Fstuff", FileResourceFactory.generateUniqueCacheFileName(requestId, null, null, 0, 0)); } } ././@LongLink0100644 0000000 0000000 00000000153 14704162040 011630 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCachedHttpResponseGenerator.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCachedHttpResponseGenerato0100664 0000000 0000000 00000012562 14704162040 032534 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.mockito.ArgumentMatchers.isA; import static org.mockito.ArgumentMatchers.same; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import java.time.Instant; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @SuppressWarnings({"boxing","static-access"}) // test code class TestCachedHttpResponseGenerator { private HttpCacheEntry entry; private ClassicHttpRequest request; private CacheValidityPolicy mockValidityPolicy; private CachedHttpResponseGenerator impl; @BeforeEach void setUp() { entry = HttpTestUtils.makeCacheEntry(); request = HttpTestUtils.makeDefaultRequest(); mockValidityPolicy = mock(CacheValidityPolicy.class); impl = new CachedHttpResponseGenerator(mockValidityPolicy); } @Test void testResponseHasContentLength() throws Exception { final byte[] buf = new byte[] { 1, 2, 3, 4, 5 }; final HttpCacheEntry entry1 = HttpTestUtils.makeCacheEntry(buf); final SimpleHttpResponse response = impl.generateResponse(request, entry1); final Header length = response.getFirstHeader("Content-Length"); Assertions.assertNotNull(length, "Content-Length Header is missing"); Assertions.assertEquals(buf.length, Integer.parseInt(length.getValue()), "Content-Length does not match buffer length"); } @Test void testResponseStatusCodeMatchesCacheEntry() throws Exception { final SimpleHttpResponse response = impl.generateResponse(request, entry); Assertions.assertEquals(entry.getStatus(), response.getCode()); } @Test void testAgeHeaderIsPopulatedWithCurrentAgeOfCacheEntryIfNonZero() throws Exception { currentAge(TimeValue.ofSeconds(10L)); final SimpleHttpResponse response = impl.generateResponse(request, entry); verify(mockValidityPolicy).getCurrentAge(same(entry), isA(Instant.class)); final Header ageHdr = response.getFirstHeader("Age"); Assertions.assertNotNull(ageHdr); Assertions.assertEquals(10L, Long.parseLong(ageHdr.getValue())); } @Test void testAgeHeaderIsNotPopulatedIfCurrentAgeOfCacheEntryIsZero() throws Exception { currentAge(TimeValue.ofSeconds(0L)); final SimpleHttpResponse response = impl.generateResponse(request, entry); verify(mockValidityPolicy).getCurrentAge(same(entry), isA(Instant.class)); final Header ageHdr = response.getFirstHeader("Age"); Assertions.assertNull(ageHdr); } @Test void testAgeHeaderIsPopulatedWithMaxAgeIfCurrentAgeTooBig() throws Exception { currentAge(TimeValue.ofSeconds(CacheSupport.MAX_AGE.toSeconds() + 1L)); final SimpleHttpResponse response = impl.generateResponse(request, entry); verify(mockValidityPolicy).getCurrentAge(same(entry), isA(Instant.class)); final Header ageHdr = response.getFirstHeader("Age"); Assertions.assertNotNull(ageHdr); Assertions.assertEquals(CacheSupport.MAX_AGE.toSeconds(), Long.parseLong(ageHdr.getValue())); } private void currentAge(final TimeValue age) { when( mockValidityPolicy.getCurrentAge(same(entry), isA(Instant.class))).thenReturn(age); } @Test void testResponseContainsEntityToServeGETRequestIfEntryContainsResource() throws Exception { final SimpleHttpResponse response = impl.generateResponse(request, entry); Assertions.assertNotNull(response.getBody()); } @Test void testResponseDoesNotContainEntityToServeHEADRequestIfEntryContainsResource() throws Exception { final ClassicHttpRequest headRequest = HttpTestUtils.makeDefaultHEADRequest(); final SimpleHttpResponse response = impl.generateResponse(headRequest, entry); Assertions.assertNull(response.getBody()); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/ContainsHeaderMatcher.java0100664 0000000 0000000 00000005237 14704162040 031575 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.Iterator; import java.util.Objects; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.MessageHeaders; import org.hamcrest.BaseMatcher; import org.hamcrest.Description; import org.hamcrest.Matcher; public class ContainsHeaderMatcher extends BaseMatcher { private final String headerName; private final Object headerValue; public ContainsHeaderMatcher(final String headerName, final Object headerValue) { this.headerName = headerName; this.headerValue = headerValue; } @Override public boolean matches(final Object item) { if (item instanceof MessageHeaders) { final MessageHeaders messageHeaders = (MessageHeaders) item; for (final Iterator
it = messageHeaders.headerIterator(); it.hasNext(); ) { final Header header = it.next(); if (headerName.equalsIgnoreCase(header.getName()) && Objects.equals(headerValue, header.getValue())) { return true; } } } return false; } @Override public void describeTo(final Description description) { description.appendText("contains header ").appendValue(headerName).appendText(": ").appendValue(headerValue); } public static Matcher contains(final String headerName, final Object headerValue) { return new ContainsHeaderMatcher(headerName, headerValue); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestRFC5861Compliance.java0100664 0000000 0000000 00000024004 15005672016 031170 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotEquals; import static org.junit.jupiter.api.Assertions.assertTrue; import java.io.ByteArrayInputStream; import java.io.IOException; import java.time.Instant; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.ScheduledThreadPoolExecutor; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; /** * A suite of acceptance tests for compliance with RFC5861, which * describes the stale-if-error and stale-while-revalidate * Cache-Control extensions. */ class TestRFC5861Compliance { static final int MAX_BYTES = 1024; static final int MAX_ENTRIES = 100; static final int ENTITY_LENGTH = 128; HttpHost host; HttpRoute route; HttpEntity body; HttpCacheContext context; @Mock ExecChain mockExecChain; @Mock ExecRuntime mockExecRuntime; ClassicHttpRequest request; ClassicHttpResponse originResponse; CacheConfig config; CachingExec impl; HttpCache cache; ScheduledExecutorService executorService; @BeforeEach void setUp() throws Exception { MockitoAnnotations.openMocks(this); host = new HttpHost("foo.example.com", 80); route = new HttpRoute(host); body = HttpTestUtils.makeBody(ENTITY_LENGTH); request = new BasicClassicHttpRequest("GET", "/foo"); context = HttpCacheContext.create(); originResponse = HttpTestUtils.make200Response(); config = CacheConfig.custom() .setMaxCacheEntries(MAX_ENTRIES) .setMaxObjectSize(MAX_BYTES) .build(); cache = new BasicHttpCache(config); impl = new CachingExec(cache, null, config); executorService = new ScheduledThreadPoolExecutor(1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); Mockito.when(mockExecRuntime.fork(null)).thenReturn(mockExecRuntime); } @AfterEach void cleanup() { executorService.shutdownNow(); } public ClassicHttpResponse execute(final ClassicHttpRequest request) throws IOException, HttpException { return impl.execute( ClassicRequestBuilder.copy(request).build(), new ExecChain.Scope("test", route, request, mockExecRuntime, context), mockExecChain); } @Test void testConsumesErrorResponseWhenServingStale() throws Exception { final Instant tenSecondsAgo = Instant.now().minusSeconds(10); final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(tenSecondsAgo, "public, max-age=5, stale-if-error=60"); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp2 = HttpTestUtils.make500Response(); final byte[] body101 = HttpTestUtils.makeRandomBytes(101); final ByteArrayInputStream cis = Mockito.spy(new ByteArrayInputStream(body101)); final HttpEntity entity = new InputStreamEntity(cis, 101, null); resp2.setEntity(entity); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); Mockito.verify(cis).close(); } @Test void testStaleIfErrorInResponseYieldsToMustRevalidate() throws Exception { final Instant tenSecondsAgo = Instant.now().minusSeconds(10); final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(tenSecondsAgo, "public, max-age=5, stale-if-error=60, must-revalidate"); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp2 = HttpTestUtils.make500Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); assertNotEquals(HttpStatus.SC_OK, result.getCode()); } @Test void testStaleIfErrorInResponseYieldsToProxyRevalidateForSharedCache() throws Exception { assertTrue(config.isSharedCache()); final Instant tenSecondsAgo = Instant.now().minusSeconds(10); final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(tenSecondsAgo, "public, max-age=5, stale-if-error=60, proxy-revalidate"); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp2 = HttpTestUtils.make500Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); assertNotEquals(HttpStatus.SC_OK, result.getCode()); } @Test void testStaleIfErrorInResponseYieldsToExplicitFreshnessRequest() throws Exception { final Instant tenSecondsAgo = Instant.now().minusSeconds(10); final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(tenSecondsAgo, "public, max-age=5, stale-if-error=60"); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader("Cache-Control","min-fresh=2"); final ClassicHttpResponse resp2 = HttpTestUtils.make500Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); assertNotEquals(HttpStatus.SC_OK, result.getCode()); } @Test void testStaleIfErrorInResponseIsFalseReturnsError() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(tenSecondsAgo, "public, max-age=5, stale-if-error=2"); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp2 = HttpTestUtils.make500Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); assertEquals(HttpStatus.SC_INTERNAL_SERVER_ERROR, result.getCode()); } @Test void testStaleIfErrorInRequestIsFalseReturnsError() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(tenSecondsAgo, "public, max-age=5"); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader("Cache-Control","stale-if-error=2"); final ClassicHttpResponse resp2 = HttpTestUtils.make500Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); assertEquals(HttpStatus.SC_INTERNAL_SERVER_ERROR, result.getCode()); } } ././@LongLink0100644 0000000 0000000 00000000151 14704162040 011626 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestConditionalRequestBuilder.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestConditionalRequestBuilder.0100664 0000000 0000000 00000027731 14704162040 032526 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.time.Instant; import java.util.ArrayList; import java.util.Arrays; import java.util.Iterator; import java.util.List; import org.apache.hc.client5.http.HeadersMatcher; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.hamcrest.MatcherAssert; import org.hamcrest.Matchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestConditionalRequestBuilder { private ConditionalRequestBuilder impl; private HttpRequest request; @BeforeEach void setUp() { impl = new ConditionalRequestBuilder<>(request -> BasicRequestBuilder.copy(request).build()); request = new BasicHttpRequest("GET", "/"); } @Test void testBuildConditionalRequestWithLastModified() { final String theMethod = "GET"; final String theUri = "/theuri"; final String lastModified = "this is my last modified date"; final HttpRequest basicRequest = new BasicHttpRequest(theMethod, theUri); basicRequest.addHeader("Accept-Encoding", "gzip"); final Header[] headers = new Header[] { new BasicHeader("Date", DateUtils.formatStandardDate(Instant.now())), new BasicHeader("Last-Modified", lastModified) }; final HttpCacheEntry cacheEntry = HttpTestUtils.makeCacheEntry(headers); final ResponseCacheControl cacheControl = ResponseCacheControl.builder().build(); final HttpRequest newRequest = impl.buildConditionalRequest(cacheControl, basicRequest, cacheEntry); Assertions.assertEquals(theMethod, newRequest.getMethod()); Assertions.assertEquals(theUri, newRequest.getRequestUri()); Assertions.assertEquals(2, newRequest.getHeaders().length); MatcherAssert.assertThat( newRequest.getHeaders(), HeadersMatcher.same( new BasicHeader("Accept-Encoding", "gzip"), new BasicHeader("If-Modified-Since", lastModified))); } @Test void testConditionalRequestForEntryWithLastModifiedAndEtagIncludesBothAsValidators() { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final Instant twentySecondsAgo = now.plusSeconds(20); final String lmDate = DateUtils.formatStandardDate(twentySecondsAgo); final String etag = "\"etag\""; final Header[] headers = { new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("Last-Modified", lmDate), new BasicHeader("ETag", etag) }; final HttpRequest basicRequest = new BasicHttpRequest("GET", "/"); final HttpCacheEntry cacheEntry = HttpTestUtils.makeCacheEntry(headers); final ResponseCacheControl cacheControl = ResponseCacheControl.builder().build(); final HttpRequest result = impl.buildConditionalRequest(cacheControl, basicRequest, cacheEntry); Assertions.assertEquals(lmDate, result.getFirstHeader("If-Modified-Since").getValue()); Assertions.assertEquals(etag, result.getFirstHeader("If-None-Match").getValue()); } @Test void testBuildConditionalRequestWithETag() { final String theMethod = "GET"; final String theUri = "/theuri"; final String theETag = "\"this is my eTag\""; final HttpRequest basicRequest = new BasicHttpRequest(theMethod, theUri); basicRequest.addHeader("Accept-Encoding", "gzip"); final Instant now = Instant.now(); final Header[] headers = new Header[] { new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("Last-Modified", DateUtils.formatStandardDate(now)), new BasicHeader("ETag", theETag) }; final HttpCacheEntry cacheEntry = HttpTestUtils.makeCacheEntry(headers); final ResponseCacheControl cacheControl = ResponseCacheControl.builder().build(); final HttpRequest newRequest = impl.buildConditionalRequest(cacheControl, basicRequest, cacheEntry); Assertions.assertEquals(theMethod, newRequest.getMethod()); Assertions.assertEquals(theUri, newRequest.getRequestUri()); MatcherAssert.assertThat( newRequest.getHeaders(), HeadersMatcher.same( new BasicHeader("Accept-Encoding", "gzip"), new BasicHeader("If-None-Match", theETag), new BasicHeader("If-Modified-Since", DateUtils.formatStandardDate(now)))); } @Test void testCacheEntryWithMustRevalidateDoesEndToEndRevalidation() { final HttpRequest basicRequest = new BasicHttpRequest("GET","/"); final Instant now = Instant.now(); final Instant elevenSecondsAgo = now.minusSeconds(11); final Instant tenSecondsAgo = now.minusSeconds(10); final Instant nineSecondsAgo = now.plusSeconds(9); final Header[] cacheEntryHeaders = new Header[] { new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"etag\"") }; final HttpCacheEntry cacheEntry = HttpTestUtils.makeCacheEntry(elevenSecondsAgo, nineSecondsAgo, cacheEntryHeaders); final ResponseCacheControl responseCacheControl = ResponseCacheControl.builder() .setMaxAge(5) .setMustRevalidate(true) .build(); final HttpRequest result = impl.buildConditionalRequest(responseCacheControl, basicRequest, cacheEntry); final RequestCacheControl requestCacheControl = CacheControlHeaderParser.INSTANCE.parse(result); Assertions.assertEquals(0, requestCacheControl.getMaxAge()); } @Test void testCacheEntryWithProxyRevalidateDoesEndToEndRevalidation() { final HttpRequest basicRequest = new BasicHttpRequest("GET", "/"); final Instant now = Instant.now(); final Instant elevenSecondsAgo = now.minusSeconds(11); final Instant tenSecondsAgo = now.minusSeconds(10); final Instant nineSecondsAgo = now.plusSeconds(9); final Header[] cacheEntryHeaders = new Header[] { new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("ETag", "\"etag\"") }; final HttpCacheEntry cacheEntry = HttpTestUtils.makeCacheEntry(elevenSecondsAgo, nineSecondsAgo, cacheEntryHeaders); final ResponseCacheControl responseCacheControl = ResponseCacheControl.builder() .setMaxAge(5) .setProxyRevalidate(true) .build(); final HttpRequest result = impl.buildConditionalRequest(responseCacheControl, basicRequest, cacheEntry); final RequestCacheControl requestCacheControl = CacheControlHeaderParser.INSTANCE.parse(result); Assertions.assertEquals(0, requestCacheControl.getMaxAge()); } @Test void testBuildUnconditionalRequestUsesGETMethod() { final HttpRequest result = impl.buildUnconditionalRequest(request); Assertions.assertEquals("GET", result.getMethod()); } @Test void testBuildUnconditionalRequestUsesRequestUri() { final String uri = "/theURI"; request = new BasicHttpRequest("GET", uri); final HttpRequest result = impl.buildUnconditionalRequest(request); Assertions.assertEquals(uri, result.getRequestUri()); } @Test void testBuildUnconditionalRequestAddsCacheControlNoCache() { final HttpRequest result = impl.buildUnconditionalRequest(request); final RequestCacheControl requestCacheControl = CacheControlHeaderParser.INSTANCE.parse(result); Assertions.assertTrue(requestCacheControl.isNoCache()); } @Test void testBuildUnconditionalRequestDoesNotUseIfRange() { request.addHeader("If-Range","\"etag\""); final HttpRequest result = impl.buildUnconditionalRequest(request); Assertions.assertNull(result.getFirstHeader("If-Range")); } @Test void testBuildUnconditionalRequestDoesNotUseIfMatch() { request.addHeader("If-Match","\"etag\""); final HttpRequest result = impl.buildUnconditionalRequest(request); Assertions.assertNull(result.getFirstHeader("If-Match")); } @Test void testBuildUnconditionalRequestDoesNotUseIfNoneMatch() { request.addHeader("If-None-Match","\"etag\""); final HttpRequest result = impl.buildUnconditionalRequest(request); Assertions.assertNull(result.getFirstHeader("If-None-Match")); } @Test void testBuildUnconditionalRequestDoesNotUseIfUnmodifiedSince() { request.addHeader("If-Unmodified-Since", DateUtils.formatStandardDate(Instant.now())); final HttpRequest result = impl.buildUnconditionalRequest(request); Assertions.assertNull(result.getFirstHeader("If-Unmodified-Since")); } @Test void testBuildUnconditionalRequestDoesNotUseIfModifiedSince() { request.addHeader("If-Modified-Since", DateUtils.formatStandardDate(Instant.now())); final HttpRequest result = impl.buildUnconditionalRequest(request); Assertions.assertNull(result.getFirstHeader("If-Modified-Since")); } @Test void testBuildUnconditionalRequestCarriesOtherRequestHeaders() { request.addHeader("User-Agent","MyBrowser/1.0"); final HttpRequest result = impl.buildUnconditionalRequest(request); Assertions.assertEquals("MyBrowser/1.0", result.getFirstHeader("User-Agent").getValue()); } @Test void testBuildConditionalRequestFromVariants() { final ETag etag1 = new ETag("123"); final ETag etag2 = new ETag("456"); final ETag etag3 = new ETag("789"); final List variantEntries = Arrays.asList(etag1, etag2, etag3); final HttpRequest conditional = impl.buildConditionalRequestFromVariants(request, variantEntries); final Iterator it = MessageSupport.iterateTokens(conditional, HttpHeaders.IF_NONE_MATCH); final List etags = new ArrayList<>(); while (it.hasNext()) { etags.add(ETag.parse(it.next())); } MatcherAssert.assertThat(etags, Matchers.containsInAnyOrder(etag1, etag2, etag3)); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCacheValidityPolicy.java0100664 0000000 0000000 00000031616 15005672016 032137 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertTrue; import java.time.Instant; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestCacheValidityPolicy { private CacheValidityPolicy impl; private Instant now; private Instant oneSecondAgo; private Instant sixSecondsAgo; private Instant tenSecondsAgo; private Instant elevenSecondsAgo; @BeforeEach void setUp() { impl = new CacheValidityPolicy(); now = Instant.now(); oneSecondAgo = now.minusSeconds(1); sixSecondsAgo = now.minusSeconds(6); tenSecondsAgo = now.minusSeconds(10); elevenSecondsAgo = now.minusSeconds(11); } @Test void testApparentAgeIsMaxIntIfDateHeaderNotPresent() { final Header[] headers = { new BasicHeader("Server", "MockServer/1.0") }; final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(headers); assertEquals(CacheSupport.MAX_AGE, impl.getApparentAge(entry)); } @Test void testApparentAgeIsResponseReceivedTimeLessDateHeader() { final Header[] headers = new Header[] { new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)) }; final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(now, sixSecondsAgo, headers); assertEquals(TimeValue.ofSeconds(4), impl.getApparentAge(entry)); } @Test void testNegativeApparentAgeIsBroughtUpToZero() { final Header[] headers = new Header[] { new BasicHeader("Date", DateUtils.formatStandardDate(sixSecondsAgo)) }; final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(now, tenSecondsAgo, headers); assertEquals(TimeValue.ofSeconds(0), impl.getApparentAge(entry)); } @Test void testCorrectedReceivedAgeIsAgeHeaderIfLarger() { final Header[] headers = new Header[] { new BasicHeader("Age", "10"), }; final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(headers); impl = new CacheValidityPolicy() { @Override protected TimeValue getApparentAge(final HttpCacheEntry ent) { return TimeValue.ofSeconds(6); } }; assertEquals(TimeValue.ofSeconds(10), impl.getCorrectedAgeValue(entry)); } @Test void testGetCorrectedAgeValue() { final Header[] headers = new Header[] { new BasicHeader("Age", "6"), }; final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(headers); assertEquals(TimeValue.ofSeconds(6), impl.getCorrectedAgeValue(entry)); } @Test void testResponseDelayIsDifferenceBetweenResponseAndRequestTimes() { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(tenSecondsAgo, sixSecondsAgo); assertEquals(TimeValue.ofSeconds(4), impl.getResponseDelay(entry)); } @Test void testCorrectedInitialAgeIsCorrectedReceivedAgePlusResponseDelay() { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(); impl = new CacheValidityPolicy() { @Override protected TimeValue getCorrectedAgeValue(final HttpCacheEntry ent) { return TimeValue.ofSeconds(7); } @Override protected TimeValue getResponseDelay(final HttpCacheEntry ent) { return TimeValue.ofSeconds(13); } }; assertEquals(TimeValue.ofSeconds(7), impl.getCorrectedInitialAge(entry)); } @Test void testResidentTimeSecondsIsTimeSinceResponseTime() { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(now, sixSecondsAgo); assertEquals(TimeValue.ofSeconds(6), impl.getResidentTime(entry, now)); } @Test void testCurrentAgeIsCorrectedInitialAgePlusResidentTime() { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(); impl = new CacheValidityPolicy() { @Override protected TimeValue getCorrectedInitialAge(final HttpCacheEntry ent) { return TimeValue.ofSeconds(11); } @Override protected TimeValue getResidentTime(final HttpCacheEntry ent, final Instant d) { return TimeValue.ofSeconds(17); } }; assertEquals(TimeValue.ofSeconds(28), impl.getCurrentAge(entry, Instant.now())); } @Test void testFreshnessLifetimeIsSMaxAgeIfPresent() { final ResponseCacheControl cacheControl = ResponseCacheControl.builder() .setSharedMaxAge(10) .setMaxAge(5) .build(); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(); assertEquals(TimeValue.ofSeconds(10), impl.getFreshnessLifetime(cacheControl, entry)); } @Test void testSMaxAgeIsIgnoredWhenNotShared() { final CacheConfig cacheConfig = CacheConfig.custom() .setSharedCache(false) .build(); impl = new CacheValidityPolicy(cacheConfig); final ResponseCacheControl cacheControl = ResponseCacheControl.builder() .setSharedMaxAge(10) .setMaxAge(5) .build(); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(); assertEquals(TimeValue.ofSeconds(5), impl.getFreshnessLifetime(cacheControl, entry)); } @Test void testFreshnessLifetimeIsMaxAgeIfPresent() { final ResponseCacheControl cacheControl = ResponseCacheControl.builder() .setMaxAge(10) .build(); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(); assertEquals(TimeValue.ofSeconds(10), impl.getFreshnessLifetime(cacheControl, entry)); } @Test void testFreshnessLifetimeUsesSharedMaxAgeInSharedCache() { // assuming impl represents a shared cache final ResponseCacheControl cacheControl = ResponseCacheControl.builder() .setMaxAge(10) .setSharedMaxAge(20) .build(); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(); assertEquals(TimeValue.ofSeconds(20), impl.getFreshnessLifetime(cacheControl, entry)); } @Test void testFreshnessLifetimeUsesMaxAgeWhenSharedMaxAgeNotPresent() { // assuming impl represents a shared cache final ResponseCacheControl cacheControl = ResponseCacheControl.builder() .setMaxAge(10) .build(); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(); assertEquals(TimeValue.ofSeconds(10), impl.getFreshnessLifetime(cacheControl, entry)); } @Test void testFreshnessLifetimeIsMaxAgeEvenIfExpiresIsPresent() { final ResponseCacheControl cacheControl = ResponseCacheControl.builder() .setMaxAge(10) .build(); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("Expires", DateUtils.formatStandardDate(sixSecondsAgo))); assertEquals(TimeValue.ofSeconds(10), impl.getFreshnessLifetime(cacheControl, entry)); } @Test void testFreshnessLifetimeIsSMaxAgeEvenIfExpiresIsPresent() { final ResponseCacheControl cacheControl = ResponseCacheControl.builder() .setSharedMaxAge(10) .build(); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("Expires", DateUtils.formatStandardDate(sixSecondsAgo))); assertEquals(TimeValue.ofSeconds(10), impl.getFreshnessLifetime(cacheControl, entry)); } @Test void testFreshnessLifetimeIsFromExpiresHeaderIfNoMaxAge() { final ResponseCacheControl cacheControl = ResponseCacheControl.builder() .build(); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("Expires", DateUtils.formatStandardDate(sixSecondsAgo))); assertEquals(TimeValue.ofSeconds(4), impl.getFreshnessLifetime(cacheControl, entry)); } @Test void testHeuristicFreshnessLifetime() { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(oneSecondAgo)), new BasicHeader("Last-Modified", DateUtils.formatStandardDate(elevenSecondsAgo))); assertEquals(TimeValue.ofSeconds(1), impl.getHeuristicFreshnessLifetime(entry)); } @Test void testHeuristicFreshnessLifetimeDefaultsProperly() { final TimeValue defaultFreshness = TimeValue.ofSeconds(0); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(); assertEquals(defaultFreshness, impl.getHeuristicFreshnessLifetime(entry)); } @Test void testHeuristicFreshnessLifetimeIsNonNegative() { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Date", DateUtils.formatStandardDate(elevenSecondsAgo)), new BasicHeader("Last-Modified", DateUtils.formatStandardDate(oneSecondAgo))); assertTrue(TimeValue.isNonNegative(impl.getHeuristicFreshnessLifetime(entry))); } @Test void testHeuristicFreshnessLifetimeCustomProperly() { final CacheConfig cacheConfig = CacheConfig.custom().setHeuristicDefaultLifetime(TimeValue.ofSeconds(10)) .setHeuristicCoefficient(0.5f).build(); impl = new CacheValidityPolicy(cacheConfig); final TimeValue defaultFreshness = TimeValue.ofSeconds(10); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(); assertEquals(defaultFreshness, impl.getHeuristicFreshnessLifetime(entry)); } @Test void testNegativeAgeHeaderValueReturnsZero() { final Header[] headers = new Header[] { new BasicHeader("Age", "-100") }; final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(headers); // in seconds assertEquals(0, impl.getAgeValue(entry)); } @Test void testMalformedAgeHeaderValueReturnsMaxAge() { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Age", "asdf")); // in seconds assertEquals(0, impl.getAgeValue(entry)); } @Test void testMalformedAgeHeaderMultipleWellFormedAges() { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Age", "123,456,789")); // in seconds assertEquals(123, impl.getAgeValue(entry)); } @Test void testMalformedAgeHeaderMultiplesMalformedAges() { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Age", "123 456 789")); // in seconds assertEquals(0, impl.getAgeValue(entry)); } @Test void testMalformedAgeHeaderNegativeAge() { final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Age", "-123")); // in seconds assertEquals(0, impl.getAgeValue(entry)); } @Test void testMalformedAgeHeaderOverflow() { final String reallyOldAge = "1" + Long.MAX_VALUE; final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry( new BasicHeader("Age", reallyOldAge)); // Expect the age value to be 0 in case of overflow assertEquals(0, impl.getAgeValue(entry)); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/CacheControlParserTest.java0100664 0000000 0000000 00000027234 14704162040 031764 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.junit.jupiter.api.Assertions.assertAll; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertTrue; import java.util.Arrays; import java.util.Collections; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.message.BasicHeader; import org.junit.jupiter.api.Test; class CacheControlParserTest { private final CacheControlHeaderParser parser = CacheControlHeaderParser.INSTANCE; @Test void testParseMaxAgeZero() { final Header header = new BasicHeader("Cache-Control", "max-age=0 , this = stuff;"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertEquals(0L, cacheControl.getMaxAge()); } @Test void testParseSMaxAge() { final Header header = new BasicHeader("Cache-Control", "s-maxage=3600"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertEquals(3600L, cacheControl.getSharedMaxAge()); } @Test void testParseInvalidCacheValue() { final Header header = new BasicHeader("Cache-Control", "max-age=invalid"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertEquals(0L, cacheControl.getMaxAge()); } @Test void testParseInvalidHeader() { final Header header = new BasicHeader("Cache-Control", "max-age"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertEquals(-1L, cacheControl.getMaxAge()); } @Test void testParseNullHeader() { final Header header = null; assertThrows(NullPointerException.class, () -> parser.parseResponse(Collections.singletonList(header).iterator())); } @Test void testParseEmptyHeader() { final Header header = new BasicHeader("Cache-Control", ""); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertEquals(-1L, cacheControl.getMaxAge()); } @Test void testParseCookieEmptyValue() { final Header header = new BasicHeader("Cache-Control", "max-age=,"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertEquals(-1L, cacheControl.getMaxAge()); } @Test void testParseNoCache() { final Header header = new BasicHeader(" Cache-Control", "no-cache"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertEquals(-1L, cacheControl.getMaxAge()); } @Test void testParseNoDirective() { final Header header = new BasicHeader(" Cache-Control", ""); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertEquals(-1L, cacheControl.getMaxAge()); } @Test void testGarbage() { final Header header = new BasicHeader("Cache-Control", ",,= blah,"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertEquals(-1L, cacheControl.getMaxAge()); } @Test void testParseMultipleDirectives() { final Header header = new BasicHeader("Cache-Control", "max-age=604800, stale-while-revalidate=86400, s-maxage=3600, must-revalidate, private"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertAll("Must all pass", () -> assertEquals(604800L, cacheControl.getMaxAge()), () -> assertEquals(3600L, cacheControl.getSharedMaxAge()), () -> assertTrue(cacheControl.isMustRevalidate()), () -> assertTrue(cacheControl.isCachePrivate()) ); } @Test void testParseMultipleDirectives2() { final Header header = new BasicHeader("Cache-Control", "max-age=604800, stale-while-revalidate=86400, must-revalidate, private, s-maxage=3600"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertAll("Must all pass", () -> assertEquals(604800L, cacheControl.getMaxAge()), () -> assertEquals(3600L, cacheControl.getSharedMaxAge()), () -> assertTrue(cacheControl.isMustRevalidate()), () -> assertTrue(cacheControl.isCachePrivate()) ); } @Test void testParsePublic() { final Header header = new BasicHeader("Cache-Control", "public"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertTrue(cacheControl.isPublic()); } @Test void testParsePrivate() { final Header header = new BasicHeader("Cache-Control", "private"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertTrue(cacheControl.isCachePrivate()); } @Test void testParseNoStore() { final Header header = new BasicHeader("Cache-Control", "no-store"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertTrue(cacheControl.isNoStore()); } @Test void testParseStaleWhileRevalidate() { final Header header = new BasicHeader("Cache-Control", "max-age=3600, stale-while-revalidate=120"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertEquals(120, cacheControl.getStaleWhileRevalidate()); } @Test void testParseNoCacheFields() { final Header header = new BasicHeader("Cache-Control", "no-cache=\"Set-Cookie, Content-Language\", stale-while-revalidate=120"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertTrue(cacheControl.isNoCache()); assertEquals(2, cacheControl.getNoCacheFields().size()); assertTrue(cacheControl.getNoCacheFields().contains("Set-Cookie")); assertTrue(cacheControl.getNoCacheFields().contains("Content-Language")); assertEquals(120, cacheControl.getStaleWhileRevalidate()); } @Test void testParseNoCacheFieldsNoQuote() { final Header header = new BasicHeader("Cache-Control", "no-cache=Set-Cookie, Content-Language, stale-while-revalidate=120"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertTrue(cacheControl.isNoCache()); assertEquals(1, cacheControl.getNoCacheFields().size()); assertTrue(cacheControl.getNoCacheFields().contains("Set-Cookie")); assertEquals(120, cacheControl.getStaleWhileRevalidate()); } @Test void testParseNoCacheFieldsMessy() { final Header header = new BasicHeader("Cache-Control", "no-cache=\" , , ,,, Set-Cookie , , Content-Language , \", stale-while-revalidate=120"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertTrue(cacheControl.isNoCache()); assertEquals(2, cacheControl.getNoCacheFields().size()); assertTrue(cacheControl.getNoCacheFields().contains("Set-Cookie")); assertTrue(cacheControl.getNoCacheFields().contains("Content-Language")); assertEquals(120, cacheControl.getStaleWhileRevalidate()); } @Test void testParseMultipleHeaders() { // Create headers final Header header1 = new BasicHeader("Cache-Control", "max-age=3600, no-store"); final Header header2 = new BasicHeader("Cache-Control", "private, must-revalidate"); final Header header3 = new BasicHeader("Cache-Control", "max-age=3600"); final Header header4 = new BasicHeader("Cache-Control", "no-store"); final Header header5 = new BasicHeader("Cache-Control", "private"); final Header header6 = new BasicHeader("Cache-Control", "must-revalidate"); // Parse headers final ResponseCacheControl cacheControl1 = parser.parseResponse(Arrays.asList(header1, header2).iterator()); final ResponseCacheControl cacheControl2 = parser.parseResponse(Arrays.asList(header3, header4, header5, header6).iterator()); // Validate Cache-Control directives assertEquals(cacheControl1.getMaxAge(), cacheControl2.getMaxAge()); assertEquals(cacheControl1.isNoStore(), cacheControl2.isNoStore()); assertEquals(cacheControl1.isCachePrivate(), cacheControl2.isCachePrivate()); assertEquals(cacheControl1.isMustRevalidate(), cacheControl2.isMustRevalidate()); } @Test void testParseRequestMultipleDirectives() { final Header header = new BasicHeader("Cache-Control", "blah, max-age=1111, max-stale=2222, " + "min-fresh=3333, no-cache, no-store, no-cache, no-stuff, only-if-cached, only-if-cached-or-maybe-not"); final RequestCacheControl cacheControl = parser.parseRequest(Collections.singletonList(header).iterator()); assertAll("Must all pass", () -> assertEquals(1111L, cacheControl.getMaxAge()), () -> assertEquals(2222L, cacheControl.getMaxStale()), () -> assertEquals(3333L, cacheControl.getMinFresh()), () -> assertTrue(cacheControl.isNoCache()), () -> assertTrue(cacheControl.isNoCache()), () -> assertTrue(cacheControl.isOnlyIfCached()) ); } @Test void testParseIsImmutable() { final Header header = new BasicHeader("Cache-Control", "max-age=0 , immutable"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertTrue(cacheControl.isImmutable()); } @Test void testParseMultipleIsImmutable() { final Header header = new BasicHeader("Cache-Control", "immutable, nmax-age=0 , immutable"); final ResponseCacheControl cacheControl = parser.parseResponse(Collections.singletonList(header).iterator()); assertTrue(cacheControl.isImmutable()); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/SimpleHttpCacheStorage.java0100664 0000000 0000000 00000005331 14704162040 031737 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.Collection; import java.util.HashMap; import java.util.Map; import org.apache.hc.client5.http.cache.HttpCacheCASOperation; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheStorage; import org.apache.hc.client5.http.cache.ResourceIOException; class SimpleHttpCacheStorage implements HttpCacheStorage { public final Map map; public SimpleHttpCacheStorage() { map = new HashMap<>(); } @Override public void putEntry(final String key, final HttpCacheEntry entry) { map.put(key, entry); } @Override public HttpCacheEntry getEntry(final String key) { return map.get(key); } @Override public void removeEntry(final String key) { map.remove(key); } @Override public void updateEntry( final String key, final HttpCacheCASOperation casOperation) throws ResourceIOException { final HttpCacheEntry v1 = map.get(key); final HttpCacheEntry v2 = casOperation.execute(v1); map.put(key,v2); } @Override public Map getEntries(final Collection keys) throws ResourceIOException { final Map resultMap = new HashMap<>(keys.size()); for (final String key: keys) { final HttpCacheEntry entry = getEntry(key); if (entry != null) { resultMap.put(key, entry); } } return resultMap; } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestInternalCacheStorage.java0100664 0000000 0000000 00000007617 14704162040 032273 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.LinkedList; import java.util.Queue; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestInternalCacheStorage { @Test void testCacheBasics() { final InternalCacheStorage storage = new InternalCacheStorage(); final String key1 = "some-key-1"; Assertions.assertNull(storage.get(key1)); Assertions.assertNull(storage.remove(key1)); final HttpCacheEntry entry1 = HttpTestUtils.makeCacheEntry(); storage.put(key1, entry1); Assertions.assertSame(entry1, storage.get(key1)); Assertions.assertSame(entry1, storage.remove(key1)); Assertions.assertNull(storage.get(key1)); Assertions.assertNull(storage.remove(key1)); final String key2 = "some-key-2"; final HttpCacheEntry entry2 = HttpTestUtils.makeCacheEntry(); final String key3 = "some-key-3"; final HttpCacheEntry entry3 = HttpTestUtils.makeCacheEntry(); storage.put(key2, entry2); storage.put(key3, entry3); Assertions.assertSame(entry2, storage.get(key2)); Assertions.assertSame(entry3, storage.get(key3)); storage.clear(); Assertions.assertNull(storage.get(key2)); Assertions.assertNull(storage.get(key3)); } @Test void testCacheEviction() { final Queue evictedEntries = new LinkedList<>(); final InternalCacheStorage storage = new InternalCacheStorage(2, e -> evictedEntries.add(e.getContent())); final String key1 = "some-key-1"; final String key2 = "some-key-2"; final String key3 = "some-key-3"; final String key4 = "some-key-4"; final HttpCacheEntry entry1 = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry entry2 = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry entry3 = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry entry4 = HttpTestUtils.makeCacheEntry(); storage.put(key1, entry1); storage.put(key2, entry2); storage.put(key3, entry3); storage.put(key4, entry4); Assertions.assertSame(entry1, evictedEntries.poll()); Assertions.assertSame(entry2, evictedEntries.poll()); Assertions.assertNull(evictedEntries.poll()); storage.clear(); storage.put(key1, entry1); storage.put(key2, entry2); storage.get(key1); storage.put(key3, entry3); storage.get(key1); storage.put(key4, entry4); Assertions.assertSame(entry2, evictedEntries.poll()); Assertions.assertSame(entry3, evictedEntries.poll()); Assertions.assertNull(evictedEntries.poll()); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCachingExecChain.java0100664 0000000 0000000 00000163037 14704162040 031351 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.mockito.Mockito.mock; import java.io.IOException; import java.io.InputStream; import java.net.SocketException; import java.net.SocketTimeoutException; import java.nio.charset.StandardCharsets; import java.time.Duration; import java.time.Instant; import java.time.temporal.ChronoUnit; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.cache.CacheResponseStatus; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheStorage; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpOptions; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.net.URIAuthority; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; class TestCachingExecChain { @Mock ExecChain mockExecChain; @Mock ExecRuntime mockExecRuntime; @Mock HttpCacheStorage mockStorage; @Mock DefaultCacheRevalidator cacheRevalidator; HttpRoute route; HttpHost host; ClassicHttpRequest request; HttpCacheContext context; HttpCacheEntry entry; HttpCache cache; CachingExec impl; CacheConfig customConfig; ExecChain.Scope scope; @BeforeEach void setUp() { MockitoAnnotations.openMocks(this); host = new HttpHost("foo.example.com", 80); route = new HttpRoute(host); request = new BasicClassicHttpRequest("GET", "/stuff"); context = HttpCacheContext.create(); entry = HttpTestUtils.makeCacheEntry(); customConfig = CacheConfig.DEFAULT; scope = new ExecChain.Scope("test", route, request, mockExecRuntime, context); cache = Mockito.spy(new BasicHttpCache()); impl = new CachingExec(cache, null, CacheConfig.DEFAULT); } public ClassicHttpResponse execute(final ClassicHttpRequest request) throws IOException, HttpException { final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, mockExecRuntime, context); return impl.execute(ClassicRequestBuilder.copy(request).build(), scope, mockExecChain); } @Test void testCacheableResponsesGoIntoCache() throws Exception { final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control", "max-age=3600"); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); execute(req2); Mockito.verify(mockExecChain).proceed(Mockito.any(), Mockito.any()); Mockito.verify(cache).store(Mockito.eq(host), RequestEquivalent.eq(req1), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any()); } @Test void testOlderCacheableResponsesDoNotGoIntoCache() throws Exception { final Instant now = Instant.now(); final Instant fiveSecondsAgo = now.minusSeconds(5); final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "max-age=3600"); resp1.setHeader("Etag", "\"new-etag\""); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader("Cache-Control", "no-cache"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("ETag", "\"old-etag\""); resp2.setHeader("Date", DateUtils.formatStandardDate(fiveSecondsAgo)); resp2.setHeader("Cache-Control", "max-age=3600"); final ClassicHttpRequest req3 = HttpTestUtils.makeDefaultRequest(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); final ClassicHttpResponse result = execute(req3); Assertions.assertEquals("\"new-etag\"", result.getFirstHeader("ETag").getValue()); } @Test void testNewerCacheableResponsesReplaceExistingCacheEntry() throws Exception { final Instant now = Instant.now(); final Instant fiveSecondsAgo = now.minusSeconds(5); final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(fiveSecondsAgo)); resp1.setHeader("Cache-Control", "max-age=3600"); resp1.setHeader("Etag", "\"old-etag\""); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader("Cache-Control", "max-age=0"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("ETag", "\"new-etag\""); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600"); final ClassicHttpRequest req3 = HttpTestUtils.makeDefaultRequest(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); final ClassicHttpResponse result = execute(req3); Assertions.assertEquals("\"new-etag\"", result.getFirstHeader("ETag").getValue()); } @Test void testNonCacheableResponseIsNotCachedAndIsReturnedAsIs() throws Exception { final HttpCache cache = new BasicHttpCache(new HeapResourceFactory(), mockStorage); impl = new CachingExec(cache, null, CacheConfig.DEFAULT); final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control", "no-store"); Mockito.when(mockStorage.getEntry(Mockito.any())).thenReturn(null); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpResponse result = execute(req1); Assertions.assertTrue(HttpTestUtils.semanticallyTransparent(resp1, result)); Mockito.verify(mockStorage, Mockito.never()).putEntry(Mockito.any(), Mockito.any()); } @Test void testSetsModuleGeneratedResponseContextForCacheOptionsResponse() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("OPTIONS", "*"); req.setHeader("Max-Forwards", "0"); execute(req); Assertions.assertEquals(CacheResponseStatus.CACHE_MODULE_RESPONSE, context.getCacheResponseStatus()); } @Test void testSetsCacheMissContextIfRequestNotServableFromCache() throws Exception { final ClassicHttpRequest req = new HttpGet("http://foo.example.com/"); req.setHeader("Cache-Control", "no-cache"); final ClassicHttpResponse resp = new BasicClassicHttpResponse(HttpStatus.SC_NO_CONTENT, "No Content"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp); execute(req); Assertions.assertEquals(CacheResponseStatus.CACHE_MISS, context.getCacheResponseStatus()); } @Test void testSetsCacheHitContextIfRequestServedFromCache() throws Exception { final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); resp1.setHeader("Cache-Control", "public, max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); execute(req2); Assertions.assertEquals(CacheResponseStatus.CACHE_HIT, context.getCacheResponseStatus()); } @Test void testReturns304ForIfModifiedSinceHeaderIfRequestServedFromCache() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); req2.addHeader("If-Modified-Since", DateUtils.formatStandardDate(now)); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "public, max-age=3600"); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); } @Test void testReturns304ForIfModifiedSinceHeaderIf304ResponseInCache() throws Exception { final Instant now = Instant.now(); final Instant oneHourAgo = now.minus(1, ChronoUnit.HOURS); final Instant inTenMinutes = now.plus(10, ChronoUnit.MINUTES); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); req1.addHeader("If-Modified-Since", DateUtils.formatStandardDate(oneHourAgo)); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); req2.addHeader("If-Modified-Since", DateUtils.formatStandardDate(oneHourAgo)); final ClassicHttpResponse resp1 = HttpTestUtils.make304Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-control", "max-age=600"); resp1.setHeader("Expires", DateUtils.formatStandardDate(inTenMinutes)); resp1.setHeader("ETag", "\"etag\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); Assertions.assertFalse(result.containsHeader("Last-Modified")); Mockito.verify(mockExecChain).proceed(Mockito.any(), Mockito.any()); } @Test void testReturns304ForIfModifiedSinceHeaderIf304ResponseInCacheWithLastModified() throws Exception { final Instant now = Instant.now(); final Instant oneHourAgo = now.minus(1, ChronoUnit.HOURS); final Instant inTenMinutes = now.plus(10, ChronoUnit.MINUTES); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); req1.addHeader("If-Modified-Since", DateUtils.formatStandardDate(oneHourAgo)); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); req2.addHeader("If-Modified-Since", DateUtils.formatStandardDate(oneHourAgo)); final ClassicHttpResponse resp1 = HttpTestUtils.make304Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-control", "max-age=600"); resp1.setHeader("Expires", DateUtils.formatStandardDate(inTenMinutes)); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); Assertions.assertTrue(result.containsHeader("Last-Modified")); Mockito.verify(mockExecChain).proceed(Mockito.any(), Mockito.any()); } @Test void testReturns200ForIfModifiedSinceDateIsLess() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); resp1.setHeader("Cache-Control", "public, max-age=3600"); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(Instant.now())); // The variant has been modified since this date req2.addHeader("If-Modified-Since", DateUtils.formatStandardDate(tenSecondsAgo)); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_OK, result.getCode()); } @Test void testReturns200ForIfModifiedSinceDateIsInvalid() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAfter = now.plusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); resp1.setHeader("Cache-Control", "public, max-age=3600"); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(Instant.now())); // invalid date (date in the future) req2.addHeader("If-Modified-Since", DateUtils.formatStandardDate(tenSecondsAfter)); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_OK, result.getCode()); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); } @Test void testReturns304ForIfNoneMatchHeaderIfRequestServedFromCache() throws Exception { final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); req2.addHeader("If-None-Match", "*"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); resp1.setHeader("Cache-Control", "public, max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); } @Test void testReturns200ForIfNoneMatchHeaderFails() throws Exception { final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); resp1.setHeader("Cache-Control", "public, max-age=3600"); req2.addHeader("If-None-Match", "\"abc\""); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(200, result.getCode()); } @Test void testReturns304ForIfNoneMatchHeaderAndIfModifiedSinceIfRequestServedFromCache() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "public, max-age=3600"); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(Instant.now())); req2.addHeader("If-None-Match", "*"); req2.addHeader("If-Modified-Since", DateUtils.formatStandardDate(now)); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); } @Test void testReturns200ForIfNoneMatchHeaderFailsIfModifiedSinceIgnored() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); req2.addHeader("If-None-Match", "\"abc\""); req2.addHeader("If-Modified-Since", DateUtils.formatStandardDate(now)); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "public, max-age=3600"); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(200, result.getCode()); } @Test void testReturns200ForOptionsFollowedByGetIfAuthorizationHeaderAndSharedCache() throws Exception { impl = new CachingExec(cache, null, CacheConfig.custom().setSharedCache(true).build()); final Instant now = Instant.now(); final ClassicHttpRequest req1 = new HttpOptions("http://foo.example.com/"); req1.setHeader("Authorization", StandardAuthScheme.BASIC + " QWxhZGRpbjpvcGVuIHNlc2FtZQ=="); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); req2.setHeader("Authorization", StandardAuthScheme.BASIC + " QWxhZGRpbjpvcGVuIHNlc2FtZQ=="); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_NO_CONTENT, "No Content"); resp1.setHeader("Content-Length", "0"); resp1.setHeader("ETag", "\"options-etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "public, max-age=3600"); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(now)); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"get-etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "public, max-age=3600"); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(now)); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(200, result.getCode()); } @Test void testSetsValidatedContextIfRequestWasSuccessfullyValidated() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "public, max-age=5"); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp2.setEntity(HttpTestUtils.makeBody(128)); resp2.setHeader("Content-Length", "128"); resp2.setHeader("ETag", "\"etag\""); resp2.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp2.setHeader("Cache-Control", "public, max-age=5"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); Assertions.assertEquals(CacheResponseStatus.VALIDATED, context.getCacheResponseStatus()); } @Test void testSetsModuleResponseContextIfValidationRequiredButFailed() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "public, max-age=5, must-revalidate"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenThrow(new IOException()); execute(req2); Assertions.assertEquals(CacheResponseStatus.CACHE_MODULE_RESPONSE, context.getCacheResponseStatus()); } @Test void testSetsModuleResponseContextIfValidationFailsButNotRequired() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "public, max-age=5"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenThrow(new IOException()); execute(req2); Assertions.assertEquals(CacheResponseStatus.CACHE_MODULE_RESPONSE, context.getCacheResponseStatus()); } @Test void testReturns304ForIfNoneMatchPassesIfRequestServedFromOrigin() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "public, max-age=5"); req2.addHeader("If-None-Match", "\"etag\""); final ClassicHttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("ETag", "\"etag\""); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "public, max-age=5"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); } @Test void testReturns200ForIfNoneMatchFailsIfRequestServedFromOrigin() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "public, max-age=5"); req2.addHeader("If-None-Match", "\"etag\""); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp2.setEntity(HttpTestUtils.makeBody(128)); resp2.setHeader("Content-Length", "128"); resp2.setHeader("ETag", "\"newetag\""); resp2.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp2.setHeader("Cache-Control", "public, max-age=5"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_OK, result.getCode()); } @Test void testReturns304ForIfModifiedSincePassesIfRequestServedFromOrigin() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "public, max-age=5"); req2.addHeader("If-Modified-Since", DateUtils.formatStandardDate(tenSecondsAgo)); final ClassicHttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("ETag", "\"etag\""); resp2.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); resp2.setHeader("Cache-Control", "public, max-age=5"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); } @Test void testReturns200ForIfModifiedSinceFailsIfRequestServedFromOrigin() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "public, max-age=5"); req2.addHeader("If-Modified-Since", DateUtils.formatStandardDate(tenSecondsAgo)); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp2.setEntity(HttpTestUtils.makeBody(128)); resp2.setHeader("Content-Length", "128"); resp2.setHeader("ETag", "\"newetag\""); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "public, max-age=5"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_OK, result.getCode()); } @Test void testVariantMissServerIfReturns304CacheReturns200() throws Exception { final Instant now = Instant.now(); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com"); req1.addHeader("Accept-Encoding", "gzip"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("Etag", "\"gzip_etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Vary", "Accept-Encoding"); resp1.setHeader("Cache-Control", "public, max-age=3600"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com"); req2.addHeader("Accept-Encoding", "deflate"); final ClassicHttpRequest req2Server = new HttpGet("http://foo.example.com"); req2Server.addHeader("Accept-Encoding", "deflate"); req2Server.addHeader("If-None-Match", "\"gzip_etag\""); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp2.setEntity(HttpTestUtils.makeBody(128)); resp2.setHeader("Content-Length", "128"); resp2.setHeader("Etag", "\"deflate_etag\""); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Vary", "Accept-Encoding"); resp2.setHeader("Cache-Control", "public, max-age=3600"); final ClassicHttpRequest req3 = new HttpGet("http://foo.example.com"); req3.addHeader("Accept-Encoding", "gzip,deflate"); final ClassicHttpRequest req3Server = new HttpGet("http://foo.example.com"); req3Server.addHeader("Accept-Encoding", "gzip,deflate"); req3Server.addHeader("If-None-Match", "\"gzip_etag\",\"deflate_etag\""); final ClassicHttpResponse resp3 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp3.setEntity(HttpTestUtils.makeBody(128)); resp3.setHeader("Content-Length", "128"); resp3.setHeader("Etag", "\"gzip_etag\""); resp3.setHeader("Date", DateUtils.formatStandardDate(now)); resp3.setHeader("Vary", "Accept-Encoding"); resp3.setHeader("Cache-Control", "public, max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpResponse result1 = execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result2 = execute(req2); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp3); final ClassicHttpResponse result3 = execute(req3); Assertions.assertEquals(HttpStatus.SC_OK, result1.getCode()); Assertions.assertEquals(HttpStatus.SC_OK, result2.getCode()); Assertions.assertEquals(HttpStatus.SC_OK, result3.getCode()); } @Test void testVariantsMissServerReturns304CacheReturns304() throws Exception { final Instant now = Instant.now(); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com"); req1.addHeader("Accept-Encoding", "gzip"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("Etag", "\"gzip_etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Vary", "Accept-Encoding"); resp1.setHeader("Cache-Control", "public, max-age=3600"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com"); req2.addHeader("Accept-Encoding", "deflate"); final ClassicHttpRequest req2Server = new HttpGet("http://foo.example.com"); req2Server.addHeader("Accept-Encoding", "deflate"); req2Server.addHeader("If-None-Match", "\"gzip_etag\""); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp2.setEntity(HttpTestUtils.makeBody(128)); resp2.setHeader("Content-Length", "128"); resp2.setHeader("Etag", "\"deflate_etag\""); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Vary", "Accept-Encoding"); resp2.setHeader("Cache-Control", "public, max-age=3600"); final ClassicHttpRequest req4 = new HttpGet("http://foo.example.com"); req4.addHeader("Accept-Encoding", "gzip,identity"); req4.addHeader("If-None-Match", "\"gzip_etag\""); final ClassicHttpRequest req4Server = new HttpGet("http://foo.example.com"); req4Server.addHeader("Accept-Encoding", "gzip,identity"); req4Server.addHeader("If-None-Match", "\"gzip_etag\""); final ClassicHttpResponse resp4 = HttpTestUtils.make304Response(); resp4.setHeader("Etag", "\"gzip_etag\""); resp4.setHeader("Date", DateUtils.formatStandardDate(now)); resp4.setHeader("Vary", "Accept-Encoding"); resp4.setHeader("Cache-Control", "public, max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpResponse result1 = execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result2 = execute(req2); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp4); final ClassicHttpResponse result4 = execute(req4); Assertions.assertEquals(HttpStatus.SC_OK, result1.getCode()); Assertions.assertEquals(HttpStatus.SC_OK, result2.getCode()); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result4.getCode()); } @Test void testSocketTimeoutExceptionIsNotSilentlyCatched() throws Exception { final Instant now = Instant.now(); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(new InputStreamEntity(new InputStream() { private boolean closed; @Override public void close() { closed = true; } @Override public int read() throws IOException { if (closed) { throw new SocketException("Socket closed"); } throw new SocketTimeoutException("Read timed out"); } }, 128, null)); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); Assertions.assertThrows(SocketTimeoutException.class, () -> { final ClassicHttpResponse result1 = execute(req1); EntityUtils.toString(result1.getEntity()); }); } @Test void testTooLargeResponsesAreNotCached() throws Exception { final HttpHost host = new HttpHost("foo.example.com"); final ClassicHttpRequest request = new HttpGet("http://foo.example.com/bar"); final Instant now = Instant.now(); final Instant requestSent = now.plusSeconds(3); final Instant responseGenerated = now.plusSeconds(2); final Instant responseReceived = now.plusSeconds(1); final ClassicHttpResponse originResponse = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); originResponse.setEntity(HttpTestUtils.makeBody(CacheConfig.DEFAULT_MAX_OBJECT_SIZE_BYTES + 1)); originResponse.setHeader("Cache-Control","public, max-age=3600"); originResponse.setHeader("Date", DateUtils.formatStandardDate(responseGenerated)); originResponse.setHeader("ETag", "\"etag\""); impl.cacheAndReturnResponse(host, request, scope, originResponse, requestSent, responseReceived); Mockito.verify(cache, Mockito.never()).store( Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any()); } @Test void testSmallEnoughResponsesAreCached() throws Exception { final HttpCache mockCache = mock(HttpCache.class); impl = new CachingExec(mockCache, null, CacheConfig.DEFAULT); final HttpHost host = new HttpHost("foo.example.com"); final ClassicHttpRequest request = new HttpGet("http://foo.example.com/bar"); final Instant now = Instant.now(); final Instant requestSent = now.plusSeconds(3); final Instant responseGenerated = now.plusSeconds(2); final Instant responseReceived = now.plusSeconds(1); final ClassicHttpResponse originResponse = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); originResponse.setEntity(HttpTestUtils.makeBody(CacheConfig.DEFAULT_MAX_OBJECT_SIZE_BYTES - 1)); originResponse.setHeader("Cache-Control","public, max-age=3600"); originResponse.setHeader("Date", DateUtils.formatStandardDate(responseGenerated)); originResponse.setHeader("ETag", "\"etag\""); final HttpCacheEntry httpCacheEntry = HttpTestUtils.makeCacheEntry(); final SimpleHttpResponse response = SimpleHttpResponse.create(HttpStatus.SC_OK); Mockito.when(mockCache.store( Mockito.eq(host), RequestEquivalent.eq(request), ResponseEquivalent.eq(response), Mockito.any(), Mockito.eq(requestSent), Mockito.eq(responseReceived))).thenReturn(new CacheHit("key", httpCacheEntry)); impl.cacheAndReturnResponse(host, request, scope, originResponse, requestSent, responseReceived); Mockito.verify(mockCache).store( Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any()); } @Test void testIfOnlyIfCachedAndNoCacheEntryBackendNotCalled() throws Exception { request.addHeader("Cache-Control", "only-if-cached"); final ClassicHttpResponse resp = execute(request); Assertions.assertEquals(HttpStatus.SC_GATEWAY_TIMEOUT, resp.getCode()); } @Test void testCanCacheAResponseWithoutABody() throws Exception { final ClassicHttpResponse response = new BasicClassicHttpResponse(HttpStatus.SC_NO_CONTENT, "No Content"); response.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); response.setHeader("Cache-Control", "max-age=300"); Mockito.when(mockExecChain.proceed(RequestEquivalent.eq(request), Mockito.any())).thenReturn(response); impl.execute(request, scope, mockExecChain); impl.execute(request, scope, mockExecChain); Mockito.verify(mockExecChain).proceed(Mockito.any(), Mockito.any()); } @Test void testNoEntityForIfNoneMatchRequestNotYetInCache() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); req1.addHeader("If-None-Match", "\"etag\""); final ClassicHttpResponse resp1 = HttpTestUtils.make304Response(); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "public, max-age=5"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpResponse result = execute(req1); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); Assertions.assertNull(result.getEntity(), "The 304 response messages MUST NOT contain a message-body"); } @Test void testNotModifiedResponseUpdatesCacheEntryWhenNoEntity() throws Exception { final Instant now = Instant.now(); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); req1.addHeader("If-None-Match", "\"etag\""); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); req2.addHeader("If-None-Match", "\"etag\""); final ClassicHttpResponse resp1 = HttpTestUtils.make304Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "max-age=1"); resp1.setHeader("Etag", "\"etag\""); final ClassicHttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=1"); resp1.setHeader("Etag", "\"etag\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpResponse result1 = execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result2 = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result1.getCode()); Assertions.assertEquals(new ETag("etag"), ETag.get(result1)); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result2.getCode()); Assertions.assertEquals(new ETag("etag"), ETag.get(result2)); } @Test void testNotModifiedResponseWithVaryUpdatesCacheEntryWhenNoEntity() throws Exception { final Instant now = Instant.now(); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); req1.addHeader("If-None-Match", "\"etag\""); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); req2.addHeader("If-None-Match", "\"etag\""); final ClassicHttpResponse resp1 = HttpTestUtils.make304Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "max-age=1"); resp1.setHeader("Etag", "\"etag\""); resp1.setHeader("Vary", "Accept-Encoding"); final ClassicHttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=1"); resp1.setHeader("Etag", "\"etag\""); resp1.setHeader("Vary", "Accept-Encoding"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpResponse result1 = execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result2 = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result1.getCode()); Assertions.assertEquals(new ETag("etag"), ETag.get(result1)); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result2.getCode()); Assertions.assertEquals(new ETag("etag"), ETag.get(result2)); } @Test void testDoesNotSend304ForNonConditionalRequest() throws Exception { final Instant now = Instant.now(); final Instant inOneMinute = now.plus(1, ChronoUnit.MINUTES); final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); req1.addHeader("If-None-Match", "etag"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = HttpTestUtils.make304Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "public, max-age=60"); resp1.setHeader("Expires", DateUtils.formatStandardDate(inOneMinute)); resp1.setHeader("Etag", "etag"); resp1.setHeader("Vary", "Accept-Encoding"); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "Ok"); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "public, max-age=60"); resp2.setHeader("Expires", DateUtils.formatStandardDate(inOneMinute)); resp2.setHeader("Etag", "etag"); resp2.setHeader("Vary", "Accept-Encoding"); resp2.setEntity(HttpTestUtils.makeBody(128)); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpResponse result1 = execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result2 = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result1.getCode()); Assertions.assertNull(result1.getEntity()); Assertions.assertEquals(HttpStatus.SC_OK, result2.getCode()); Assertions.assertNotNull(result2.getEntity()); } @Test void testUsesVirtualHostForCacheKey() throws Exception { final ClassicHttpResponse response = HttpTestUtils.make200Response(); response.setHeader("Cache-Control", "max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(response); impl.execute(request, scope, mockExecChain); Mockito.verify(mockExecChain, Mockito.times(1)).proceed(Mockito.any(), Mockito.any()); request.setAuthority(new URIAuthority("bar.example.com")); impl.execute(request, scope, mockExecChain); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); impl.execute(request, scope, mockExecChain); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); } @Test void testReturnssetStaleIfErrorNotEnabled() throws Exception { // Create the first request and response final ClassicHttpRequest req1 = new HttpGet("http://foo.example.com/"); final ClassicHttpRequest req2 = new HttpGet("http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); resp1.setHeader("Cache-Control", "public"); req2.addHeader("If-None-Match", "\"abc\""); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); Mockito.when(mockExecRuntime.fork(Mockito.any())).thenReturn(mockExecRuntime); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_OK, result.getCode()); Mockito.verify(cacheRevalidator, Mockito.never()).revalidateCacheEntry(Mockito.any(), Mockito.any()); } @Test void testReturnssetStaleIfErrorEnabled() throws Exception { final CacheConfig customConfig = CacheConfig.custom() .setMaxCacheEntries(100) .setMaxObjectSize(1024) .setSharedCache(false) .setStaleIfErrorEnabled(true) .build(); impl = new CachingExec(cache, cacheRevalidator, customConfig); // Create the first request and response final BasicClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "http://foo.example.com/"); final ClassicHttpResponse resp1 = new BasicClassicHttpResponse(HttpStatus.SC_OK, "OK"); resp1.setEntity(HttpTestUtils.makeBody(128)); resp1.setHeader("Content-Length", "128"); resp1.setHeader("ETag", "\"abc\""); resp1.setHeader("Date", DateUtils.formatStandardDate(Instant.now().minus(Duration.ofHours(10)))); resp1.setHeader("Cache-Control", "public, stale-while-revalidate=1"); final BasicClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "http://foo.example.com/"); req2.addHeader("If-None-Match", "\"abc\""); final ClassicHttpResponse resp2 = HttpTestUtils.make500Response(); // Set up the mock response chain Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); // Execute the first request and assert the response final ClassicHttpResponse response1 = execute(req1); Assertions.assertEquals(HttpStatus.SC_OK, response1.getCode()); // Execute the second request and assert the response Mockito.when(mockExecRuntime.fork(Mockito.any())).thenReturn(mockExecRuntime); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse response2 = execute(req2); Assertions.assertEquals(HttpStatus.SC_OK, response2.getCode()); Mockito.verify(cacheRevalidator, Mockito.never()).revalidateCacheEntry(Mockito.any(), Mockito.any()); } @Test void testNotModifiedResponseUpdatesCacheEntry() throws Exception { final HttpCache mockCache = mock(HttpCache.class); impl = new CachingExec(mockCache, null, CacheConfig.DEFAULT); // Prepare request and host final HttpHost host = new HttpHost("foo.example.com"); final ClassicHttpRequest request = new HttpGet("http://foo.example.com/bar"); // Prepare original cache entry final HttpCacheEntry originalEntry = HttpTestUtils.makeCacheEntry(); Mockito.when(mockCache.match(host, request)).thenReturn( new CacheMatch(new CacheHit("key", originalEntry), null)); // Prepare 304 Not Modified response final Instant now = Instant.now(); final Instant requestSent = now.plusSeconds(3); final Instant responseReceived = now.plusSeconds(1); final ClassicHttpResponse backendResponse = new BasicClassicHttpResponse(HttpStatus.SC_NOT_MODIFIED, "Not Modified"); backendResponse.setHeader("Cache-Control", "public, max-age=3600"); backendResponse.setHeader("ETag", "\"etag\""); final Header[] headers = new Header[5]; for (int i = 0; i < headers.length; i++) { headers[i] = new BasicHeader("header" + i, "value" + i); } final String body = "Lorem ipsum dolor sit amet"; final HttpCacheEntry cacheEntry = HttpTestUtils.makeCacheEntry( Instant.now(), Instant.now(), HttpStatus.SC_NOT_MODIFIED, headers, new HeapResource(body.getBytes(StandardCharsets.UTF_8))); Mockito.when(mockCache.update(Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any())) .thenReturn(new CacheHit("key", cacheEntry)); // Call cacheAndReturnResponse with 304 Not Modified response final ClassicHttpResponse cachedResponse = impl.cacheAndReturnResponse(host, request, scope, backendResponse, requestSent, responseReceived); // Verify cache entry is updated Mockito.verify(mockCache).update( Mockito.any(), Mockito.same(host), Mockito.same(request), Mockito.same(backendResponse), Mockito.eq(requestSent), Mockito.eq(responseReceived) ); // Verify response is generated from the updated cache entry Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, cachedResponse.getCode()); } @Test void testNoCacheFieldsRevalidation() throws Exception { final Instant now = Instant.now(); final Instant fiveSecondsAgo = now.minusSeconds(5); final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "max-age=3100, no-cache=\"Set-Cookie, Content-Language\""); resp1.setHeader("Content-Language", "en-US"); resp1.setHeader("Etag", "\"new-etag\""); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); //req2.setHeader("Cache-Control", "no-cache=\"etag\""); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("ETag", "\"old-etag\""); resp2.setHeader("Date", DateUtils.formatStandardDate(fiveSecondsAgo)); resp2.setHeader("Cache-Control", "max-age=3600"); final ClassicHttpRequest req3 = HttpTestUtils.makeDefaultRequest(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); execute(req3); // Verify that the backend was called to revalidate the response, as per the new logic Mockito.verify(mockExecChain, Mockito.times(5)).proceed(Mockito.any(), Mockito.any()); } } ././@LongLink0100644 0000000 0000000 00000000157 15005672016 011640 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestAbstractSerializingCacheStorage.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestAbstractSerializingCacheSt0100664 0000000 0000000 00000030011 15005672016 032511 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.hamcrest.MatcherAssert.assertThat; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import java.util.Arrays; import java.util.Collection; import java.util.HashMap; import java.util.Map; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheStorageEntry; import org.apache.hc.client5.http.cache.HttpCacheUpdateException; import org.apache.hc.client5.http.cache.ResourceIOException; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Answers; import org.mockito.ArgumentCaptor; import org.mockito.ArgumentMatchers; import org.mockito.Mockito; import org.mockito.stubbing.Answer; @SuppressWarnings("boxing") // test code class TestAbstractSerializingCacheStorage { public static byte[] serialize(final String key, final HttpCacheEntry value) throws ResourceIOException { return HttpByteArrayCacheEntrySerializer.INSTANCE.serialize(new HttpCacheStorageEntry(key, value)); } private AbstractBinaryCacheStorage impl; @BeforeEach @SuppressWarnings("unchecked") void setUp() { impl = Mockito.mock(AbstractBinaryCacheStorage.class, Mockito.withSettings().defaultAnswer(Answers.CALLS_REAL_METHODS).useConstructor(3)); } @Test void testCachePut() throws Exception { final String key = "foo"; final HttpCacheEntry value = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key)).thenReturn("bar"); impl.putEntry(key, value); final ArgumentCaptor argumentCaptor = ArgumentCaptor.forClass(byte[].class); verify(impl).store(eq("bar"), argumentCaptor.capture()); Assertions.assertArrayEquals(serialize(key, value), argumentCaptor.getValue()); } @Test void testCacheGetNullEntry() throws Exception { final String key = "foo"; when(impl.digestToStorageKey(key)).thenReturn("bar"); when(impl.restore("bar")).thenReturn(null); final HttpCacheEntry resultingEntry = impl.getEntry(key); verify(impl).restore("bar"); assertThat(resultingEntry, CoreMatchers.nullValue()); } @Test void testCacheGet() throws Exception { final String key = "foo"; final HttpCacheEntry value = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key)).thenReturn("bar"); when(impl.restore("bar")).thenReturn(serialize(key, value)); final HttpCacheEntry resultingEntry = impl.getEntry(key); verify(impl).restore("bar"); assertThat(resultingEntry, HttpCacheEntryMatcher.equivalent(value)); } @Test void testCacheGetKeyMismatch() throws Exception { final String key = "foo"; final HttpCacheEntry value = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key)).thenReturn("bar"); when(impl.restore("bar")).thenReturn(serialize("not-foo", value)); final HttpCacheEntry resultingEntry = impl.getEntry(key); verify(impl).restore("bar"); assertThat(resultingEntry, CoreMatchers.nullValue()); } @Test void testCacheRemove() throws Exception { final String key = "foo"; when(impl.digestToStorageKey(key)).thenReturn("bar"); impl.removeEntry(key); verify(impl).delete("bar"); } @Test void testCacheUpdateNullEntry() throws Exception { final String key = "foo"; final HttpCacheEntry updatedValue = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key)).thenReturn("bar"); when(impl.getForUpdateCAS("bar")).thenReturn(null); impl.updateEntry(key, existing -> { assertThat(existing, CoreMatchers.nullValue()); return updatedValue; }); verify(impl).getForUpdateCAS("bar"); verify(impl).store(ArgumentMatchers.eq("bar"), ArgumentMatchers.any()); } @Test void testCacheCASUpdate() throws Exception { final String key = "foo"; final HttpCacheEntry existingValue = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry updatedValue = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key)).thenReturn("bar"); when(impl.getForUpdateCAS("bar")).thenReturn("stuff"); when(impl.getStorageObject("stuff")).thenReturn(serialize(key, existingValue)); when(impl.updateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any())).thenReturn(true); impl.updateEntry(key, existing -> updatedValue); verify(impl).getForUpdateCAS("bar"); verify(impl).getStorageObject("stuff"); verify(impl).updateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any()); } @Test void testCacheCASUpdateKeyMismatch() throws Exception { final String key = "foo"; final HttpCacheEntry existingValue = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry updatedValue = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key)).thenReturn("bar"); when(impl.getForUpdateCAS("bar")).thenReturn("stuff"); when(impl.getStorageObject("stuff")).thenReturn(serialize("not-foo", existingValue)); when(impl.updateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any())).thenReturn(true); impl.updateEntry(key, existing -> { assertThat(existing, CoreMatchers.nullValue()); return updatedValue; }); verify(impl).getForUpdateCAS("bar"); verify(impl).getStorageObject("stuff"); verify(impl).store(ArgumentMatchers.eq("bar"), ArgumentMatchers.any()); } @Test void testSingleCacheUpdateRetry() throws Exception { final String key = "foo"; final HttpCacheEntry existingValue = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry updatedValue = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key)).thenReturn("bar"); when(impl.getForUpdateCAS("bar")).thenReturn("stuff"); when(impl.getStorageObject("stuff")).thenReturn(serialize(key, existingValue)); when(impl.updateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any())).thenReturn(false, true); impl.updateEntry(key, existing -> updatedValue); verify(impl, Mockito.times(2)).getForUpdateCAS("bar"); verify(impl, Mockito.times(2)).getStorageObject("stuff"); verify(impl, Mockito.times(2)).updateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any()); } @Test void testCacheUpdateFail() throws Exception { final String key = "foo"; final HttpCacheEntry existingValue = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry updatedValue = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key)).thenReturn("bar"); when(impl.getForUpdateCAS("bar")).thenReturn("stuff"); when(impl.getStorageObject("stuff")).thenReturn(serialize(key, existingValue)); when(impl.updateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any())) .thenReturn(false, false, false, true); Assertions.assertThrows(HttpCacheUpdateException.class, () -> impl.updateEntry(key, existing -> updatedValue)); verify(impl, Mockito.times(3)).getForUpdateCAS("bar"); verify(impl, Mockito.times(3)).getStorageObject("stuff"); verify(impl, Mockito.times(3)).updateCAS(ArgumentMatchers.eq("bar"), ArgumentMatchers.eq("stuff"), ArgumentMatchers.any()); } @Test void testBulkGet() throws Exception { final String key1 = "foo this"; final String key2 = "foo that"; final String storageKey1 = "bar this"; final String storageKey2 = "bar that"; final HttpCacheEntry value1 = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry value2 = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key1)).thenReturn(storageKey1); when(impl.digestToStorageKey(key2)).thenReturn(storageKey2); when(impl.bulkRestore(ArgumentMatchers.anyCollection())).thenAnswer((Answer>) invocation -> { final Collection keys = invocation.getArgument(0); final Map resultMap = new HashMap<>(); if (keys.contains(storageKey1)) { resultMap.put(storageKey1, serialize(key1, value1)); } if (keys.contains(storageKey2)) { resultMap.put(storageKey2, serialize(key2, value2)); } return resultMap; }); final Map entryMap = impl.getEntries(Arrays.asList(key1, key2)); assertThat(entryMap, CoreMatchers.notNullValue()); assertThat(entryMap.get(key1), HttpCacheEntryMatcher.equivalent(value1)); assertThat(entryMap.get(key2), HttpCacheEntryMatcher.equivalent(value2)); verify(impl, Mockito.times(2)).digestToStorageKey(key1); verify(impl, Mockito.times(2)).digestToStorageKey(key2); verify(impl).bulkRestore(Arrays.asList(storageKey1, storageKey2)); } @Test void testBulkGetKeyMismatch() throws Exception { final String key1 = "foo this"; final String key2 = "foo that"; final String storageKey1 = "bar this"; final String storageKey2 = "bar that"; final HttpCacheEntry value1 = HttpTestUtils.makeCacheEntry(); final HttpCacheEntry value2 = HttpTestUtils.makeCacheEntry(); when(impl.digestToStorageKey(key1)).thenReturn(storageKey1); when(impl.digestToStorageKey(key2)).thenReturn(storageKey2); when(impl.bulkRestore(ArgumentMatchers.anyCollection())).thenAnswer((Answer>) invocation -> { final Collection keys = invocation.getArgument(0); final Map resultMap = new HashMap<>(); if (keys.contains(storageKey1)) { resultMap.put(storageKey1, serialize(key1, value1)); } if (keys.contains(storageKey2)) { resultMap.put(storageKey2, serialize("not foo", value2)); } return resultMap; }); final Map entryMap = impl.getEntries(Arrays.asList(key1, key2)); assertThat(entryMap, CoreMatchers.notNullValue()); assertThat(entryMap.get(key1), HttpCacheEntryMatcher.equivalent(value1)); assertThat(entryMap.get(key2), CoreMatchers.nullValue()); verify(impl, Mockito.times(2)).digestToStorageKey(key1); verify(impl, Mockito.times(2)).digestToStorageKey(key2); verify(impl).bulkRestore(Arrays.asList(storageKey1, storageKey2)); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestViaCacheGenerator.java0100664 0000000 0000000 00000006240 14704162040 031547 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.apache.hc.core5.http.HttpVersion; import org.hamcrest.MatcherAssert; import org.hamcrest.Matchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestViaCacheGenerator { private ViaCacheGenerator impl; @BeforeEach void setUp() { impl = new ViaCacheGenerator(); } @Test void testViaValueGeneration() { Assertions.assertEquals("1.1 localhost (Apache-HttpClient/UNAVAILABLE (cache))", impl.generateViaHeader(null, HttpVersion.DEFAULT)); Assertions.assertEquals("2.0 localhost (Apache-HttpClient/UNAVAILABLE (cache))", impl.generateViaHeader(null, HttpVersion.HTTP_2)); } @Test void testViaValueLookup() { MatcherAssert.assertThat(impl.lookup(HttpVersion.DEFAULT), Matchers.startsWith("1.1 localhost (Apache-HttpClient/")); MatcherAssert.assertThat(impl.lookup(HttpVersion.HTTP_1_0), Matchers.startsWith("1.0 localhost (Apache-HttpClient/")); MatcherAssert.assertThat(impl.lookup(HttpVersion.HTTP_1_1), Matchers.startsWith("1.1 localhost (Apache-HttpClient/")); MatcherAssert.assertThat(impl.lookup(HttpVersion.HTTP_2), Matchers.startsWith("2.0 localhost (Apache-HttpClient/")); MatcherAssert.assertThat(impl.lookup(HttpVersion.HTTP_2_0), Matchers.startsWith("2.0 localhost (Apache-HttpClient/")); MatcherAssert.assertThat(impl.lookup(HttpVersion.HTTP_1_0), Matchers.startsWith("1.0 localhost (Apache-HttpClient/")); MatcherAssert.assertThat(impl.lookup(HttpVersion.HTTP_1_1), Matchers.startsWith("1.1 localhost (Apache-HttpClient/")); MatcherAssert.assertThat(impl.lookup(HttpVersion.HTTP_2_0), Matchers.startsWith("2.0 localhost (Apache-HttpClient/")); Assertions.assertEquals(3, impl.internalCache.size()); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/ResponseEquivalent.java0100664 0000000 0000000 00000003572 14666635064 031260 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.apache.hc.core5.http.HttpResponse; import org.mockito.ArgumentMatcher; import org.mockito.ArgumentMatchers; public class ResponseEquivalent implements ArgumentMatcher { private final T expected; public ResponseEquivalent(final T expected) { this.expected = expected; } @Override public boolean matches(final T argument) { if (argument == null) { return false; } return HttpTestUtils.equivalent(expected, argument); } public static T eq(final T response) { return ArgumentMatchers.argThat(new ResponseEquivalent<>(response)); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCacheRevalidatorBase.java0100664 0000000 0000000 00000011754 14704162040 032236 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.mockito.Mockito.doThrow; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import java.util.concurrent.RejectedExecutionException; import org.apache.hc.client5.http.schedule.SchedulingStrategy; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentMatchers; import org.mockito.Mock; import org.mockito.MockitoAnnotations; class TestCacheRevalidatorBase { @Mock private SchedulingStrategy mockSchedulingStrategy; @Mock private CacheRevalidatorBase.ScheduledExecutor mockScheduledExecutor; @Mock private Runnable mockOperation; private CacheRevalidatorBase impl; @BeforeEach void setUp() { MockitoAnnotations.openMocks(this); impl = new CacheRevalidatorBase(mockScheduledExecutor, mockSchedulingStrategy); } @Test void testRevalidateCacheEntrySchedulesExecutionAndPopulatesIdentifier() { when(mockSchedulingStrategy.schedule(ArgumentMatchers.anyInt())).thenReturn(TimeValue.ofSeconds(1)); final String cacheKey = "blah"; impl.scheduleRevalidation(cacheKey, mockOperation); verify(mockSchedulingStrategy).schedule(0); verify(mockScheduledExecutor).schedule(ArgumentMatchers.same(mockOperation), ArgumentMatchers.eq(TimeValue.ofSeconds(1))); Assertions.assertEquals(1, impl.getScheduledIdentifiers().size()); } @Test void testMarkCompleteRemovesIdentifier() { when(mockSchedulingStrategy.schedule(ArgumentMatchers.anyInt())).thenReturn(TimeValue.ofSeconds(3)); final String cacheKey = "blah"; impl.scheduleRevalidation(cacheKey, mockOperation); verify(mockSchedulingStrategy).schedule(0); verify(mockScheduledExecutor).schedule(ArgumentMatchers.any(), ArgumentMatchers.eq(TimeValue.ofSeconds(3))); Assertions.assertEquals(1, impl.getScheduledIdentifiers().size()); Assertions.assertTrue(impl.getScheduledIdentifiers().contains(cacheKey)); impl.jobSuccessful(cacheKey); Assertions.assertEquals(0, impl.getScheduledIdentifiers().size()); } @Test void testRevalidateCacheEntryDoesNotPopulateIdentifierOnRejectedExecutionException() { when(mockSchedulingStrategy.schedule(ArgumentMatchers.anyInt())).thenReturn(TimeValue.ofSeconds(2)); doThrow(new RejectedExecutionException()).when(mockScheduledExecutor).schedule(ArgumentMatchers.any(), ArgumentMatchers.any()); final String cacheKey = "blah"; impl.scheduleRevalidation(cacheKey, mockOperation); Assertions.assertEquals(0, impl.getScheduledIdentifiers().size()); verify(mockScheduledExecutor).schedule(ArgumentMatchers.any(), ArgumentMatchers.eq(TimeValue.ofSeconds(2))); } @Test void testRevalidateCacheEntryProperlyCollapsesRequest() { when(mockSchedulingStrategy.schedule(ArgumentMatchers.anyInt())).thenReturn(TimeValue.ofSeconds(2)); final String cacheKey = "blah"; impl.scheduleRevalidation(cacheKey, mockOperation); impl.scheduleRevalidation(cacheKey, mockOperation); impl.scheduleRevalidation(cacheKey, mockOperation); verify(mockSchedulingStrategy).schedule(ArgumentMatchers.anyInt()); verify(mockScheduledExecutor).schedule(ArgumentMatchers.any(), ArgumentMatchers.eq(TimeValue.ofSeconds(2))); Assertions.assertEquals(1, impl.getScheduledIdentifiers().size()); } @Test void testShutdown() throws Exception { impl.close(); impl.awaitTermination(Timeout.ofMinutes(2)); verify(mockScheduledExecutor).shutdown(); verify(mockScheduledExecutor).awaitTermination(Timeout.ofMinutes(2)); } } ././@LongLink0100644 0000000 0000000 00000000147 14704162040 011633 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestProtocolAllowedBehavior.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestProtocolAllowedBehavior.ja0100664 0000000 0000000 00000010566 14704162040 032505 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.io.IOException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; /** * This class tests behavior that is allowed (MAY) by the HTTP/1.1 protocol * specification and for which we have implemented the behavior in HTTP cache. */ class TestProtocolAllowedBehavior { static final int MAX_BYTES = 1024; static final int MAX_ENTRIES = 100; static final int ENTITY_LENGTH = 128; HttpHost host; HttpRoute route; HttpCacheContext context; @Mock ExecChain mockExecChain; @Mock ExecRuntime mockExecRuntime; @Mock HttpCache mockCache; ClassicHttpRequest request; ClassicHttpResponse originResponse; CacheConfig config; CachingExec impl; HttpCache cache; @BeforeEach void setUp() throws Exception { MockitoAnnotations.openMocks(this); host = new HttpHost("foo.example.com", 80); route = new HttpRoute(host); request = new BasicClassicHttpRequest("GET", "/foo"); context = HttpCacheContext.create(); originResponse = HttpTestUtils.make200Response(); config = CacheConfig.custom() .setMaxCacheEntries(MAX_ENTRIES) .setMaxObjectSize(MAX_BYTES) .setSharedCache(false) .build(); cache = new BasicHttpCache(config); impl = new CachingExec(cache, null, config); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); } public ClassicHttpResponse execute(final ClassicHttpRequest request) throws IOException, HttpException { return impl.execute( ClassicRequestBuilder.copy(request).build(), new ExecChain.Scope("test", route, request, mockExecRuntime, context), mockExecChain); } @Test void testNonSharedCacheMayCacheResponsesWithCacheControlPrivate() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET","/"); originResponse.setHeader("Cache-Control","private,max-age=3600"); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET","/"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(req1); final HttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_OK, result.getCode()); Mockito.verifyNoInteractions(mockCache); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/RequestEquivalent.java0100664 0000000 0000000 00000003562 14666635064 031111 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import org.apache.hc.core5.http.HttpRequest; import org.mockito.ArgumentMatcher; import org.mockito.ArgumentMatchers; public class RequestEquivalent implements ArgumentMatcher { private final T expected; public RequestEquivalent(final T expected) { this.expected = expected; } @Override public boolean matches(final T argument) { if (argument == null) { return false; } return HttpTestUtils.equivalent(expected, argument); } public static T eq(final T request) { return ArgumentMatchers.argThat(new RequestEquivalent<>(request)); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/HttpCacheEntryMatcher.java0100664 0000000 0000000 00000012306 14704162040 031566 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.time.Instant; import java.time.temporal.ChronoUnit; import java.util.Arrays; import java.util.Iterator; import java.util.Objects; import java.util.Set; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.core5.http.Header; import org.hamcrest.BaseMatcher; import org.hamcrest.Description; import org.hamcrest.Matcher; public class HttpCacheEntryMatcher extends BaseMatcher { private final HttpCacheEntry expectedValue; public HttpCacheEntryMatcher(final HttpCacheEntry expectedValue) { this.expectedValue = expectedValue; } @Override public boolean matches(final Object item) { if (item instanceof HttpCacheEntry) { try { final HttpCacheEntry otherValue = (HttpCacheEntry) item; if (!setEqual(expectedValue.getVariants(), otherValue.getVariants())) { return false; } if (!Objects.equals(expectedValue.getRequestMethod(), otherValue.getRequestMethod())) { return false; } if (!Objects.equals(expectedValue.getRequestURI(), otherValue.getRequestURI())) { return false; } if (!headersEqual(expectedValue.requestHeaderIterator(), otherValue.requestHeaderIterator())) { return false; } if (!instantEqual(expectedValue.getRequestInstant(), otherValue.getRequestInstant())) { return false; } if (expectedValue.getStatus() != otherValue.getStatus()) { return false; } if (!headersEqual(expectedValue.headerIterator(), otherValue.headerIterator())) { return false; } if (!instantEqual(expectedValue.getResponseInstant(), otherValue.getResponseInstant())) { return false; } final Resource expectedResource = expectedValue.getResource(); final byte[] expectedContent = expectedResource != null ? expectedResource.get() : null; final Resource otherResource = otherValue.getResource(); final byte[] otherContent = otherResource != null ? otherResource.get() : null; return Arrays.equals(expectedContent, otherContent); } catch (final ResourceIOException ex) { throw new RuntimeException(ex); } } return false; } private static boolean instantEqual(final Instant expected, final Instant other) { final Instant expectedMs = expected != null ? expected.truncatedTo(ChronoUnit.MILLIS) : null; final Instant otherMs = other != null ? other.truncatedTo(ChronoUnit.MILLIS) : null; return Objects.equals(expectedMs, otherMs); } private static boolean headersEqual(final Iterator
expected, final Iterator
other) { while (expected.hasNext()) { final Header h1 = expected.next(); if (!other.hasNext()) { return false; } final Header h2 = other.next(); if (!h1.getName().equals(h2.getName()) || !Objects.equals(h1.getValue(), h2.getValue())) { return false; } } if (other.hasNext()) { return false; } return true; } private static boolean setEqual(final Set expected, final Set actual) { if (expected.size() != actual.size()) { return false; } return actual.containsAll(expected); } @Override public void describeTo(final Description description) { description.appendValue(expectedValue); } public static Matcher equivalent(final HttpCacheEntry target) { return new HttpCacheEntryMatcher(target); } } ././@LongLink0100644 0000000 0000000 00000000147 14704162040 011633 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/SimpleHttpAsyncCacheStorage.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/SimpleHttpAsyncCacheStorage.ja0100664 0000000 0000000 00000010020 14704162040 032375 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.util.Collection; import java.util.HashMap; import java.util.Map; import org.apache.hc.client5.http.cache.HttpAsyncCacheStorage; import org.apache.hc.client5.http.cache.HttpCacheCASOperation; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.ResourceIOException; import org.apache.hc.client5.http.impl.Operations; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.FutureCallback; class SimpleHttpAsyncCacheStorage implements HttpAsyncCacheStorage { public final Map map; public SimpleHttpAsyncCacheStorage() { map = new HashMap<>(); } @Override public Cancellable putEntry(final String key, final HttpCacheEntry entry, final FutureCallback callback) { map.put(key, entry); if (callback != null) { callback.completed(true); } return Operations.nonCancellable(); } public void putEntry(final String key, final HttpCacheEntry entry) { map.put(key, entry); } @Override public Cancellable getEntry(final String key, final FutureCallback callback) { final HttpCacheEntry entry = map.get(key); if (callback != null) { callback.completed(entry); } return Operations.nonCancellable(); } public HttpCacheEntry getEntry(final String key) { return map.get(key); } @Override public Cancellable removeEntry(final String key, final FutureCallback callback) { final HttpCacheEntry removed = map.remove(key); if (callback != null) { callback.completed(removed != null); } return Operations.nonCancellable(); } @Override public Cancellable updateEntry(final String key, final HttpCacheCASOperation casOperation, final FutureCallback callback) { final HttpCacheEntry v1 = map.get(key); try { final HttpCacheEntry v2 = casOperation.execute(v1); map.put(key,v2); if (callback != null) { callback.completed(true); } } catch (final ResourceIOException ex) { if (callback != null) { callback.failed(ex); } } return Operations.nonCancellable(); } @Override public Cancellable getEntries(final Collection keys, final FutureCallback> callback) { final Map resultMap = new HashMap<>(keys.size()); for (final String key: keys) { final HttpCacheEntry entry = map.get(key); if (entry != null) { resultMap.put(key, entry); } } callback.completed(resultMap); return Operations.nonCancellable(); } } ././@LongLink0100644 0000000 0000000 00000000160 14704162040 011626 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCachedResponseSuitabilityChecker.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCachedResponseSuitabilityC0100664 0000000 0000000 00000060441 14704162040 032534 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.time.Instant; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.apache.hc.client5.http.cache.ResponseCacheControl; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestCachedResponseSuitabilityChecker { private Instant now; private Instant elevenSecondsAgo; private Instant tenSecondsAgo; private Instant nineSecondsAgo; private HttpRequest request; private HttpCacheEntry entry; private RequestCacheControl requestCacheControl; private ResponseCacheControl responseCacheControl; private CachedResponseSuitabilityChecker impl; @BeforeEach void setUp() { now = Instant.now(); elevenSecondsAgo = now.minusSeconds(11); tenSecondsAgo = now.minusSeconds(10); nineSecondsAgo = now.minusSeconds(9); request = new BasicHttpRequest("GET", "/foo"); entry = HttpTestUtils.makeCacheEntry(); requestCacheControl = RequestCacheControl.builder().build(); responseCacheControl = ResponseCacheControl.builder().build(); impl = new CachedResponseSuitabilityChecker(CacheConfig.DEFAULT); } private HttpCacheEntry makeEntry(final Instant requestDate, final Instant responseDate, final Method method, final String requestUri, final Header[] requestHeaders, final int status, final Header[] responseHeaders) { return HttpTestUtils.makeCacheEntry(requestDate, responseDate, method, requestUri, requestHeaders, status, responseHeaders, HttpTestUtils.makeNullResource()); } private HttpCacheEntry makeEntry(final Header... headers) { return makeEntry(elevenSecondsAgo, nineSecondsAgo, Method.GET, "/foo", null, 200, headers); } private HttpCacheEntry makeEntry(final Instant requestDate, final Instant responseDate, final Header... headers) { return makeEntry(requestDate, responseDate, Method.GET, "/foo", null, 200, headers); } private HttpCacheEntry makeEntry(final Method method, final String requestUri, final Header... headers) { return makeEntry(elevenSecondsAgo, nineSecondsAgo, method, requestUri, null, 200, headers); } private HttpCacheEntry makeEntry(final Method method, final String requestUri, final Header[] requestHeaders, final int status, final Header[] responseHeaders) { return makeEntry(elevenSecondsAgo, nineSecondsAgo, method, requestUri, requestHeaders, status, responseHeaders); } @Test void testRequestMethodMatch() { request = new BasicHttpRequest("GET", "/foo"); entry = makeEntry(Method.GET, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); Assertions.assertTrue(impl.requestMethodMatch(request, entry)); request = new BasicHttpRequest("HEAD", "/foo"); Assertions.assertTrue(impl.requestMethodMatch(request, entry)); request = new BasicHttpRequest("POST", "/foo"); Assertions.assertFalse(impl.requestMethodMatch(request, entry)); request = new BasicHttpRequest("HEAD", "/foo"); entry = makeEntry(Method.HEAD, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); Assertions.assertTrue(impl.requestMethodMatch(request, entry)); request = new BasicHttpRequest("GET", "/foo"); entry = makeEntry(Method.HEAD, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); Assertions.assertFalse(impl.requestMethodMatch(request, entry)); } @Test void testRequestUriMatch() { request = new BasicHttpRequest("GET", "/foo"); entry = makeEntry(Method.GET, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); Assertions.assertTrue(impl.requestUriMatch(request, entry)); request = new BasicHttpRequest("GET", new HttpHost("some-host"), "/foo"); entry = makeEntry(Method.GET, "http://some-host:80/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); Assertions.assertTrue(impl.requestUriMatch(request, entry)); request = new BasicHttpRequest("GET", new HttpHost("Some-Host"), "/foo?bar"); entry = makeEntry(Method.GET, "http://some-host:80/foo?bar", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); Assertions.assertTrue(impl.requestUriMatch(request, entry)); request = new BasicHttpRequest("GET", new HttpHost("some-other-host"), "/foo"); entry = makeEntry(Method.GET, "http://some-host:80/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); Assertions.assertFalse(impl.requestUriMatch(request, entry)); request = new BasicHttpRequest("GET", new HttpHost("some-host"), "/foo?huh"); entry = makeEntry(Method.GET, "http://some-host:80/foo?bar", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); Assertions.assertFalse(impl.requestUriMatch(request, entry)); } @Test void testRequestHeadersMatch() { request = BasicRequestBuilder.get("/foo").build(); entry = makeEntry( Method.GET, "/foo", new Header[]{}, 200, new Header[]{ new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)) }); Assertions.assertTrue(impl.requestHeadersMatch(request, entry)); request = BasicRequestBuilder.get("/foo").build(); entry = makeEntry( Method.GET, "/foo", new Header[]{}, 200, new Header[]{ new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("Vary", "") }); Assertions.assertTrue(impl.requestHeadersMatch(request, entry)); request = BasicRequestBuilder.get("/foo") .addHeader("Accept-Encoding", "blah") .build(); entry = makeEntry( Method.GET, "/foo", new Header[]{ new BasicHeader("Accept-Encoding", "blah") }, 200, new Header[]{ new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("Vary", "Accept-Encoding") }); Assertions.assertTrue(impl.requestHeadersMatch(request, entry)); request = BasicRequestBuilder.get("/foo") .addHeader("Accept-Encoding", "gzip, deflate, deflate , zip, ") .build(); entry = makeEntry( Method.GET, "/foo", new Header[]{ new BasicHeader("Accept-Encoding", " gzip, zip, deflate") }, 200, new Header[]{ new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("Vary", "Accept-Encoding") }); Assertions.assertTrue(impl.requestHeadersMatch(request, entry)); request = BasicRequestBuilder.get("/foo") .addHeader("Accept-Encoding", "gzip, deflate, zip") .build(); entry = makeEntry( Method.GET, "/foo", new Header[]{ new BasicHeader("Accept-Encoding", " gzip, deflate") }, 200, new Header[]{ new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("Vary", "Accept-Encoding") }); Assertions.assertFalse(impl.requestHeadersMatch(request, entry)); } @Test void testResponseNoCache() { entry = makeEntry(new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setNoCache(false) .build(); Assertions.assertFalse(impl.isResponseNoCache(responseCacheControl, entry)); responseCacheControl = ResponseCacheControl.builder() .setNoCache(true) .build(); Assertions.assertTrue(impl.isResponseNoCache(responseCacheControl, entry)); responseCacheControl = ResponseCacheControl.builder() .setNoCache(true) .setNoCacheFields("stuff", "more-stuff") .build(); Assertions.assertFalse(impl.isResponseNoCache(responseCacheControl, entry)); entry = makeEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)), new BasicHeader("stuff", "booh")); Assertions.assertTrue(impl.isResponseNoCache(responseCacheControl, entry)); } @Test void testSuitableIfCacheEntryIsFresh() { entry = makeEntry(new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(3600) .build(); Assertions.assertEquals(CacheSuitability.FRESH, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testNotSuitableIfCacheEntryIsNotFresh() { entry = makeEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(5) .build(); Assertions.assertEquals(CacheSuitability.STALE, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testNotSuitableIfRequestHasNoCache() { requestCacheControl = RequestCacheControl.builder() .setNoCache(true) .build(); entry = makeEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(3600) .build(); Assertions.assertEquals(CacheSuitability.REVALIDATION_REQUIRED, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testNotSuitableIfAgeExceedsRequestMaxAge() { requestCacheControl = RequestCacheControl.builder() .setMaxAge(10) .build(); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(3600) .build(); entry = makeEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); Assertions.assertEquals(CacheSuitability.REVALIDATION_REQUIRED, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testSuitableIfFreshAndAgeIsUnderRequestMaxAge() { requestCacheControl = RequestCacheControl.builder() .setMaxAge(15) .build(); entry = makeEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(3600) .build(); Assertions.assertEquals(CacheSuitability.FRESH, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testSuitableIfFreshAndFreshnessLifetimeGreaterThanRequestMinFresh() { requestCacheControl = RequestCacheControl.builder() .setMinFresh(10) .build(); entry = makeEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(3600) .build(); Assertions.assertEquals(CacheSuitability.FRESH, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testNotSuitableIfFreshnessLifetimeLessThanRequestMinFresh() { requestCacheControl = RequestCacheControl.builder() .setMinFresh(10) .build(); entry = makeEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(15) .build(); Assertions.assertEquals(CacheSuitability.REVALIDATION_REQUIRED, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testSuitableEvenIfStaleButPermittedByRequestMaxStale() { requestCacheControl = RequestCacheControl.builder() .setMaxStale(10) .build(); final Header[] headers = { new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)) }; entry = makeEntry(headers); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(5) .build(); Assertions.assertEquals(CacheSuitability.FRESH_ENOUGH, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testNotSuitableIfStaleButTooStaleForRequestMaxStale() { requestCacheControl = RequestCacheControl.builder() .setMaxStale(2) .build(); entry = makeEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(5) .build(); Assertions.assertEquals(CacheSuitability.REVALIDATION_REQUIRED, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testSuitableIfCacheEntryIsHeuristicallyFreshEnough() { final Instant oneSecondAgo = now.minusSeconds(1); final Instant twentyOneSecondsAgo = now.minusSeconds(21); entry = makeEntry(oneSecondAgo, oneSecondAgo, new BasicHeader("Date", DateUtils.formatStandardDate(oneSecondAgo)), new BasicHeader("Last-Modified", DateUtils.formatStandardDate(twentyOneSecondsAgo))); final CacheConfig config = CacheConfig.custom() .setHeuristicCachingEnabled(true) .setHeuristicCoefficient(0.1f).build(); impl = new CachedResponseSuitabilityChecker(config); Assertions.assertEquals(CacheSuitability.FRESH, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testSuitableIfCacheEntryIsHeuristicallyFreshEnoughByDefault() { entry = makeEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); final CacheConfig config = CacheConfig.custom() .setHeuristicCachingEnabled(true) .setHeuristicDefaultLifetime(TimeValue.ofSeconds(20L)) .build(); impl = new CachedResponseSuitabilityChecker(config); Assertions.assertEquals(CacheSuitability.FRESH, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testSuitableIfRequestMethodisHEAD() { final HttpRequest headRequest = new BasicHttpRequest("HEAD", "/foo"); entry = makeEntry( new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(3600) .build(); Assertions.assertEquals(CacheSuitability.FRESH, impl.assessSuitability(requestCacheControl, responseCacheControl, headRequest, entry, now)); } @Test void testSuitableForGETIfEntryDoesNotSpecifyARequestMethodButContainsEntity() { impl = new CachedResponseSuitabilityChecker(CacheConfig.custom().build()); entry = makeEntry(Method.GET, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(3600) .build(); Assertions.assertEquals(CacheSuitability.FRESH, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testSuitableForGETIfHeadResponseCachingEnabledAndEntryDoesNotSpecifyARequestMethodButContains204Response() { impl = new CachedResponseSuitabilityChecker(CacheConfig.custom().build()); entry = makeEntry(Method.GET, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(3600) .build(); Assertions.assertEquals(CacheSuitability.FRESH, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testSuitableForHEADIfHeadResponseCachingEnabledAndEntryDoesNotSpecifyARequestMethod() { final HttpRequest headRequest = new BasicHttpRequest("HEAD", "/foo"); impl = new CachedResponseSuitabilityChecker(CacheConfig.custom().build()); entry = makeEntry(Method.GET, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(3600) .build(); Assertions.assertEquals(CacheSuitability.FRESH, impl.assessSuitability(requestCacheControl, responseCacheControl, headRequest, entry, now)); } @Test void testNotSuitableIfGetRequestWithHeadCacheEntry() { // Prepare a cache entry with HEAD method entry = makeEntry(Method.HEAD, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(3600) .build(); // Validate that the cache entry is not suitable for the GET request Assertions.assertEquals(CacheSuitability.MISMATCH, impl.assessSuitability(requestCacheControl, responseCacheControl, request, entry, now)); } @Test void testSuitableIfErrorRequestCacheControl() { // Prepare a cache entry with HEAD method entry = makeEntry(Method.GET, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(5) .build(); // the entry has been stale for 6 seconds requestCacheControl = RequestCacheControl.builder() .setStaleIfError(10) .build(); Assertions.assertTrue(impl.isSuitableIfError(requestCacheControl, responseCacheControl, entry, now)); requestCacheControl = RequestCacheControl.builder() .setStaleIfError(5) .build(); Assertions.assertFalse(impl.isSuitableIfError(requestCacheControl, responseCacheControl, entry, now)); requestCacheControl = RequestCacheControl.builder() .setStaleIfError(10) .setMinFresh(4) // should take precedence over stale-if-error .build(); Assertions.assertFalse(impl.isSuitableIfError(requestCacheControl, responseCacheControl, entry, now)); requestCacheControl = RequestCacheControl.builder() .setStaleIfError(-1) // not set or not valid .build(); Assertions.assertFalse(impl.isSuitableIfError(requestCacheControl, responseCacheControl, entry, now)); } @Test void testSuitableIfErrorResponseCacheControl() { // Prepare a cache entry with HEAD method entry = makeEntry(Method.GET, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(5) .setStaleIfError(10) .build(); // the entry has been stale for 6 seconds Assertions.assertTrue(impl.isSuitableIfError(requestCacheControl, responseCacheControl, entry, now)); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(5) .setStaleIfError(5) .build(); Assertions.assertFalse(impl.isSuitableIfError(requestCacheControl, responseCacheControl, entry, now)); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(5) .setStaleIfError(-1) // not set or not valid .build(); Assertions.assertFalse(impl.isSuitableIfError(requestCacheControl, responseCacheControl, entry, now)); } @Test void testSuitableIfErrorRequestCacheControlTakesPrecedenceOverResponseCacheControl() { // Prepare a cache entry with HEAD method entry = makeEntry(Method.GET, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(5) .setStaleIfError(5) .build(); // the entry has been stale for 6 seconds Assertions.assertFalse(impl.isSuitableIfError(requestCacheControl, responseCacheControl, entry, now)); requestCacheControl = RequestCacheControl.builder() .setStaleIfError(10) .build(); Assertions.assertTrue(impl.isSuitableIfError(requestCacheControl, responseCacheControl, entry, now)); } @Test void testSuitableIfErrorConfigDefault() { // Prepare a cache entry with HEAD method entry = makeEntry(Method.GET, "/foo", new BasicHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo))); responseCacheControl = ResponseCacheControl.builder() .setMaxAge(5) .build(); impl = new CachedResponseSuitabilityChecker(CacheConfig.custom() .setStaleIfErrorEnabled(true) .build()); Assertions.assertTrue(impl.isSuitableIfError(requestCacheControl, responseCacheControl, entry, now)); requestCacheControl = RequestCacheControl.builder() .setStaleIfError(5) .build(); Assertions.assertFalse(impl.isSuitableIfError(requestCacheControl, responseCacheControl, entry, now)); } } ././@LongLink0100644 0000000 0000000 00000000150 14704162040 011625 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestResponseCacheConformance.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestResponseCacheConformance.j0100664 0000000 0000000 00000006711 14704162040 032445 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.junit.jupiter.api.Assertions.assertFalse; import java.time.Instant; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.support.BasicResponseBuilder; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestResponseCacheConformance { private ResponseCacheConformance impl; @BeforeEach void setUp() { impl = ResponseCacheConformance.INSTANCE; } private void shouldStripEntityHeaderFromOrigin304ResponseToStrongValidation( final String entityHeader, final String entityHeaderValue) throws Exception { final HttpResponse response = BasicResponseBuilder.create(HttpStatus.SC_NOT_MODIFIED) .addHeader("Date", DateUtils.formatStandardDate(Instant.now())) .addHeader("Etag", "\"etag\"") .addHeader(entityHeader, entityHeaderValue) .build(); impl.process(response, null, null); assertFalse(response.containsHeader(entityHeader)); } @Test void shouldStripContentEncodingFromOrigin304ResponseToStrongValidation() throws Exception { shouldStripEntityHeaderFromOrigin304ResponseToStrongValidation( "Content-Encoding", "gzip"); } @Test void shouldStripContentLanguageFromOrigin304ResponseToStrongValidation() throws Exception { shouldStripEntityHeaderFromOrigin304ResponseToStrongValidation( "Content-Language", "en"); } @Test void shouldStripContentLengthFromOrigin304ResponseToStrongValidation() throws Exception { shouldStripEntityHeaderFromOrigin304ResponseToStrongValidation( "Content-Length", "128"); } @Test void shouldStripContentMD5FromOrigin304ResponseToStrongValidation() throws Exception { shouldStripEntityHeaderFromOrigin304ResponseToStrongValidation( "Content-MD5", "Q2hlY2sgSW50ZWdyaXR5IQ=="); } @Test void shouldStripContentTypeFromOrigin304ResponseToStrongValidation() throws Exception { shouldStripEntityHeaderFromOrigin304ResponseToStrongValidation( "Content-Type", "text/html;charset=utf-8"); } } ././@LongLink0100644 0000000 0000000 00000000147 15005672016 011637 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestProtocolRecommendations.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestProtocolRecommendations.ja0100664 0000000 0000000 00000130035 15005672016 032563 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNotEquals; import static org.junit.jupiter.api.Assertions.assertTrue; import java.io.IOException; import java.time.Instant; import java.time.temporal.ChronoUnit; import java.util.Iterator; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.http.message.MessageSupport; import org.hamcrest.MatcherAssert; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; /* * This test class captures functionality required to achieve unconditional * compliance with the HTTP/1.1 caching protocol (SHOULD, SHOULD NOT, * RECOMMENDED, and NOT RECOMMENDED behaviors). */ class TestProtocolRecommendations { static final int MAX_BYTES = 1024; static final int MAX_ENTRIES = 100; static final int ENTITY_LENGTH = 128; HttpHost host; HttpRoute route; HttpEntity body; HttpCacheContext context; @Mock ExecChain mockExecChain; @Mock ExecRuntime mockExecRuntime; ClassicHttpRequest request; ClassicHttpResponse originResponse; CacheConfig config; CachingExec impl; HttpCache cache; Instant now; Instant tenSecondsAgo; Instant twoMinutesAgo; @BeforeEach void setUp() throws Exception { MockitoAnnotations.openMocks(this); host = new HttpHost("foo.example.com", 80); route = new HttpRoute(host); body = HttpTestUtils.makeBody(ENTITY_LENGTH); request = new BasicClassicHttpRequest("GET", "/foo"); context = HttpCacheContext.create(); originResponse = HttpTestUtils.make200Response(); config = CacheConfig.custom() .setMaxCacheEntries(MAX_ENTRIES) .setMaxObjectSize(MAX_BYTES) .build(); cache = new BasicHttpCache(config); impl = new CachingExec(cache, null, config); now = Instant.now(); tenSecondsAgo = now.minus(10, ChronoUnit.SECONDS); twoMinutesAgo = now.minus(1, ChronoUnit.MINUTES); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); } public ClassicHttpResponse execute(final ClassicHttpRequest request) throws IOException, HttpException { return impl.execute( ClassicRequestBuilder.copy(request).build(), new ExecChain.Scope("test", route, request, mockExecRuntime, context), mockExecChain); } private void cacheGenerated304ForValidatorShouldNotContainEntityHeader( final String headerName, final String headerValue, final String validatorHeader, final String validator, final String conditionalHeader) throws Exception { final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","max-age=3600"); resp1.setHeader(validatorHeader, validator); resp1.setHeader(headerName, headerValue); resp1.setHeader("ETag", "\"etag\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader(conditionalHeader, validator); execute(req1); final ClassicHttpResponse result = execute(req2); assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); assertFalse(result.containsHeader(headerName)); } private void cacheGenerated304ForStrongETagValidatorShouldNotContainEntityHeader( final String headerName, final String headerValue) throws Exception { cacheGenerated304ForValidatorShouldNotContainEntityHeader(headerName, headerValue, "ETag", "\"etag\"", "If-None-Match"); } private void cacheGenerated304ForStrongDateValidatorShouldNotContainEntityHeader( final String headerName, final String headerValue) throws Exception { cacheGenerated304ForValidatorShouldNotContainEntityHeader(headerName, headerValue, "Last-Modified", DateUtils.formatStandardDate(twoMinutesAgo), "If-Modified-Since"); } @Test void cacheGenerated304ForStrongEtagValidatorShouldNotContainAllow() throws Exception { cacheGenerated304ForStrongETagValidatorShouldNotContainEntityHeader( "Allow", "GET,HEAD"); } @Test void cacheGenerated304ForStrongDateValidatorShouldNotContainAllow() throws Exception { cacheGenerated304ForStrongDateValidatorShouldNotContainEntityHeader( "Allow", "GET,HEAD"); } @Test void cacheGenerated304ForStrongEtagValidatorShouldNotContainContentEncoding() throws Exception { cacheGenerated304ForStrongETagValidatorShouldNotContainEntityHeader( "Content-Encoding", "gzip"); } @Test void cacheGenerated304ForStrongDateValidatorShouldNotContainContentEncoding() throws Exception { cacheGenerated304ForStrongDateValidatorShouldNotContainEntityHeader( "Content-Encoding", "gzip"); } @Test void cacheGenerated304ForStrongEtagValidatorShouldNotContainContentLanguage() throws Exception { cacheGenerated304ForStrongETagValidatorShouldNotContainEntityHeader( "Content-Language", "en"); } @Test void cacheGenerated304ForStrongDateValidatorShouldNotContainContentLanguage() throws Exception { cacheGenerated304ForStrongDateValidatorShouldNotContainEntityHeader( "Content-Language", "en"); } @Test void cacheGenerated304ForStrongValidatorShouldNotContainContentLength() throws Exception { cacheGenerated304ForStrongETagValidatorShouldNotContainEntityHeader( "Content-Length", "128"); } @Test void cacheGenerated304ForStrongDateValidatorShouldNotContainContentLength() throws Exception { cacheGenerated304ForStrongDateValidatorShouldNotContainEntityHeader( "Content-Length", "128"); } @Test void cacheGenerated304ForStrongValidatorShouldNotContainContentMD5() throws Exception { cacheGenerated304ForStrongETagValidatorShouldNotContainEntityHeader( "Content-MD5", "Q2hlY2sgSW50ZWdyaXR5IQ=="); } @Test void cacheGenerated304ForStrongDateValidatorShouldNotContainContentMD5() throws Exception { cacheGenerated304ForStrongDateValidatorShouldNotContainEntityHeader( "Content-MD5", "Q2hlY2sgSW50ZWdyaXR5IQ=="); } @Test void cacheGenerated304ForStrongEtagValidatorShouldNotContainContentType() throws Exception { cacheGenerated304ForStrongETagValidatorShouldNotContainEntityHeader( "Content-Type", "text/html"); } @Test void cacheGenerated304ForStrongDateValidatorShouldNotContainContentType() throws Exception { cacheGenerated304ForStrongDateValidatorShouldNotContainEntityHeader( "Content-Type", "text/html"); } @Test void cacheGenerated304ForStrongEtagValidatorShouldNotContainLastModified() throws Exception { cacheGenerated304ForStrongETagValidatorShouldNotContainEntityHeader( "Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); } @Test void cacheGenerated304ForStrongDateValidatorShouldNotContainLastModified() throws Exception { cacheGenerated304ForStrongDateValidatorShouldNotContainEntityHeader( "Last-Modified", DateUtils.formatStandardDate(twoMinutesAgo)); } private ClassicHttpRequest requestToPopulateStaleCacheEntry() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control","public,max-age=5"); resp1.setHeader("Etag","\"etag\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); return req1; } private void testDoesNotReturnStaleResponseOnError(final ClassicHttpRequest req2) throws Exception { final ClassicHttpRequest req1 = requestToPopulateStaleCacheEntry(); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenThrow(new IOException()); ClassicHttpResponse result = null; try { result = execute(req2); } catch (final IOException expected) { } if (result != null) { assertNotEquals(HttpStatus.SC_OK, result.getCode()); } } @Test void testDoesNotReturnStaleResponseIfClientExplicitlyRequestsFirstHandOneWithCacheControl() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("GET", "/"); req.setHeader("Cache-Control","no-cache"); testDoesNotReturnStaleResponseOnError(req); } @Test void testDoesNotReturnStaleResponseIfClientExplicitlyRequestsFreshWithMaxAge() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("GET", "/"); req.setHeader("Cache-Control","max-age=0"); testDoesNotReturnStaleResponseOnError(req); } @Test void testDoesNotReturnStaleResponseIfClientExplicitlySpecifiesLargerMaxAge() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("GET", "/"); req.setHeader("Cache-Control","max-age=20"); testDoesNotReturnStaleResponseOnError(req); } @Test void testDoesNotReturnStaleResponseIfClientExplicitlyRequestsFreshWithMinFresh() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("GET", "/"); req.setHeader("Cache-Control","min-fresh=2"); testDoesNotReturnStaleResponseOnError(req); } @Test void testDoesNotReturnStaleResponseIfClientExplicitlyRequestsFreshWithMaxStale() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("GET", "/"); req.setHeader("Cache-Control","max-stale=2"); testDoesNotReturnStaleResponseOnError(req); } @Test void testMayReturnStaleResponseIfClientExplicitlySpecifiesAcceptableMaxStale() throws Exception { final ClassicHttpRequest req1 = requestToPopulateStaleCacheEntry(); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Cache-Control","max-stale=20"); execute(req1); final ClassicHttpResponse result = execute(req2); assertEquals(HttpStatus.SC_OK, result.getCode()); Mockito.verify(mockExecChain, Mockito.atMost(1)).proceed(Mockito.any(), Mockito.any()); } private void testDoesNotModifyHeaderOnResponses(final String headerName) throws Exception { final String headerValue = HttpTestUtils .getCanonicalHeaderValue(originResponse, headerName); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); MatcherAssert.assertThat(result, ContainsHeaderMatcher.contains(headerName, headerValue)); } private void testDoesNotModifyHeaderOnRequests(final String headerName) throws Exception { final String headerValue = HttpTestUtils.getCanonicalHeaderValue(request, headerName); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(request); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain).proceed(reqCapture.capture(), Mockito.any()); assertEquals(headerValue, HttpTestUtils.getCanonicalHeaderValue(reqCapture.getValue(), headerName)); } @Test void testDoesNotModifyAcceptRangesOnResponses() throws Exception { final String headerName = "Accept-Ranges"; originResponse.setHeader(headerName,"bytes"); testDoesNotModifyHeaderOnResponses(headerName); } @Test void testDoesNotModifyAuthorizationOnRequests() throws Exception { request.setHeader("Authorization", StandardAuthScheme.BASIC + " dXNlcjpwYXNzd2Q="); testDoesNotModifyHeaderOnRequests("Authorization"); } @Test void testDoesNotModifyContentLengthOnRequests() throws Exception { final ClassicHttpRequest post = new BasicClassicHttpRequest("POST", "/"); post.setEntity(HttpTestUtils.makeBody(128)); post.setHeader("Content-Length","128"); request = post; testDoesNotModifyHeaderOnRequests("Content-Length"); } @Test void testDoesNotModifyContentLengthOnResponses() throws Exception { originResponse.setEntity(HttpTestUtils.makeBody(128)); originResponse.setHeader("Content-Length","128"); testDoesNotModifyHeaderOnResponses("Content-Length"); } @Test void testDoesNotModifyContentMD5OnRequests() throws Exception { final ClassicHttpRequest post = new BasicClassicHttpRequest("POST", "/"); post.setEntity(HttpTestUtils.makeBody(128)); post.setHeader("Content-Length","128"); post.setHeader("Content-MD5","Q2hlY2sgSW50ZWdyaXR5IQ=="); request = post; testDoesNotModifyHeaderOnRequests("Content-MD5"); } @Test void testDoesNotModifyContentMD5OnResponses() throws Exception { originResponse.setEntity(HttpTestUtils.makeBody(128)); originResponse.setHeader("Content-MD5","Q2hlY2sgSW50ZWdyaXR5IQ=="); testDoesNotModifyHeaderOnResponses("Content-MD5"); } @Test void testDoesNotModifyContentRangeOnRequests() throws Exception { final ClassicHttpRequest put = new BasicClassicHttpRequest("PUT", "/"); put.setEntity(HttpTestUtils.makeBody(128)); put.setHeader("Content-Length","128"); put.setHeader("Content-Range","bytes 0-127/256"); request = put; testDoesNotModifyHeaderOnRequests("Content-Range"); } @Test void testDoesNotModifyContentRangeOnResponses() throws Exception { request.setHeader("Range","bytes=0-128"); originResponse.setCode(HttpStatus.SC_PARTIAL_CONTENT); originResponse.setReasonPhrase("Partial Content"); originResponse.setEntity(HttpTestUtils.makeBody(128)); originResponse.setHeader("Content-Range","bytes 0-127/256"); testDoesNotModifyHeaderOnResponses("Content-Range"); } @Test void testDoesNotModifyContentTypeOnRequests() throws Exception { final ClassicHttpRequest post = new BasicClassicHttpRequest("POST", "/"); post.setEntity(HttpTestUtils.makeBody(128)); post.setHeader("Content-Length","128"); post.setHeader("Content-Type","application/octet-stream"); request = post; testDoesNotModifyHeaderOnRequests("Content-Type"); } @Test void testDoesNotModifyContentTypeOnResponses() throws Exception { originResponse.setHeader("Content-Type","application/octet-stream"); testDoesNotModifyHeaderOnResponses("Content-Type"); } @Test void testDoesNotModifyDateOnRequests() throws Exception { request.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); testDoesNotModifyHeaderOnRequests("Date"); } @Test void testDoesNotModifyDateOnResponses() throws Exception { originResponse.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); testDoesNotModifyHeaderOnResponses("Date"); } @Test void testDoesNotModifyETagOnResponses() throws Exception { originResponse.setHeader("ETag", "\"random-etag\""); testDoesNotModifyHeaderOnResponses("ETag"); } @Test void testDoesNotModifyExpiresOnResponses() throws Exception { originResponse.setHeader("Expires", DateUtils.formatStandardDate(Instant.now())); testDoesNotModifyHeaderOnResponses("Expires"); } @Test void testDoesNotModifyFromOnRequests() throws Exception { request.setHeader("From", "foo@example.com"); testDoesNotModifyHeaderOnRequests("From"); } @Test void testDoesNotModifyIfMatchOnRequests() throws Exception { request = new BasicClassicHttpRequest("DELETE", "/"); request.setHeader("If-Match", "\"etag\""); testDoesNotModifyHeaderOnRequests("If-Match"); } @Test void testDoesNotModifyIfModifiedSinceOnRequests() throws Exception { request.setHeader("If-Modified-Since", DateUtils.formatStandardDate(Instant.now())); testDoesNotModifyHeaderOnRequests("If-Modified-Since"); } @Test void testDoesNotModifyIfNoneMatchOnRequests() throws Exception { request.setHeader("If-None-Match", "\"etag\""); testDoesNotModifyHeaderOnRequests("If-None-Match"); } @Test void testDoesNotModifyIfRangeOnRequests() throws Exception { request.setHeader("Range","bytes=0-128"); request.setHeader("If-Range", "\"etag\""); testDoesNotModifyHeaderOnRequests("If-Range"); } @Test void testDoesNotModifyIfUnmodifiedSinceOnRequests() throws Exception { request = new BasicClassicHttpRequest("DELETE", "/"); request.setHeader("If-Unmodified-Since", DateUtils.formatStandardDate(Instant.now())); testDoesNotModifyHeaderOnRequests("If-Unmodified-Since"); } @Test void testDoesNotModifyLastModifiedOnResponses() throws Exception { originResponse.setHeader("Last-Modified", DateUtils.formatStandardDate(Instant.now())); testDoesNotModifyHeaderOnResponses("Last-Modified"); } @Test void testDoesNotModifyLocationOnResponses() throws Exception { originResponse.setCode(HttpStatus.SC_TEMPORARY_REDIRECT); originResponse.setReasonPhrase("Temporary Redirect"); originResponse.setHeader("Location", "http://foo.example.com/bar"); testDoesNotModifyHeaderOnResponses("Location"); } @Test void testDoesNotModifyRangeOnRequests() throws Exception { request.setHeader("Range", "bytes=0-128"); testDoesNotModifyHeaderOnRequests("Range"); } @Test void testDoesNotModifyRefererOnRequests() throws Exception { request.setHeader("Referer", "http://foo.example.com/bar"); testDoesNotModifyHeaderOnRequests("Referer"); } @Test void testDoesNotModifyRetryAfterOnResponses() throws Exception { originResponse.setCode(HttpStatus.SC_SERVICE_UNAVAILABLE); originResponse.setReasonPhrase("Service Unavailable"); originResponse.setHeader("Retry-After", "120"); testDoesNotModifyHeaderOnResponses("Retry-After"); } @Test void testDoesNotModifyServerOnResponses() throws Exception { originResponse.setHeader("Server", "SomeServer/1.0"); testDoesNotModifyHeaderOnResponses("Server"); } @Test void testDoesNotModifyUserAgentOnRequests() throws Exception { request.setHeader("User-Agent", "MyClient/1.0"); testDoesNotModifyHeaderOnRequests("User-Agent"); } @Test void testDoesNotModifyVaryOnResponses() throws Exception { request.setHeader("Accept-Encoding","identity"); originResponse.setHeader("Vary", "Accept-Encoding"); testDoesNotModifyHeaderOnResponses("Vary"); } @Test void testDoesNotModifyExtensionHeaderOnRequests() throws Exception { request.setHeader("X-Extension","x-value"); testDoesNotModifyHeaderOnRequests("X-Extension"); } @Test void testDoesNotModifyExtensionHeaderOnResponses() throws Exception { originResponse.setHeader("X-Extension", "x-value"); testDoesNotModifyHeaderOnResponses("X-Extension"); } @Test void testUsesLastModifiedDateForCacheConditionalRequests() throws Exception { final Instant twentySecondsAgo = now.plusSeconds(20); final String lmDate = DateUtils.formatStandardDate(twentySecondsAgo); final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Last-Modified", lmDate); resp1.setHeader("Cache-Control","max-age=5"); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(reqCapture.capture(), Mockito.any()); final ClassicHttpRequest captured = reqCapture.getValue(); MatcherAssert.assertThat(captured, ContainsHeaderMatcher.contains("If-Modified-Since", lmDate)); } @Test void testUsesBothLastModifiedAndETagForConditionalRequestsIfAvailable() throws Exception { final Instant twentySecondsAgo = now.plusSeconds(20); final String lmDate = DateUtils.formatStandardDate(twentySecondsAgo); final String etag = "\"etag\""; final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Last-Modified", lmDate); resp1.setHeader("Cache-Control","max-age=5"); resp1.setHeader("ETag", etag); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(reqCapture.capture(), Mockito.any()); final ClassicHttpRequest captured = reqCapture.getValue(); MatcherAssert.assertThat(captured, ContainsHeaderMatcher.contains("If-Modified-Since", lmDate)); MatcherAssert.assertThat(captured, ContainsHeaderMatcher.contains("If-None-Match", etag)); } @Test void testRevalidatesCachedResponseWithExpirationInThePast() throws Exception { final Instant oneSecondAgo = now.minusSeconds(1); final Instant oneSecondFromNow = now.plusSeconds(1); final Instant twoSecondsFromNow = now.plusSeconds(2); final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("ETag","\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Expires",DateUtils.formatStandardDate(oneSecondAgo)); resp1.setHeader("Cache-Control", "public"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpRequest revalidate = new BasicClassicHttpRequest("GET", "/"); revalidate.setHeader("If-None-Match","\"etag\""); final ClassicHttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(twoSecondsFromNow)); resp2.setHeader("Expires", DateUtils.formatStandardDate(oneSecondFromNow)); resp2.setHeader("ETag","\"etag\""); Mockito.when(mockExecChain.proceed(RequestEquivalent.eq(revalidate), Mockito.any())).thenReturn(resp2); execute(req1); final ClassicHttpResponse result = execute(req2); assertEquals(HttpStatus.SC_OK, result.getCode()); } @Test void testRetriesValidationThatResultsInAnOlderDated304Response() throws Exception { final Instant elevenSecondsAgo = now.minusSeconds(11); final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("ETag","\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control","max-age=5"); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make304Response(); resp2.setHeader("ETag","\"etag\""); resp2.setHeader("Date", DateUtils.formatStandardDate(elevenSecondsAgo)); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain, Mockito.times(3)).proceed(reqCapture.capture(), Mockito.any()); final ClassicHttpRequest captured = reqCapture.getValue(); boolean hasMaxAge0 = false; boolean hasNoCache = false; final Iterator it = MessageSupport.iterate(captured, HttpHeaders.CACHE_CONTROL); while (it.hasNext()) { final HeaderElement elt = it.next(); if ("max-age".equals(elt.getName())) { try { final int maxage = Integer.parseInt(elt.getValue()); if (maxage == 0) { hasMaxAge0 = true; } } catch (final NumberFormatException nfe) { // nop } } else if ("no-cache".equals(elt.getName())) { hasNoCache = true; } } assertTrue(hasMaxAge0 || hasNoCache); assertFalse(captured.containsHeader("If-None-Match")); assertFalse(captured.containsHeader("If-Modified-Since")); assertFalse(captured.containsHeader("If-Range")); assertFalse(captured.containsHeader("If-Match")); assertFalse(captured.containsHeader("If-Unmodified-Since")); } @Test void testSendsAllVariantEtagsInConditionalRequest() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET","/"); req1.setHeader("User-Agent","agent1"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","max-age=3600"); resp1.setHeader("Vary","User-Agent"); resp1.setHeader("Etag","\"etag1\""); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET","/"); req2.setHeader("User-Agent","agent2"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("Cache-Control","max-age=3600"); resp2.setHeader("Vary","User-Agent"); resp2.setHeader("Etag","\"etag2\""); final ClassicHttpRequest req3 = new BasicClassicHttpRequest("GET","/"); req3.setHeader("User-Agent","agent3"); final ClassicHttpResponse resp3 = HttpTestUtils.make200Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); Mockito.when(mockExecChain.proceed(Mockito.any(),Mockito.any())).thenReturn(resp3); execute(req3); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain, Mockito.times(3)).proceed(reqCapture.capture(), Mockito.any()); final ClassicHttpRequest captured = reqCapture.getValue(); boolean foundEtag1 = false; boolean foundEtag2 = false; for (final Header h : captured.getHeaders("If-None-Match")) { for (final String etag : h.getValue().split(",")) { if ("\"etag1\"".equals(etag.trim())) { foundEtag1 = true; } if ("\"etag2\"".equals(etag.trim())) { foundEtag2 = true; } } } assertTrue(foundEtag1 && foundEtag2); } @Test void testResponseToExistingVariantsUpdatesEntry() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); req1.setHeader("User-Agent", "agent1"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Vary", "User-Agent"); resp1.setHeader("Cache-Control", "max-age=3600"); resp1.setHeader("ETag", "\"etag1\""); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("User-Agent", "agent2"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp2.setHeader("Vary", "User-Agent"); resp2.setHeader("Cache-Control", "max-age=3600"); resp2.setHeader("ETag", "\"etag2\""); final ClassicHttpRequest req3 = new BasicClassicHttpRequest("GET", "/"); req3.setHeader("User-Agent", "agent3"); final ClassicHttpResponse resp3 = new BasicClassicHttpResponse(HttpStatus.SC_NOT_MODIFIED, "Not Modified"); resp3.setHeader("Date", DateUtils.formatStandardDate(now)); resp3.setHeader("ETag", "\"etag1\""); final ClassicHttpRequest req4 = new BasicClassicHttpRequest("GET", "/"); req4.setHeader("User-Agent", "agent1"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp3); final ClassicHttpResponse result1 = execute(req3); final ClassicHttpResponse result2 = execute(req4); assertEquals(HttpStatus.SC_OK, result1.getCode()); MatcherAssert.assertThat(result1, ContainsHeaderMatcher.contains("ETag", "\"etag1\"")); MatcherAssert.assertThat(result1, ContainsHeaderMatcher.contains("Date", DateUtils.formatStandardDate(now))); MatcherAssert.assertThat(result2, ContainsHeaderMatcher.contains("Date", DateUtils.formatStandardDate(now))); } @Test void testResponseToExistingVariantsIsCachedForFutureResponses() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); req1.setHeader("User-Agent", "agent1"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Vary", "User-Agent"); resp1.setHeader("Cache-Control", "max-age=3600"); resp1.setHeader("ETag", "\"etag1\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("User-Agent", "agent2"); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_NOT_MODIFIED, "Not Modified"); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("ETag", "\"etag1\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); final ClassicHttpRequest req3 = new BasicClassicHttpRequest("GET", "/"); req3.setHeader("User-Agent", "agent2"); execute(req3); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); } @Test void shouldInvalidateNonvariantCacheEntryForUnknownMethod() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("FROB", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("Cache-Control","max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpRequest req3 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp3 = HttpTestUtils.make200Response(); resp3.setHeader("ETag", "\"etag\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp3); execute(req2); final ClassicHttpResponse result = execute(req3); assertTrue(HttpTestUtils.semanticallyTransparent(resp3, result)); } @Test void shouldInvalidateAllVariantsForUnknownMethod() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); req1.setHeader("User-Agent", "agent1"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","max-age=3600"); resp1.setHeader("Vary", "User-Agent"); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("User-Agent", "agent2"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("Cache-Control","max-age=3600"); resp2.setHeader("Vary", "User-Agent"); final ClassicHttpRequest req3 = new BasicClassicHttpRequest("FROB", "/"); req3.setHeader("User-Agent", "agent3"); final ClassicHttpResponse resp3 = HttpTestUtils.make200Response(); resp3.setHeader("Cache-Control","max-age=3600"); final ClassicHttpRequest req4 = new BasicClassicHttpRequest("GET", "/"); req4.setHeader("User-Agent", "agent1"); final ClassicHttpResponse resp4 = HttpTestUtils.make200Response(); resp4.setHeader("ETag", "\"etag1\""); final ClassicHttpRequest req5 = new BasicClassicHttpRequest("GET", "/"); req5.setHeader("User-Agent", "agent2"); final ClassicHttpResponse resp5 = HttpTestUtils.make200Response(); resp5.setHeader("ETag", "\"etag2\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp3); execute(req3); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp4); final ClassicHttpResponse result4 = execute(req4); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp5); final ClassicHttpResponse result5 = execute(req5); assertTrue(HttpTestUtils.semanticallyTransparent(resp4, result4)); assertTrue(HttpTestUtils.semanticallyTransparent(resp5, result5)); } @Test void cacheShouldUpdateWithNewCacheableResponse() throws Exception { final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "max-age=3600"); resp1.setHeader("ETag", "\"etag1\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader("Cache-Control", "max-age=0"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); resp2.setHeader("Cache-Control", "max-age=3600"); resp2.setHeader("ETag", "\"etag2\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpRequest req3 = HttpTestUtils.makeDefaultRequest(); execute(req2); final ClassicHttpResponse result = execute(req3); assertTrue(HttpTestUtils.semanticallyTransparent(resp2, result)); } @Test void expiresEqualToDateWithNoCacheControlIsNotCacheable() throws Exception { final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Expires", DateUtils.formatStandardDate(now)); resp1.removeHeaders("Cache-Control"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader("Cache-Control", "max-stale=1000"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("ETag", "\"etag2\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); assertTrue(HttpTestUtils.semanticallyTransparent(resp2, result)); } @Test void expiresPriorToDateWithNoCacheControlIsNotCacheable() throws Exception { final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Expires", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.removeHeaders("Cache-Control"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader("Cache-Control", "max-stale=1000"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("ETag", "\"etag2\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); assertTrue(HttpTestUtils.semanticallyTransparent(resp2, result)); } @Test void cacheMissResultsIn504WithOnlyIfCached() throws Exception { final ClassicHttpRequest req = HttpTestUtils.makeDefaultRequest(); req.setHeader("Cache-Control", "only-if-cached"); final ClassicHttpResponse result = execute(req); assertEquals(HttpStatus.SC_GATEWAY_TIMEOUT, result.getCode()); } @Test void cacheHitOkWithOnlyIfCached() throws Exception { final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader("Cache-Control", "only-if-cached"); execute(req1); final ClassicHttpResponse result = execute(req2); assertTrue(HttpTestUtils.semanticallyTransparent(resp1, result)); } @Test void returns504ForStaleEntryWithOnlyIfCached() throws Exception { final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control","max-age=5"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader("Cache-Control", "only-if-cached"); execute(req1); final ClassicHttpResponse result = execute(req2); assertEquals(HttpStatus.SC_GATEWAY_TIMEOUT, result.getCode()); } @Test void returnsStaleCacheEntryWithOnlyIfCachedAndMaxStale() throws Exception { final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control","max-age=5"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader("Cache-Control", "max-stale=20, only-if-cached"); execute(req1); final ClassicHttpResponse result = execute(req2); assertTrue(HttpTestUtils.semanticallyTransparent(resp1, result)); } @Test void issues304EvenWithWeakETag() throws Exception { final ClassicHttpRequest req1 = HttpTestUtils.makeDefaultRequest(); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control", "max-age=300"); resp1.setHeader("ETag","W/\"weak-sauce\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpRequest req2 = HttpTestUtils.makeDefaultRequest(); req2.setHeader("If-None-Match","W/\"weak-sauce\""); execute(req1); final ClassicHttpResponse result = execute(req2); assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestProtocolRequirements.java0100664 0000000 0000000 00000272061 15005672016 032454 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.hamcrest.MatcherAssert.assertThat; import java.io.IOException; import java.io.InputStream; import java.net.SocketTimeoutException; import java.time.Instant; import java.time.temporal.ChronoUnit; import java.util.Iterator; import java.util.List; import java.util.Random; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.cache.HttpCacheContext; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.MessageSupport; import org.hamcrest.MatcherAssert; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; /* * This test class captures functionality required to achieve conditional * compliance with the HTTP/1.1 caching protocol (MUST and MUST NOT behaviors). */ class TestProtocolRequirements { static final int MAX_BYTES = 1024; static final int MAX_ENTRIES = 100; static final int ENTITY_LENGTH = 128; HttpHost host; HttpRoute route; HttpEntity body; HttpCacheContext context; @Mock ExecChain mockExecChain; @Mock ExecRuntime mockExecRuntime; @Mock HttpCache mockCache; ClassicHttpRequest request; ClassicHttpResponse originResponse; CacheConfig config; CachingExec impl; HttpCache cache; @BeforeEach void setUp() throws Exception { MockitoAnnotations.openMocks(this); host = new HttpHost("foo.example.com", 80); route = new HttpRoute(host); body = HttpTestUtils.makeBody(ENTITY_LENGTH); request = new BasicClassicHttpRequest("GET", "/"); context = HttpCacheContext.create(); originResponse = HttpTestUtils.make200Response(); config = CacheConfig.custom() .setMaxCacheEntries(MAX_ENTRIES) .setMaxObjectSize(MAX_BYTES) .build(); cache = new BasicHttpCache(config); impl = new CachingExec(cache, null, config); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); } public ClassicHttpResponse execute(final ClassicHttpRequest request) throws IOException, HttpException { return impl.execute( ClassicRequestBuilder.copy(request).build(), new ExecChain.Scope("test", route, request, mockExecRuntime, context), mockExecChain); } @Test void testCacheMissOnGETUsesOriginResponse() throws Exception { Mockito.when(mockExecChain.proceed(RequestEquivalent.eq(request), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); Assertions.assertTrue(HttpTestUtils.semanticallyTransparent(originResponse, result)); } private void testOrderOfMultipleHeadersIsPreservedOnResponses(final String h) throws Exception { Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); Assertions.assertNotNull(result); Assertions.assertEquals(HttpTestUtils.getCanonicalHeaderValue(originResponse, h), HttpTestUtils .getCanonicalHeaderValue(result, h)); } @Test void testOrderOfMultipleAllowHeadersIsPreservedOnResponses() throws Exception { originResponse = new BasicClassicHttpResponse(405, "Method Not Allowed"); originResponse.addHeader("Allow", "HEAD"); originResponse.addHeader("Allow", "DELETE"); testOrderOfMultipleHeadersIsPreservedOnResponses("Allow"); } @Test void testOrderOfMultipleCacheControlHeadersIsPreservedOnResponses() throws Exception { originResponse.addHeader("Cache-Control", "max-age=0"); originResponse.addHeader("Cache-Control", "no-store, must-revalidate"); testOrderOfMultipleHeadersIsPreservedOnResponses("Cache-Control"); } @Test void testOrderOfMultipleContentEncodingHeadersIsPreservedOnResponses() throws Exception { originResponse.addHeader("Content-Encoding", "gzip"); originResponse.addHeader("Content-Encoding", "compress"); testOrderOfMultipleHeadersIsPreservedOnResponses("Content-Encoding"); } @Test void testOrderOfMultipleContentLanguageHeadersIsPreservedOnResponses() throws Exception { originResponse.addHeader("Content-Language", "mi"); originResponse.addHeader("Content-Language", "en"); testOrderOfMultipleHeadersIsPreservedOnResponses("Content-Language"); } @Test void testOrderOfMultipleViaHeadersIsPreservedOnResponses() throws Exception { originResponse.addHeader(HttpHeaders.VIA, "1.0 fred, 1.1 nowhere.com (Apache/1.1)"); originResponse.addHeader(HttpHeaders.VIA, "1.0 ricky, 1.1 mertz, 1.0 lucy"); testOrderOfMultipleHeadersIsPreservedOnResponses(HttpHeaders.VIA); } @Test void testOrderOfMultipleWWWAuthenticateHeadersIsPreservedOnResponses() throws Exception { originResponse.addHeader("WWW-Authenticate", "x-challenge-1"); originResponse.addHeader("WWW-Authenticate", "x-challenge-2"); testOrderOfMultipleHeadersIsPreservedOnResponses("WWW-Authenticate"); } private void testUnknownResponseStatusCodeIsNotCached(final int code) throws Exception { originResponse = new BasicClassicHttpResponse(code, "Moo"); originResponse.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); originResponse.setHeader("Server", "MockOrigin/1.0"); originResponse.setHeader("Cache-Control", "max-age=3600"); originResponse.setEntity(body); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(request); // in particular, there were no storage calls on the cache Mockito.verifyNoInteractions(mockCache); } @Test void testUnknownResponseStatusCodesAreNotCached() throws Exception { for (int i = 100; i <= 199; i++) { testUnknownResponseStatusCodeIsNotCached(i); } for (int i = 207; i <= 299; i++) { testUnknownResponseStatusCodeIsNotCached(i); } for (int i = 308; i <= 399; i++) { testUnknownResponseStatusCodeIsNotCached(i); } for (int i = 418; i <= 499; i++) { testUnknownResponseStatusCodeIsNotCached(i); } for (int i = 506; i <= 999; i++) { testUnknownResponseStatusCodeIsNotCached(i); } } @Test void testUnknownHeadersOnRequestsAreForwarded() throws Exception { request.addHeader("X-Unknown-Header", "blahblah"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(request); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain).proceed(reqCapture.capture(), Mockito.any()); final ClassicHttpRequest forwarded = reqCapture.getValue(); MatcherAssert.assertThat(forwarded, ContainsHeaderMatcher.contains("X-Unknown-Header", "blahblah")); } @Test void testUnknownHeadersOnResponsesAreForwarded() throws Exception { originResponse.addHeader("X-Unknown-Header", "blahblah"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); MatcherAssert.assertThat(result, ContainsHeaderMatcher.contains("X-Unknown-Header", "blahblah")); } @Test void testResponsesToOPTIONSAreNotCacheable() throws Exception { request = new BasicClassicHttpRequest("OPTIONS", "/"); originResponse.addHeader("Cache-Control", "max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(request); Mockito.verifyNoInteractions(mockCache); } @Test void testResponsesToPOSTWithoutCacheControlOrExpiresAreNotCached() throws Exception { final BasicClassicHttpRequest post = new BasicClassicHttpRequest("POST", "/"); post.setHeader("Content-Length", "128"); post.setEntity(HttpTestUtils.makeBody(128)); originResponse.removeHeaders("Cache-Control"); originResponse.removeHeaders("Expires"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(post); Mockito.verifyNoInteractions(mockCache); } @Test void testResponsesToPUTsAreNotCached() throws Exception { final BasicClassicHttpRequest put = new BasicClassicHttpRequest("PUT", "/"); put.setEntity(HttpTestUtils.makeBody(128)); put.addHeader("Content-Length", "128"); originResponse.setHeader("Cache-Control", "max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(put); Mockito.verifyNoInteractions(mockCache); } @Test void testResponsesToDELETEsAreNotCached() throws Exception { request = new BasicClassicHttpRequest("DELETE", "/"); originResponse.setHeader("Cache-Control", "max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(request); Mockito.verifyNoInteractions(mockCache); } @Test void testResponsesToTRACEsAreNotCached() throws Exception { request = new BasicClassicHttpRequest("TRACE", "/"); originResponse.setHeader("Cache-Control", "max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(request); Mockito.verifyNoInteractions(mockCache); } @Test void test304ResponseGeneratedFromCacheIncludesDateHeader() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); originResponse.setHeader("Cache-Control", "max-age=3600"); originResponse.setHeader("ETag", "\"etag\""); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("If-None-Match", "\"etag\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); Assertions.assertNotNull(result.getFirstHeader("Date")); Mockito.verify(mockExecChain, Mockito.times(1)).proceed(Mockito.any(), Mockito.any()); } @Test void test304ResponseGeneratedFromCacheIncludesEtagIfOriginResponseDid() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); originResponse.setHeader("Cache-Control", "max-age=3600"); originResponse.setHeader("ETag", "\"etag\""); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("If-None-Match", "\"etag\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); Assertions.assertNotNull(result.getFirstHeader("ETag")); Mockito.verify(mockExecChain, Mockito.times(1)).proceed(Mockito.any(), Mockito.any()); } @Test void test304ResponseGeneratedFromCacheIncludesContentLocationIfOriginResponseDid() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); originResponse.setHeader("Cache-Control", "max-age=3600"); originResponse.setHeader("Content-Location", "http://foo.example.com/other"); originResponse.setHeader("ETag", "\"etag\""); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("If-None-Match", "\"etag\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); Assertions.assertNotNull(result.getFirstHeader("Content-Location")); Mockito.verify(mockExecChain, Mockito.times(1)).proceed(Mockito.any(), Mockito.any()); } @Test void test304ResponseGeneratedFromCacheIncludesExpiresCacheControlAndOrVaryIfResponseMightDiffer() throws Exception { final Instant now = Instant.now(); final Instant inTwoHours = now.plus(2, ChronoUnit.HOURS); final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); req1.setHeader("Accept-Encoding", "gzip"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("ETag", "\"v1\""); resp1.setHeader("Cache-Control", "max-age=7200"); resp1.setHeader("Expires", DateUtils.formatStandardDate(inTwoHours)); resp1.setHeader("Vary", "Accept-Encoding"); resp1.setEntity(HttpTestUtils.makeBody(ENTITY_LENGTH)); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Accept-Encoding", "gzip"); req2.setHeader("Cache-Control", "no-cache"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("ETag", "\"v2\""); resp2.setHeader("Cache-Control", "max-age=3600"); resp2.setHeader("Expires", DateUtils.formatStandardDate(inTwoHours)); resp2.setHeader("Vary", "Accept-Encoding"); resp2.setEntity(HttpTestUtils.makeBody(ENTITY_LENGTH)); final ClassicHttpRequest req3 = new BasicClassicHttpRequest("GET", "/"); req3.setHeader("Accept-Encoding", "gzip"); req3.setHeader("If-None-Match", "\"v2\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); final ClassicHttpResponse result = execute(req3); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); Assertions.assertNotNull(result.getFirstHeader("Expires")); Assertions.assertNotNull(result.getFirstHeader("Cache-Control")); Assertions.assertNotNull(result.getFirstHeader("Vary")); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); } @Test void test304GeneratedFromCacheOnWeakValidatorDoesNotIncludeOtherEntityHeaders() throws Exception { final Instant now = Instant.now(); final Instant oneHourAgo = now.minus(1, ChronoUnit.HOURS); final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("ETag", "W/\"v1\""); resp1.setHeader("Allow", "GET,HEAD"); resp1.setHeader("Content-Encoding", "x-coding"); resp1.setHeader("Content-Language", "en"); resp1.setHeader("Content-Length", "128"); resp1.setHeader("Content-MD5", "Q2hlY2sgSW50ZWdyaXR5IQ=="); resp1.setHeader("Content-Type", "application/octet-stream"); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(oneHourAgo)); resp1.setHeader("Cache-Control", "max-age=7200"); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("If-None-Match", "W/\"v1\""); Mockito.when(mockExecChain.proceed(RequestEquivalent.eq(req1), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); Assertions.assertNull(result.getFirstHeader("Allow")); Assertions.assertNull(result.getFirstHeader("Content-Encoding")); Assertions.assertNull(result.getFirstHeader("Content-Length")); Assertions.assertNull(result.getFirstHeader("Content-MD5")); Assertions.assertNull(result.getFirstHeader("Content-Type")); Assertions.assertNull(result.getFirstHeader("Last-Modified")); Mockito.verify(mockExecChain, Mockito.times(1)).proceed(Mockito.any(), Mockito.any()); } @Test void testNotModifiedOfNonCachedEntityShouldRevalidateWithUnconditionalGET() throws Exception { // load cache with cacheable entry final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Cache-Control", "max-age=3600"); // force a revalidation final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Cache-Control", "max-age=0,max-stale=0"); // unconditional validation doesn't use If-None-Match final ClassicHttpRequest unconditionalValidation = new BasicClassicHttpRequest("GET", "/"); // new response to unconditional validation provides new body final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp1.setHeader("ETag", "\"etag2\""); resp1.setHeader("Cache-Control", "max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); // this next one will happen once if the cache tries to // conditionally validate, zero if it goes full revalidation Mockito.when(mockExecChain.proceed(RequestEquivalent.eq(unconditionalValidation), Mockito.any())).thenReturn(resp2); execute(req1); execute(req2); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); } @Test void testCacheEntryIsUpdatedWithNewFieldValuesIn304Response() throws Exception { final Instant now = Instant.now(); final Instant inFiveSeconds = now.plusSeconds(5); final ClassicHttpRequest initialRequest = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse cachedResponse = HttpTestUtils.make200Response(); cachedResponse.setHeader("Cache-Control", "max-age=3600"); cachedResponse.setHeader("ETag", "\"etag\""); final ClassicHttpRequest secondRequest = new BasicClassicHttpRequest("GET", "/"); secondRequest.setHeader("Cache-Control", "max-age=0,max-stale=0"); final ClassicHttpRequest conditionalValidationRequest = new BasicClassicHttpRequest("GET", "/"); conditionalValidationRequest.setHeader("If-None-Match", "\"etag\""); // to be used if the cache generates a conditional validation final ClassicHttpResponse conditionalResponse = HttpTestUtils.make304Response(); conditionalResponse.setHeader("Date", DateUtils.formatStandardDate(inFiveSeconds)); conditionalResponse.setHeader("Server", "MockUtils/1.0"); conditionalResponse.setHeader("ETag", "\"etag\""); conditionalResponse.setHeader("X-Extra", "junk"); // to be used if the cache generates an unconditional validation final ClassicHttpResponse unconditionalResponse = HttpTestUtils.make200Response(); unconditionalResponse.setHeader("Date", DateUtils.formatStandardDate(inFiveSeconds)); unconditionalResponse.setHeader("ETag", "\"etag\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(cachedResponse); Mockito.when(mockExecChain.proceed(RequestEquivalent.eq(conditionalValidationRequest), Mockito.any())).thenReturn(conditionalResponse); execute(initialRequest); final ClassicHttpResponse result = execute(secondRequest); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); Assertions.assertEquals(DateUtils.formatStandardDate(inFiveSeconds), result.getFirstHeader("Date").getValue()); Assertions.assertEquals("junk", result.getFirstHeader("X-Extra").getValue()); } @Test void testMustReturnACacheEntryIfItCanRevalidateIt() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final Instant nineSecondsAgo = now.minusSeconds(9); final Instant eightSecondsAgo = now.minusSeconds(8); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(tenSecondsAgo, eightSecondsAgo, Method.GET, "/thing", null, 200, new Header[] { new BasicHeader("Date", DateUtils.formatStandardDate(nineSecondsAgo)), new BasicHeader("ETag", "\"etag\"") }, HttpTestUtils.makeNullResource()); impl = new CachingExec(mockCache, null, config); request = new BasicClassicHttpRequest("GET", "/thing"); final ClassicHttpRequest validate = new BasicClassicHttpRequest("GET", "/thing"); validate.setHeader("If-None-Match", "\"etag\""); final ClassicHttpResponse notModified = new BasicClassicHttpResponse(HttpStatus.SC_NOT_MODIFIED, "Not Modified"); notModified.setHeader("Date", DateUtils.formatStandardDate(now)); notModified.setHeader("ETag", "\"etag\""); Mockito.when(mockCache.match(Mockito.eq(host), RequestEquivalent.eq(request))).thenReturn( new CacheMatch(new CacheHit("key", entry), null)); Mockito.when(mockExecChain.proceed(RequestEquivalent.eq(validate), Mockito.any())).thenReturn(notModified); final HttpCacheEntry updated = HttpTestUtils.makeCacheEntry(tenSecondsAgo, eightSecondsAgo, Method.GET, "/thing", null, 200, new Header[] { new BasicHeader("Date", DateUtils.formatStandardDate(now)), new BasicHeader("ETag", "\"etag\"") }, HttpTestUtils.makeNullResource()); Mockito.when(mockCache.update( Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any(), Mockito.any())) .thenReturn(new CacheHit("key", updated)); execute(request); Mockito.verify(mockCache).update( Mockito.any(), Mockito.eq(host), RequestEquivalent.eq(request), ResponseEquivalent.eq(notModified), Mockito.any(), Mockito.any()); } @Test void testMustReturnAFreshEnoughCacheEntryIfItHasIt() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final Instant nineSecondsAgo = now.plusSeconds(9); final Instant eightSecondsAgo = now.plusSeconds(8); final Header[] hdrs = new Header[] { new BasicHeader("Date", DateUtils.formatStandardDate(nineSecondsAgo)), new BasicHeader("Cache-Control", "max-age=3600"), new BasicHeader("Content-Length", "128") }; final byte[] bytes = new byte[128]; new Random().nextBytes(bytes); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(tenSecondsAgo, eightSecondsAgo, hdrs, bytes); impl = new CachingExec(mockCache, null, config); request = new BasicClassicHttpRequest("GET", "/thing"); Mockito.when(mockCache.match(Mockito.eq(host), RequestEquivalent.eq(request))).thenReturn( new CacheMatch(new CacheHit("key", entry), null)); final ClassicHttpResponse result = execute(request); Assertions.assertEquals(200, result.getCode()); } @Test void testAgeHeaderPopulatedFromCacheEntryCurrentAge() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final Instant nineSecondsAgo = now.minusSeconds(9); final Instant eightSecondsAgo = now.minusSeconds(8); final Header[] hdrs = new Header[] { new BasicHeader("Date", DateUtils.formatStandardDate(nineSecondsAgo)), new BasicHeader("Cache-Control", "max-age=3600"), new BasicHeader("Content-Length", "128") }; final byte[] bytes = new byte[128]; new Random().nextBytes(bytes); final HttpCacheEntry entry = HttpTestUtils.makeCacheEntry(tenSecondsAgo, eightSecondsAgo, hdrs, bytes); impl = new CachingExec(mockCache, null, config); request = new BasicClassicHttpRequest("GET", "/"); Mockito.when(mockCache.match(Mockito.eq(host), RequestEquivalent.eq(request))).thenReturn( new CacheMatch(new CacheHit("key", entry), null)); final ClassicHttpResponse result = execute(request); Assertions.assertEquals(200, result.getCode()); // We calculate the age of the cache entry as per RFC 9111: // We first find the "corrected_initial_age" which is the maximum of "apparentAge" and "correctedReceivedAge". // In this case, max(1, 2) = 2 seconds. // We then add the "residentTime" which is "now - responseTime", // which is the current time minus the time the cache entry was created. In this case, that is 8 seconds. // So, the total age is "corrected_initial_age" + "residentTime" = 2 + 8 = 10 seconds. assertThat(result, ContainsHeaderMatcher.contains("Age", "10")); } @Test void testKeepsMostRecentDateHeaderForFreshResponse() throws Exception { final Instant now = Instant.now(); final Instant inFiveSecond = now.plusSeconds(5); // put an entry in the cache final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(inFiveSecond)); resp1.setHeader("ETag", "\"etag1\""); resp1.setHeader("Cache-Control", "max-age=3600"); resp1.setHeader("Content-Length", "128"); // force another origin hit final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Cache-Control", "no-cache"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("Date", DateUtils.formatStandardDate(now)); // older resp2.setHeader("ETag", "\"etag2\""); resp2.setHeader("Cache-Control", "max-age=3600"); resp2.setHeader("Content-Length", "128"); final ClassicHttpRequest req3 = new BasicClassicHttpRequest("GET", "/"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); final ClassicHttpResponse result = execute(req3); Assertions.assertEquals("\"etag1\"", result.getFirstHeader("ETag").getValue()); } @Test void testValidationMustUseETagIfProvidedByOriginServer() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "max-age=3600"); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("ETag", "W/\"etag\""); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Cache-Control", "max-age=0,max-stale=0"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); execute(req2); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(reqCapture.capture(), Mockito.any()); final List allRequests = reqCapture.getAllValues(); Assertions.assertEquals(2, allRequests.size()); final ClassicHttpRequest validation = allRequests.get(1); boolean foundETag = false; final Iterator it = MessageSupport.iterate(validation, HttpHeaders.IF_MATCH); while (it.hasNext()) { final HeaderElement elt = it.next(); if ("W/\"etag\"".equals(elt.getName())) { foundETag = true; } } final Iterator it2 = MessageSupport.iterate(validation, HttpHeaders.IF_NONE_MATCH); while (it2.hasNext()) { final HeaderElement elt = it2.next(); if ("W/\"etag\"".equals(elt.getName())) { foundETag = true; } } Assertions.assertTrue(foundETag); } @Test void testConditionalRequestWhereNotAllValidatorsMatchCannotBeServedFromCache() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final Instant twentySecondsAgo = now.plusSeconds(20); final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "max-age=3600"); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("ETag", "W/\"etag\""); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("If-None-Match", "W/\"etag\""); req2.setHeader("If-Modified-Since", DateUtils.formatStandardDate(twentySecondsAgo)); // must hit the origin again for the second request Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertNotEquals(HttpStatus.SC_NOT_MODIFIED, result.getCode()); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); } @Test void testConditionalRequestWhereAllValidatorsMatchMayBeServedFromCache() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date", DateUtils.formatStandardDate(now)); resp1.setHeader("Cache-Control", "max-age=3600"); resp1.setHeader("Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("ETag", "W/\"etag\""); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("If-None-Match", "W/\"etag\""); req2.setHeader("If-Modified-Since", DateUtils.formatStandardDate(tenSecondsAgo)); // may hit the origin again for the second request Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); execute(req2); Mockito.verify(mockExecChain, Mockito.atLeastOnce()).proceed(Mockito.any(), Mockito.any()); Mockito.verify(mockExecChain, Mockito.atMost(2)).proceed(Mockito.any(), Mockito.any()); } @Test void testCacheWithoutSupportForRangeAndContentRangeHeadersDoesNotCacheA206Response() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("GET", "/"); req.setHeader("Range", "bytes=0-50"); final ClassicHttpResponse resp = new BasicClassicHttpResponse(206, "Partial Content"); resp.setHeader("Content-Range", "bytes 0-50/128"); resp.setHeader("ETag", "\"etag\""); resp.setHeader("Cache-Control", "max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(),Mockito.any())).thenReturn(resp); execute(req); Mockito.verifyNoInteractions(mockCache); } @Test void test302ResponseWithoutExplicitCacheabilityIsNotReturnedFromCache() throws Exception { originResponse = new BasicClassicHttpResponse(302, "Temporary Redirect"); originResponse.setHeader("Location", "http://foo.example.com/other"); originResponse.removeHeaders("Expires"); originResponse.removeHeaders("Cache-Control"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(request); execute(request); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); } private void testDoesNotModifyHeaderFromOrigin(final String header, final String value) throws Exception { originResponse = HttpTestUtils.make200Response(); originResponse.setHeader(header, value); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); Assertions.assertEquals(value, result.getFirstHeader(header).getValue()); } @Test void testDoesNotModifyContentLocationHeaderFromOrigin() throws Exception { final String url = "http://foo.example.com/other"; testDoesNotModifyHeaderFromOrigin("Content-Location", url); } @Test void testDoesNotModifyContentMD5HeaderFromOrigin() throws Exception { testDoesNotModifyHeaderFromOrigin("Content-MD5", "Q2hlY2sgSW50ZWdyaXR5IQ=="); } @Test void testDoesNotModifyEtagHeaderFromOrigin() throws Exception { testDoesNotModifyHeaderFromOrigin("Etag", "\"the-etag\""); } @Test void testDoesNotModifyLastModifiedHeaderFromOrigin() throws Exception { final String lm = DateUtils.formatStandardDate(Instant.now()); testDoesNotModifyHeaderFromOrigin("Last-Modified", lm); } private void testDoesNotAddHeaderToOriginResponse(final String header) throws Exception { originResponse.removeHeaders(header); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); Assertions.assertNull(result.getFirstHeader(header)); } @Test void testDoesNotAddContentLocationToOriginResponse() throws Exception { testDoesNotAddHeaderToOriginResponse("Content-Location"); } @Test void testDoesNotAddContentMD5ToOriginResponse() throws Exception { testDoesNotAddHeaderToOriginResponse("Content-MD5"); } @Test void testDoesNotAddEtagToOriginResponse() throws Exception { testDoesNotAddHeaderToOriginResponse("ETag"); } @Test void testDoesNotAddLastModifiedToOriginResponse() throws Exception { testDoesNotAddHeaderToOriginResponse("Last-Modified"); } private void testDoesNotModifyHeaderFromOriginOnCacheHit(final String header, final String value) throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); originResponse = HttpTestUtils.make200Response(); originResponse.setHeader("Cache-Control", "max-age=3600"); originResponse.setHeader(header, value); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(value, result.getFirstHeader(header).getValue()); } @Test void testDoesNotModifyContentLocationFromOriginOnCacheHit() throws Exception { final String url = "http://foo.example.com/other"; testDoesNotModifyHeaderFromOriginOnCacheHit("Content-Location", url); } @Test void testDoesNotModifyContentMD5FromOriginOnCacheHit() throws Exception { testDoesNotModifyHeaderFromOriginOnCacheHit("Content-MD5", "Q2hlY2sgSW50ZWdyaXR5IQ=="); } @Test void testDoesNotModifyEtagFromOriginOnCacheHit() throws Exception { testDoesNotModifyHeaderFromOriginOnCacheHit("Etag", "\"the-etag\""); } @Test void testDoesNotModifyLastModifiedFromOriginOnCacheHit() throws Exception { final Instant tenSecondsAgo = Instant.now().minusSeconds(10); testDoesNotModifyHeaderFromOriginOnCacheHit("Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); } private void testDoesNotAddHeaderOnCacheHit(final String header) throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); originResponse.addHeader("Cache-Control", "max-age=3600"); originResponse.removeHeaders(header); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertNull(result.getFirstHeader(header)); } @Test void testDoesNotAddContentLocationHeaderOnCacheHit() throws Exception { testDoesNotAddHeaderOnCacheHit("Content-Location"); } @Test void testDoesNotAddContentMD5HeaderOnCacheHit() throws Exception { testDoesNotAddHeaderOnCacheHit("Content-MD5"); } @Test void testDoesNotAddETagHeaderOnCacheHit() throws Exception { testDoesNotAddHeaderOnCacheHit("ETag"); } @Test void testDoesNotAddLastModifiedHeaderOnCacheHit() throws Exception { testDoesNotAddHeaderOnCacheHit("Last-Modified"); } private void testDoesNotModifyHeaderOnRequest(final String header, final String value) throws Exception { final BasicClassicHttpRequest req = new BasicClassicHttpRequest("POST","/"); req.setEntity(HttpTestUtils.makeBody(128)); req.setHeader("Content-Length","128"); req.setHeader(header,value); execute(req); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain).proceed(reqCapture.capture(), Mockito.any()); final ClassicHttpRequest captured = reqCapture.getValue(); Assertions.assertEquals(value, captured.getFirstHeader(header).getValue()); } @Test void testDoesNotModifyContentLocationHeaderOnRequest() throws Exception { final String url = "http://foo.example.com/other"; testDoesNotModifyHeaderOnRequest("Content-Location",url); } @Test void testDoesNotModifyContentMD5HeaderOnRequest() throws Exception { testDoesNotModifyHeaderOnRequest("Content-MD5", "Q2hlY2sgSW50ZWdyaXR5IQ=="); } @Test void testDoesNotModifyETagHeaderOnRequest() throws Exception { testDoesNotModifyHeaderOnRequest("ETag","\"etag\""); } @Test void testDoesNotModifyLastModifiedHeaderOnRequest() throws Exception { final Instant tenSecondsAgo = Instant.now().minusSeconds(10); testDoesNotModifyHeaderOnRequest("Last-Modified", DateUtils.formatStandardDate(tenSecondsAgo)); } private void testDoesNotAddHeaderToRequestIfNotPresent(final String header) throws Exception { final BasicClassicHttpRequest req = new BasicClassicHttpRequest("POST","/"); req.setEntity(HttpTestUtils.makeBody(128)); req.setHeader("Content-Length","128"); req.removeHeaders(header); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(req); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain).proceed(reqCapture.capture(), Mockito.any()); final ClassicHttpRequest captured = reqCapture.getValue(); Assertions.assertNull(captured.getFirstHeader(header)); } @Test void testDoesNotAddContentLocationToRequestIfNotPresent() throws Exception { testDoesNotAddHeaderToRequestIfNotPresent("Content-Location"); } @Test void testDoesNotAddContentMD5ToRequestIfNotPresent() throws Exception { testDoesNotAddHeaderToRequestIfNotPresent("Content-MD5"); } @Test void testDoesNotAddETagToRequestIfNotPresent() throws Exception { testDoesNotAddHeaderToRequestIfNotPresent("ETag"); } @Test void testDoesNotAddLastModifiedToRequestIfNotPresent() throws Exception { testDoesNotAddHeaderToRequestIfNotPresent("Last-Modified"); } @Test void testDoesNotModifyExpiresHeaderFromOrigin() throws Exception { final Instant tenSecondsAgo = Instant.now().minusSeconds(10); testDoesNotModifyHeaderFromOrigin("Expires", DateUtils.formatStandardDate(tenSecondsAgo)); } @Test void testDoesNotModifyExpiresHeaderFromOriginOnCacheHit() throws Exception { final Instant inTenSeconds = Instant.now().plusSeconds(10); testDoesNotModifyHeaderFromOriginOnCacheHit("Expires", DateUtils.formatStandardDate(inTenSeconds)); } @Test void testExpiresHeaderMatchesDateIfAddedToOriginResponse() throws Exception { originResponse.removeHeaders("Expires"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); final Header expHdr = result.getFirstHeader("Expires"); if (expHdr != null) { Assertions.assertEquals(result.getFirstHeader("Date").getValue(), expHdr.getValue()); } } private void testDoesNotModifyHeaderFromOriginResponseWithNoTransform(final String header, final String value) throws Exception { originResponse.addHeader("Cache-Control","no-transform"); originResponse.setHeader(header, value); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); Assertions.assertEquals(value, result.getFirstHeader(header).getValue()); } @Test void testDoesNotModifyContentEncodingHeaderFromOriginResponseWithNoTransform() throws Exception { testDoesNotModifyHeaderFromOriginResponseWithNoTransform("Content-Encoding","gzip"); } @Test void testDoesNotModifyContentRangeHeaderFromOriginResponseWithNoTransform() throws Exception { request.setHeader("If-Range","\"etag\""); request.setHeader("Range","bytes=0-49"); originResponse = new BasicClassicHttpResponse(206, "Partial Content"); originResponse.setEntity(HttpTestUtils.makeBody(50)); testDoesNotModifyHeaderFromOriginResponseWithNoTransform("Content-Range","bytes 0-49/128"); } @Test void testDoesNotModifyContentTypeHeaderFromOriginResponseWithNoTransform() throws Exception { testDoesNotModifyHeaderFromOriginResponseWithNoTransform("Content-Type","text/html;charset=utf-8"); } private void testDoesNotModifyHeaderOnCachedResponseWithNoTransform(final String header, final String value) throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); originResponse.addHeader("Cache-Control","max-age=3600, no-transform"); originResponse.setHeader(header, value); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(value, result.getFirstHeader(header).getValue()); } @Test void testDoesNotModifyContentEncodingHeaderOnCachedResponseWithNoTransform() throws Exception { testDoesNotModifyHeaderOnCachedResponseWithNoTransform("Content-Encoding","gzip"); } @Test void testDoesNotModifyContentTypeHeaderOnCachedResponseWithNoTransform() throws Exception { testDoesNotModifyHeaderOnCachedResponseWithNoTransform("Content-Type","text/html;charset=utf-8"); } @Test void testDoesNotAddContentEncodingHeaderToOriginResponseWithNoTransformIfNotPresent() throws Exception { originResponse.addHeader("Cache-Control","no-transform"); testDoesNotAddHeaderToOriginResponse("Content-Encoding"); } @Test void testDoesNotAddContentRangeHeaderToOriginResponseWithNoTransformIfNotPresent() throws Exception { originResponse.addHeader("Cache-Control","no-transform"); testDoesNotAddHeaderToOriginResponse("Content-Range"); } @Test void testDoesNotAddContentTypeHeaderToOriginResponseWithNoTransformIfNotPresent() throws Exception { originResponse.addHeader("Cache-Control","no-transform"); testDoesNotAddHeaderToOriginResponse("Content-Type"); } /* no add on cache hit with no-transform */ @Test void testDoesNotAddContentEncodingHeaderToCachedResponseWithNoTransformIfNotPresent() throws Exception { originResponse.addHeader("Cache-Control","no-transform"); testDoesNotAddHeaderOnCacheHit("Content-Encoding"); } @Test void testDoesNotAddContentRangeHeaderToCachedResponseWithNoTransformIfNotPresent() throws Exception { originResponse.addHeader("Cache-Control","no-transform"); testDoesNotAddHeaderOnCacheHit("Content-Range"); } @Test void testDoesNotAddContentTypeHeaderToCachedResponseWithNoTransformIfNotPresent() throws Exception { originResponse.addHeader("Cache-Control","no-transform"); testDoesNotAddHeaderOnCacheHit("Content-Type"); } /* no modify on request */ @Test void testDoesNotAddContentEncodingToRequestIfNotPresent() throws Exception { testDoesNotAddHeaderToRequestIfNotPresent("Content-Encoding"); } @Test void testDoesNotAddContentRangeToRequestIfNotPresent() throws Exception { testDoesNotAddHeaderToRequestIfNotPresent("Content-Range"); } @Test void testDoesNotAddContentTypeToRequestIfNotPresent() throws Exception { testDoesNotAddHeaderToRequestIfNotPresent("Content-Type"); } @Test void testDoesNotAddContentEncodingHeaderToRequestIfNotPresent() throws Exception { testDoesNotAddHeaderToRequestIfNotPresent("Content-Encoding"); } @Test void testDoesNotAddContentRangeHeaderToRequestIfNotPresent() throws Exception { testDoesNotAddHeaderToRequestIfNotPresent("Content-Range"); } @Test void testDoesNotAddContentTypeHeaderToRequestIfNotPresent() throws Exception { testDoesNotAddHeaderToRequestIfNotPresent("Content-Type"); } @Test void testCachedEntityBodyIsUsedForResponseAfter304Validation() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","max-age=3600"); resp1.setHeader("ETag","\"etag\""); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Cache-Control","max-age=0, max-stale=0"); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_NOT_MODIFIED, "Not Modified"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); try (final InputStream i1 = resp1.getEntity().getContent(); final InputStream i2 = result.getEntity().getContent()) { int b1, b2; while ((b1 = i1.read()) != -1) { b2 = i2.read(); Assertions.assertEquals(b1, b2); } b2 = i2.read(); Assertions.assertEquals(-1, b2); } } private void decorateWithEndToEndHeaders(final ClassicHttpResponse r) { r.setHeader("Allow","GET"); r.setHeader("Content-Encoding","gzip"); r.setHeader("Content-Language","en"); r.setHeader("Content-Length", "128"); r.setHeader("Content-Location","http://foo.example.com/other"); r.setHeader("Content-MD5", "Q2hlY2sgSW50ZWdyaXR5IQ=="); r.setHeader("Content-Type", "text/html;charset=utf-8"); r.setHeader("Expires", DateUtils.formatStandardDate(Instant.now().plusSeconds(10))); r.setHeader("Last-Modified", DateUtils.formatStandardDate(Instant.now().minusSeconds(10))); r.setHeader("Location", "http://foo.example.com/other2"); r.setHeader("Retry-After","180"); } @Test void testResponseIncludesCacheEntryEndToEndHeadersForResponseAfter304Validation() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","max-age=3600"); resp1.setHeader("ETag","\"etag\""); decorateWithEndToEndHeaders(resp1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Cache-Control", "max-age=0, max-stale=0"); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_NOT_MODIFIED, "Not Modified"); resp2.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); resp2.setHeader("Server", "MockServer/1.0"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(RequestEquivalent.eq(req2), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); final String[] endToEndHeaders = { "Cache-Control", "ETag", "Allow", "Content-Encoding", "Content-Language", "Content-Length", "Content-Location", "Content-MD5", "Content-Type", "Expires", "Last-Modified", "Location", "Retry-After" }; for (final String h : endToEndHeaders) { Assertions.assertEquals(HttpTestUtils.getCanonicalHeaderValue(resp1, h), HttpTestUtils.getCanonicalHeaderValue(result, h)); } } @Test void testUpdatedEndToEndHeadersFrom304ArePassedOnResponseAndUpdatedInCacheEntry() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","max-age=3600"); resp1.setHeader("ETag","\"etag\""); decorateWithEndToEndHeaders(resp1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Cache-Control", "max-age=0, max-stale=0"); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_NOT_MODIFIED, "Not Modified"); resp2.setHeader("Cache-Control", "max-age=1800"); resp2.setHeader("Date", DateUtils.formatStandardDate(Instant.now())); resp2.setHeader("Server", "MockServer/1.0"); resp2.setHeader("Allow", "GET,HEAD"); resp2.setHeader("Content-Language", "en,en-us"); resp2.setHeader("Content-Location", "http://foo.example.com/new"); resp2.setHeader("Content-Type","text/html"); resp2.setHeader("Expires", DateUtils.formatStandardDate(Instant.now().plusSeconds(5))); resp2.setHeader("Location", "http://foo.example.com/new2"); resp2.setHeader("Retry-After","120"); final ClassicHttpRequest req3 = new BasicClassicHttpRequest("GET", "/"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result1 = execute(req2); final ClassicHttpResponse result2 = execute(req3); final String[] endToEndHeaders = { "Date", "Cache-Control", "Allow", "Content-Language", "Content-Location", "Content-Type", "Expires", "Location", "Retry-After" }; for (final String h : endToEndHeaders) { Assertions.assertEquals(HttpTestUtils.getCanonicalHeaderValue(resp2, h), HttpTestUtils.getCanonicalHeaderValue(result1, h)); Assertions.assertEquals(HttpTestUtils.getCanonicalHeaderValue(resp2, h), HttpTestUtils.getCanonicalHeaderValue(result2, h)); } } @Test void testMultiHeadersAreSuccessfullyReplacedOn304Validation() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.addHeader("Cache-Control","max-age=3600"); resp1.addHeader("Cache-Control","public"); resp1.setHeader("ETag","\"etag\""); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Cache-Control", "max-age=0, max-stale=0"); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_NOT_MODIFIED, "Not Modified"); resp2.setHeader("Cache-Control", "max-age=1800"); final ClassicHttpRequest req3 = new BasicClassicHttpRequest("GET", "/"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result1 = execute(req2); final ClassicHttpResponse result2 = execute(req3); final String h = "Cache-Control"; Assertions.assertEquals(HttpTestUtils.getCanonicalHeaderValue(resp2, h), HttpTestUtils.getCanonicalHeaderValue(result1, h)); Assertions.assertEquals(HttpTestUtils.getCanonicalHeaderValue(resp2, h), HttpTestUtils.getCanonicalHeaderValue(result2, h)); } @Test void testCannotUseVariantCacheEntryIfNotAllSelectingRequestHeadersMatch() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); req1.setHeader("Accept-Encoding","gzip"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("ETag","\"etag1\""); resp1.setHeader("Cache-Control","max-age=3600"); resp1.setHeader("Vary","Accept-Encoding"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.removeHeaders("Accept-Encoding"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("ETag","\"etag1\""); resp2.setHeader("Cache-Control","max-age=3600"); // not allowed to have a cache hit; must forward request Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); } @Test void testCannotServeFromCacheForVaryStar() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("ETag","\"etag1\""); resp1.setHeader("Cache-Control","max-age=3600"); resp1.setHeader("Vary","*"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("ETag","\"etag1\""); resp2.setHeader("Cache-Control","max-age=3600"); // not allowed to have a cache hit; must forward request Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); } @Test void testNonMatchingVariantCannotBeServedFromCacheUnlessConditionallyValidated() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); req1.setHeader("User-Agent","MyBrowser/1.0"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("ETag","\"etag1\""); resp1.setHeader("Cache-Control","max-age=3600"); resp1.setHeader("Vary","User-Agent"); resp1.setHeader("Content-Type","application/octet-stream"); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("User-Agent","MyBrowser/1.5"); final ClassicHttpResponse resp200 = HttpTestUtils.make200Response(); resp200.setHeader("ETag","\"etag1\""); resp200.setHeader("Vary","User-Agent"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); Mockito.when(mockExecChain.proceed(RequestEquivalent.eq(req2), Mockito.any())).thenReturn(resp200); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_OK, result.getCode()); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); Assertions.assertTrue(HttpTestUtils.semanticallyTransparent(resp200, result)); } protected void testUnsafeOperationInvalidatesCacheForThatUri( final ClassicHttpRequest unsafeReq) throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","public, max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_NO_CONTENT, "No Content"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(unsafeReq); final ClassicHttpRequest req3 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp3 = HttpTestUtils.make200Response(); resp3.setHeader("Cache-Control","public, max-age=3600"); // this origin request MUST happen due to invalidation Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp3); execute(req3); } protected ClassicHttpRequest makeRequestWithBody(final String method, final String requestUri) { final ClassicHttpRequest req = new BasicClassicHttpRequest(method, requestUri); final int nbytes = 128; req.setEntity(HttpTestUtils.makeBody(nbytes)); req.setHeader("Content-Length", Long.toString(nbytes)); return req; } @Test void testPutToUriInvalidatesCacheForThatUri() throws Exception { final ClassicHttpRequest req = makeRequestWithBody("PUT","/"); testUnsafeOperationInvalidatesCacheForThatUri(req); } @Test void testDeleteToUriInvalidatesCacheForThatUri() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("DELETE","/"); testUnsafeOperationInvalidatesCacheForThatUri(req); } @Test void testPostToUriInvalidatesCacheForThatUri() throws Exception { final ClassicHttpRequest req = makeRequestWithBody("POST","/"); testUnsafeOperationInvalidatesCacheForThatUri(req); } protected void testUnsafeMethodInvalidatesCacheForHeaderUri( final ClassicHttpRequest unsafeReq) throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/content"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","public, max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse resp2 = new BasicClassicHttpResponse(HttpStatus.SC_NO_CONTENT, "No Content"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(unsafeReq); final ClassicHttpRequest req3 = new BasicClassicHttpRequest("GET", "/content"); final ClassicHttpResponse resp3 = HttpTestUtils.make200Response(); resp3.setHeader("Cache-Control","public, max-age=3600"); // this origin request MUST happen due to invalidation Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp3); execute(req3); } protected void testUnsafeMethodInvalidatesCacheForUriInContentLocationHeader( final ClassicHttpRequest unsafeReq) throws Exception { unsafeReq.setHeader("Content-Location","http://foo.example.com/content"); testUnsafeMethodInvalidatesCacheForHeaderUri(unsafeReq); } protected void testUnsafeMethodInvalidatesCacheForRelativeUriInContentLocationHeader( final ClassicHttpRequest unsafeReq) throws Exception { unsafeReq.setHeader("Content-Location","/content"); testUnsafeMethodInvalidatesCacheForHeaderUri(unsafeReq); } protected void testUnsafeMethodInvalidatesCacheForUriInLocationHeader( final ClassicHttpRequest unsafeReq) throws Exception { unsafeReq.setHeader("Location","http://foo.example.com/content"); testUnsafeMethodInvalidatesCacheForHeaderUri(unsafeReq); } @Test void testPutInvalidatesCacheForThatUriInContentLocationHeader() throws Exception { final ClassicHttpRequest req2 = makeRequestWithBody("PUT","/"); testUnsafeMethodInvalidatesCacheForUriInContentLocationHeader(req2); } @Test void testPutInvalidatesCacheForThatUriInLocationHeader() throws Exception { final ClassicHttpRequest req = makeRequestWithBody("PUT","/"); testUnsafeMethodInvalidatesCacheForUriInLocationHeader(req); } @Test void testPutInvalidatesCacheForThatUriInRelativeContentLocationHeader() throws Exception { final ClassicHttpRequest req = makeRequestWithBody("PUT","/"); testUnsafeMethodInvalidatesCacheForRelativeUriInContentLocationHeader(req); } @Test void testDeleteInvalidatesCacheForThatUriInContentLocationHeader() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("DELETE", "/"); testUnsafeMethodInvalidatesCacheForUriInContentLocationHeader(req); } @Test void testDeleteInvalidatesCacheForThatUriInRelativeContentLocationHeader() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("DELETE", "/"); testUnsafeMethodInvalidatesCacheForRelativeUriInContentLocationHeader(req); } @Test void testDeleteInvalidatesCacheForThatUriInLocationHeader() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("DELETE", "/"); testUnsafeMethodInvalidatesCacheForUriInLocationHeader(req); } @Test void testPostInvalidatesCacheForThatUriInContentLocationHeader() throws Exception { final ClassicHttpRequest req = makeRequestWithBody("POST","/"); testUnsafeMethodInvalidatesCacheForUriInContentLocationHeader(req); } @Test void testPostInvalidatesCacheForThatUriInLocationHeader() throws Exception { final ClassicHttpRequest req = makeRequestWithBody("POST","/"); testUnsafeMethodInvalidatesCacheForUriInLocationHeader(req); } @Test void testPostInvalidatesCacheForRelativeUriInContentLocationHeader() throws Exception { final ClassicHttpRequest req = makeRequestWithBody("POST","/"); testUnsafeMethodInvalidatesCacheForRelativeUriInContentLocationHeader(req); } private void testRequestIsWrittenThroughToOrigin(final ClassicHttpRequest req) throws Exception { final ClassicHttpResponse resp = new BasicClassicHttpResponse(HttpStatus.SC_NO_CONTENT, "No Content"); final ClassicHttpRequest wrapper = req; Mockito.when(mockExecChain.proceed(RequestEquivalent.eq(wrapper), Mockito.any())).thenReturn(resp); execute(wrapper); } @Test void testOPTIONSRequestsAreWrittenThroughToOrigin() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("OPTIONS","*"); testRequestIsWrittenThroughToOrigin(req); } @Test void testPOSTRequestsAreWrittenThroughToOrigin() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("POST","/"); req.setEntity(HttpTestUtils.makeBody(128)); req.setHeader("Content-Length","128"); testRequestIsWrittenThroughToOrigin(req); } @Test void testPUTRequestsAreWrittenThroughToOrigin() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("PUT","/"); req.setEntity(HttpTestUtils.makeBody(128)); req.setHeader("Content-Length","128"); testRequestIsWrittenThroughToOrigin(req); } @Test void testDELETERequestsAreWrittenThroughToOrigin() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("DELETE", "/"); testRequestIsWrittenThroughToOrigin(req); } @Test void testTRACERequestsAreWrittenThroughToOrigin() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("TRACE","/"); testRequestIsWrittenThroughToOrigin(req); } @Test void testCONNECTRequestsAreWrittenThroughToOrigin() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("CONNECT","/"); testRequestIsWrittenThroughToOrigin(req); } @Test void testUnknownMethodRequestsAreWrittenThroughToOrigin() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("UNKNOWN","/"); testRequestIsWrittenThroughToOrigin(req); } @Test void testTransmitsAgeHeaderIfIncomingAgeHeaderTooBig() throws Exception { final String reallyOldAge = "1" + Long.MAX_VALUE; originResponse.setHeader("Age",reallyOldAge); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); Assertions.assertEquals(reallyOldAge, result.getFirstHeader("Age").getValue()); } @Test void testDoesNotModifyAllowHeaderWithUnknownMethods() throws Exception { final String allowHeaderValue = "GET, HEAD, FOOBAR"; originResponse.setHeader("Allow",allowHeaderValue); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); Assertions.assertEquals(HttpTestUtils.getCanonicalHeaderValue(originResponse,"Allow"), HttpTestUtils.getCanonicalHeaderValue(result, "Allow")); } protected void testSharedCacheRevalidatesAuthorizedResponse( final ClassicHttpResponse authorizedResponse, final int minTimes, final int maxTimes) throws Exception { if (config.isSharedCache()) { final String authorization = StandardAuthScheme.BASIC + " dXNlcjpwYXNzd2Q="; final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); req1.setHeader("Authorization",authorization); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("Cache-Control","max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(authorizedResponse); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); Mockito.verify(mockExecChain, Mockito.atLeast(1 + minTimes)).proceed(Mockito.any(), Mockito.any()); Mockito.verify(mockExecChain, Mockito.atMost(1 + maxTimes)).proceed(Mockito.any(), Mockito.any()); } } @Test void testSharedCacheMustNotNormallyCacheAuthorizedResponses() throws Exception { final ClassicHttpResponse resp = HttpTestUtils.make200Response(); resp.setHeader("Cache-Control","max-age=3600"); resp.setHeader("ETag","\"etag\""); testSharedCacheRevalidatesAuthorizedResponse(resp, 1, 1); } @Test void testSharedCacheMayCacheAuthorizedResponsesWithSMaxAgeHeader() throws Exception { final ClassicHttpResponse resp = HttpTestUtils.make200Response(); resp.setHeader("Cache-Control","s-maxage=3600"); resp.setHeader("ETag","\"etag\""); testSharedCacheRevalidatesAuthorizedResponse(resp, 0, 1); } @Test void testSharedCacheMustRevalidateAuthorizedResponsesWhenSMaxAgeIsZero() throws Exception { final ClassicHttpResponse resp = HttpTestUtils.make200Response(); resp.setHeader("Cache-Control","s-maxage=0"); resp.setHeader("ETag","\"etag\""); testSharedCacheRevalidatesAuthorizedResponse(resp, 1, 1); } @Test void testSharedCacheMayCacheAuthorizedResponsesWithMustRevalidate() throws Exception { final ClassicHttpResponse resp = HttpTestUtils.make200Response(); resp.setHeader("Cache-Control","must-revalidate"); resp.setHeader("ETag","\"etag\""); testSharedCacheRevalidatesAuthorizedResponse(resp, 0, 1); } @Test void testSharedCacheMayCacheAuthorizedResponsesWithCacheControlPublic() throws Exception { final ClassicHttpResponse resp = HttpTestUtils.make200Response(); resp.setHeader("Cache-Control","public"); testSharedCacheRevalidatesAuthorizedResponse(resp, 0, 1); } protected void testSharedCacheMustUseNewRequestHeadersWhenRevalidatingAuthorizedResponse( final ClassicHttpResponse authorizedResponse) throws Exception { if (config.isSharedCache()) { final String authorization1 = StandardAuthScheme.BASIC + " dXNlcjpwYXNzd2Q="; final String authorization2 = StandardAuthScheme.BASIC + " dXNlcjpwYXNzd2Qy"; final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); req1.setHeader("Authorization",authorization1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Authorization",authorization2); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(authorizedResponse); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(reqCapture.capture(), Mockito.any()); final List allRequests = reqCapture.getAllValues(); Assertions.assertEquals(2, allRequests.size()); final ClassicHttpRequest captured = allRequests.get(1); Assertions.assertEquals(HttpTestUtils.getCanonicalHeaderValue(req2, "Authorization"), HttpTestUtils.getCanonicalHeaderValue(captured, "Authorization")); } } @Test void testSharedCacheMustUseNewRequestHeadersWhenRevalidatingAuthorizedResponsesWithSMaxAge() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date",DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("ETag","\"etag\""); resp1.setHeader("Cache-Control","s-maxage=5"); testSharedCacheMustUseNewRequestHeadersWhenRevalidatingAuthorizedResponse(resp1); } @Test void testSharedCacheMustUseNewRequestHeadersWhenRevalidatingAuthorizedResponsesWithMustRevalidate() throws Exception { final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Date",DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("ETag","\"etag\""); resp1.setHeader("Cache-Control","maxage=5, must-revalidate"); testSharedCacheMustUseNewRequestHeadersWhenRevalidatingAuthorizedResponse(resp1); } protected void testCacheIsNotUsedWhenRespondingToRequest(final ClassicHttpRequest req) throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Etag","\"etag\""); resp1.setHeader("Cache-Control","max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("Etag","\"etag2\""); resp2.setHeader("Cache-Control","max-age=1200"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req); Assertions.assertTrue(HttpTestUtils.semanticallyTransparent(resp2, result)); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(reqCapture.capture(), Mockito.any()); final ClassicHttpRequest captured = reqCapture.getValue(); Assertions.assertTrue(HttpTestUtils.equivalent(req, captured)); } @Test void testCacheIsNotUsedWhenRespondingToRequestWithCacheControlNoCache() throws Exception { final ClassicHttpRequest req = new BasicClassicHttpRequest("GET", "/"); req.setHeader("Cache-Control","no-cache"); testCacheIsNotUsedWhenRespondingToRequest(req); } protected void testStaleCacheResponseMustBeRevalidatedWithOrigin( final ClassicHttpResponse staleResponse) throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Cache-Control","max-stale=3600"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("ETag","\"etag2\""); resp2.setHeader("Cache-Control","max-age=5, must-revalidate"); // this request MUST happen Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(staleResponse); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(reqCapture.capture(), Mockito.any()); final ClassicHttpRequest reval = reqCapture.getValue(); boolean foundMaxAge0 = false; final Iterator it = MessageSupport.iterate(reval, HttpHeaders.CACHE_CONTROL); while (it.hasNext()) { final HeaderElement elt = it.next(); if ("max-age".equalsIgnoreCase(elt.getName()) && "0".equals(elt.getValue())) { foundMaxAge0 = true; } } Assertions.assertTrue(foundMaxAge0); } @Test void testStaleEntryWithMustRevalidateIsNotUsedWithoutRevalidatingWithOrigin() throws Exception { final ClassicHttpResponse response = HttpTestUtils.make200Response(); final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); response.setHeader("Date",DateUtils.formatStandardDate(tenSecondsAgo)); response.setHeader("ETag","\"etag1\""); response.setHeader("Cache-Control","max-age=5, must-revalidate"); testStaleCacheResponseMustBeRevalidatedWithOrigin(response); } protected void testGenerates504IfCannotRevalidateStaleResponse( final ClassicHttpResponse staleResponse) throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(staleResponse); execute(req1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenThrow(new SocketTimeoutException()); final ClassicHttpResponse result = execute(req2); Assertions.assertEquals(HttpStatus.SC_GATEWAY_TIMEOUT, result.getCode()); } @Test void testGenerates504IfCannotRevalidateAMustRevalidateEntry() throws Exception { final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); resp1.setHeader("ETag","\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control","max-age=5,must-revalidate"); testGenerates504IfCannotRevalidateStaleResponse(resp1); } @Test void testStaleEntryWithProxyRevalidateOnSharedCacheIsNotUsedWithoutRevalidatingWithOrigin() throws Exception { if (config.isSharedCache()) { final ClassicHttpResponse response = HttpTestUtils.make200Response(); final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); response.setHeader("Date",DateUtils.formatStandardDate(tenSecondsAgo)); response.setHeader("ETag","\"etag1\""); response.setHeader("Cache-Control","max-age=5, proxy-revalidate"); testStaleCacheResponseMustBeRevalidatedWithOrigin(response); } } @Test void testGenerates504IfSharedCacheCannotRevalidateAProxyRevalidateEntry() throws Exception { if (config.isSharedCache()) { final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); final Instant now = Instant.now(); final Instant tenSecondsAgo = now.minusSeconds(10); resp1.setHeader("ETag","\"etag\""); resp1.setHeader("Date", DateUtils.formatStandardDate(tenSecondsAgo)); resp1.setHeader("Cache-Control","max-age=5,proxy-revalidate"); testGenerates504IfCannotRevalidateStaleResponse(resp1); } } @Test void testCacheControlPrivateIsNotCacheableBySharedCache() throws Exception { if (config.isSharedCache()) { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control", "private,max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); // this backend request MUST happen Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req1); execute(req2); } } @Test void testCacheControlPrivateOnFieldIsNotReturnedBySharedCache() throws Exception { if (config.isSharedCache()) { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("X-Personal", "stuff"); resp1.setHeader("Cache-Control", "private=\"X-Personal\",s-maxage=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); // this backend request MAY happen Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req1); final ClassicHttpResponse result = execute(req2); Assertions.assertNull(result.getFirstHeader("X-Personal")); Mockito.verify(mockExecChain, Mockito.atLeastOnce()).proceed(Mockito.any(), Mockito.any()); Mockito.verify(mockExecChain, Mockito.atMost(2)).proceed(Mockito.any(), Mockito.any()); } } @Test void testNoCacheCannotSatisfyASubsequentRequestWithoutRevalidation() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("ETag","\"etag\""); resp1.setHeader("Cache-Control","no-cache"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); // this MUST happen Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); Mockito.verify(mockExecChain, Mockito.times(2)).proceed(Mockito.any(), Mockito.any()); } @Test void testNoCacheCannotSatisfyASubsequentRequestWithoutRevalidationEvenWithContraryIndications() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("ETag","\"etag\""); resp1.setHeader("Cache-Control","no-cache,s-maxage=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); req2.setHeader("Cache-Control","max-stale=7200"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); // this MUST happen Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); } @Test void testNoCacheOnFieldIsNotReturnedWithoutRevalidation() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("ETag","\"etag\""); resp1.setHeader("X-Stuff","things"); resp1.setHeader("Cache-Control","no-cache=\"X-Stuff\", max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); execute(req1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("ETag","\"etag\""); resp2.setHeader("X-Stuff","things"); resp2.setHeader("Cache-Control","no-cache=\"X-Stuff\",max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); final ClassicHttpResponse result = execute(req2); final ArgumentCaptor reqCapture = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(mockExecChain, Mockito.atMost(2)).proceed(reqCapture.capture(), Mockito.any()); final List allRequests = reqCapture.getAllValues(); if (allRequests.isEmpty()) { Assertions.assertNull(result.getFirstHeader("X-Stuff")); } } @Test void testNoStoreOnRequestIsNotStoredInCache() throws Exception { request.setHeader("Cache-Control","no-store"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(request); Mockito.verifyNoInteractions(mockCache); } @Test void testNoStoreOnRequestIsNotStoredInCacheEvenIfResponseMarkedCacheable() throws Exception { request.setHeader("Cache-Control","no-store"); originResponse.setHeader("Cache-Control","max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(request); Mockito.verifyNoInteractions(mockCache); } @Test void testNoStoreOnResponseIsNotStoredInCache() throws Exception { originResponse.setHeader("Cache-Control","no-store"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(request); Mockito.verifyNoInteractions(mockCache); } @Test void testNoStoreOnResponseIsNotStoredInCacheEvenWithContraryIndicators() throws Exception { originResponse.setHeader("Cache-Control","no-store,max-age=3600"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); execute(request); Mockito.verifyNoInteractions(mockCache); } @Test void testOrderOfMultipleContentEncodingHeaderValuesIsPreserved() throws Exception { originResponse.addHeader("Content-Encoding","gzip"); originResponse.addHeader("Content-Encoding","deflate"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); int total_encodings = 0; final Iterator it = MessageSupport.iterate(result, HttpHeaders.CONTENT_ENCODING); while (it.hasNext()) { final HeaderElement elt = it.next(); switch (total_encodings) { case 0: Assertions.assertEquals("gzip", elt.getName()); break; case 1: Assertions.assertEquals("deflate", elt.getName()); break; default: Assertions.fail("too many encodings"); } total_encodings++; } Assertions.assertEquals(2, total_encodings); } @Test void testOrderOfMultipleParametersInContentEncodingHeaderIsPreserved() throws Exception { originResponse.addHeader("Content-Encoding","gzip,deflate"); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); int total_encodings = 0; final Iterator it = MessageSupport.iterate(result, HttpHeaders.CONTENT_ENCODING); while (it.hasNext()) { final HeaderElement elt = it.next(); switch (total_encodings) { case 0: Assertions.assertEquals("gzip", elt.getName()); break; case 1: Assertions.assertEquals("deflate", elt.getName()); break; default: Assertions.fail("too many encodings"); } total_encodings++; } Assertions.assertEquals(2, total_encodings); } @Test void testCacheDoesNotAssumeContentLocationHeaderIndicatesAnotherCacheableResource() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/foo"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","public,max-age=3600"); resp1.setHeader("Etag","\"etag\""); resp1.setHeader("Content-Location","http://foo.example.com/bar"); execute(req1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/bar"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); resp2.setHeader("Cache-Control","public,max-age=3600"); resp2.setHeader("Etag","\"etag\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); } @Test void testCachedResponsesWithMissingDateHeadersShouldBeAssignedOne() throws Exception { originResponse.removeHeaders("Date"); originResponse.setHeader("Cache-Control","public"); originResponse.setHeader("ETag","\"etag\""); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); Assertions.assertNotNull(result.getFirstHeader("Date")); } private void testInvalidExpiresHeaderIsTreatedAsStale( final String expiresHeader) throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","public"); resp1.setHeader("ETag","\"etag\""); resp1.setHeader("Expires", expiresHeader); execute(req1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); // second request to origin MUST happen Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); } @Test void testMalformedExpiresHeaderIsTreatedAsStale() throws Exception { testInvalidExpiresHeaderIsTreatedAsStale("garbage"); } @Test void testExpiresZeroHeaderIsTreatedAsStale() throws Exception { testInvalidExpiresHeaderIsTreatedAsStale("0"); } @Test void testExpiresHeaderEqualToDateHeaderIsTreatedAsStale() throws Exception { final ClassicHttpRequest req1 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp1 = HttpTestUtils.make200Response(); resp1.setHeader("Cache-Control","public"); resp1.setHeader("ETag","\"etag\""); resp1.setHeader("Expires", resp1.getFirstHeader("Date").getValue()); execute(req1); final ClassicHttpRequest req2 = new BasicClassicHttpRequest("GET", "/"); final ClassicHttpResponse resp2 = HttpTestUtils.make200Response(); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp1); // second request to origin MUST happen Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(resp2); execute(req2); } @Test void testDoesNotModifyServerResponseHeader() throws Exception { final String server = "MockServer/1.0"; originResponse.setHeader("Server", server); Mockito.when(mockExecChain.proceed(Mockito.any(), Mockito.any())).thenReturn(originResponse); final ClassicHttpResponse result = execute(request); Assertions.assertEquals(server, result.getFirstHeader("Server").getValue()); } } ././@LongLink0100644 0000000 0000000 00000000145 14704162040 011631 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/CacheControlGeneratorTest.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/CacheControlGeneratorTest.java0100664 0000000 0000000 00000007346 14704162040 032460 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.hamcrest.MatcherAssert.assertThat; import org.apache.hc.client5.http.HeaderMatcher; import org.apache.hc.client5.http.cache.RequestCacheControl; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class CacheControlGeneratorTest { private final CacheControlHeaderGenerator generator = CacheControlHeaderGenerator.INSTANCE; @Test void testGenerateRequestCacheControlHeader() { assertThat(generator.generate( RequestCacheControl.builder() .setMaxAge(12) .setMaxStale(23) .setMinFresh(34) .setNoCache(true) .setNoStore(true) .setOnlyIfCached(true) .setStaleIfError(56) .build()), HeaderMatcher.same("Cache-Control", "max-age=12, max-stale=23, " + "min-fresh=34, no-cache, no-store, only-if-cached, stale-if-error=56")); assertThat(generator.generate( RequestCacheControl.builder() .setMaxAge(12) .setNoCache(true) .setMinFresh(34) .setMaxStale(23) .setNoStore(true) .setStaleIfError(56) .setOnlyIfCached(true) .build()), HeaderMatcher.same("Cache-Control", "max-age=12, max-stale=23, " + "min-fresh=34, no-cache, no-store, only-if-cached, stale-if-error=56")); assertThat(generator.generate( RequestCacheControl.builder() .setMaxAge(0) .build()), HeaderMatcher.same("Cache-Control", "max-age=0")); assertThat(generator.generate( RequestCacheControl.builder() .setMaxAge(-1) .setMinFresh(10) .build()), HeaderMatcher.same("Cache-Control", "min-fresh=10")); } @Test void testGenerateRequestCacheControlHeaderNoDirectives() { final RequestCacheControl cacheControl = RequestCacheControl.builder() .build(); Assertions.assertNull(generator.generate(cacheControl)); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCombinedEntity.java0100664 0000000 0000000 00000004750 14704162040 031156 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import java.io.ByteArrayInputStream; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.util.ByteArrayBuffer; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestCombinedEntity { @Test void testCombinedEntityBasics() throws Exception { final HttpEntity httpEntity = mock(HttpEntity.class); when(httpEntity.getContent()).thenReturn( new ByteArrayInputStream(new byte[] { 6, 7, 8, 9, 10 })); final ByteArrayBuffer buf = new ByteArrayBuffer(1024); final byte[] tmp = new byte[] { 1, 2, 3, 4, 5 }; buf.append(tmp, 0, tmp.length); final CombinedEntity entity = new CombinedEntity(httpEntity, buf); Assertions.assertEquals(-1, entity.getContentLength()); Assertions.assertFalse(entity.isRepeatable()); Assertions.assertTrue(entity.isStreaming()); Assertions.assertArrayEquals(new byte[] { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }, EntityUtils.toByteArray(entity)); verify(httpEntity).getContent(); entity.close(); verify(httpEntity).close(); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/memcached/0040775 0000000 0000000 00000000000 14704162040 026441 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000155 14704162040 011632 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/memcached/TestSHA256HashingScheme.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/memcached/TestSHA256HashingSch0100664 0000000 0000000 00000003111 14704162040 032025 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache.memcached; import static org.junit.jupiter.api.Assertions.assertTrue; import org.junit.jupiter.api.Test; class TestSHA256HashingScheme { @Test void canHash() { final SHA256KeyHashingScheme impl = new SHA256KeyHashingScheme(); final String result = impl.hash("hello, hashing world"); assertTrue(result != null && !result.isEmpty()); } } ././@LongLink0100644 0000000 0000000 00000000160 14704162040 011626 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/memcached/TestPrefixKeyHashingScheme.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/memcached/TestPrefixKeyHashing0100664 0000000 0000000 00000003576 14704162040 032444 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache.memcached; import static org.junit.jupiter.api.Assertions.assertEquals; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestPrefixKeyHashingScheme { private static final String KEY = "key"; private static final String PREFIX = "prefix"; private PrefixKeyHashingScheme impl; private KeyHashingScheme scheme; @BeforeEach void setUp() { scheme = storageKey -> { assertEquals(KEY, storageKey); return "hash"; }; impl = new PrefixKeyHashingScheme(PREFIX, scheme); } @Test void addsPrefixToBackingScheme() { assertEquals("prefixhash", impl.hash(KEY)); } } ././@LongLink0100644 0000000 0000000 00000000155 14704162040 011632 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestByteArrayCacheEntrySerializer.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestByteArrayCacheEntrySeriali0100664 0000000 0000000 00000022413 14704162040 032476 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import static org.hamcrest.MatcherAssert.assertThat; 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 java.time.Instant; import java.util.Date; import java.util.HashSet; import java.util.Set; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.cache.HttpCacheStorageEntry; import org.apache.hc.client5.http.cache.Resource; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.StatusLine; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @SuppressWarnings("deprecation") class TestByteArrayCacheEntrySerializer { private ByteArrayCacheEntrySerializer impl; @BeforeEach void setUp() { impl = new ByteArrayCacheEntrySerializer(); } @Test void canSerializeEntriesWithVariantMapsDeprecatedConstructor() throws Exception { readWriteVerify(makeCacheEntryDeprecatedConstructorWithVariantMap("somekey")); } @Test void canSerializeEntriesWithVariantMapsAndInstant() throws Exception { readWriteVerify(makeCacheEntryWithVariantMap("somekey")); } @Test void isAllowedClassNameStringTrue() { assertIsAllowedClassNameTrue(String.class.getName()); } @Test void isAllowedClassNameStringArrayTrue() { assertIsAllowedClassNameTrue("[L" + String.class.getName()); } @Test void isAllowedClassNameStringArrayArrayTrue() { assertIsAllowedClassNameTrue("[[L" + String.class.getName()); } @Test void isAllowedClassNameDataTrue() { assertIsAllowedClassNameTrue(Date.class.getName()); } @Test void isAllowedClassNameInstantTrue() { assertIsAllowedClassNameTrue(Instant.class.getName()); } @Test void isAllowedClassNameStatusLineTrue() { assertIsAllowedClassNameTrue(StatusLine.class.getName()); } @Test void isAllowedClassNameResourceTrue() { assertIsAllowedClassNameTrue(Resource.class.getName()); } @Test void isAllowedClassNameByteArrayTrue() { assertIsAllowedClassNameTrue("[B"); } @Test void isAllowedClassNameByteArrayArrayTrue() { assertIsAllowedClassNameTrue("[[B"); } @Test void isAllowedClassNameCharArrayTrue() { assertIsAllowedClassNameTrue("[C"); } @Test void isAllowedClassNameCharArrayArrayTrue() { assertIsAllowedClassNameTrue("[[C"); } @Test void isAllowedClassNameDoubleArrayTrue() { assertIsAllowedClassNameTrue("[D"); } @Test void isAllowedClassNameDoubleArrayArrayTrue() { assertIsAllowedClassNameTrue("[[D"); } @Test void isAllowedClassNameFloatArrayTrue() { assertIsAllowedClassNameTrue("[F"); } @Test void isAllowedClassNameFloatArrayArrayTrue() { assertIsAllowedClassNameTrue("[[F"); } @Test void isAllowedClassNameIntArrayTrue() { assertIsAllowedClassNameTrue("[I"); } @Test void isAllowedClassNameIntArrayArrayTrue() { assertIsAllowedClassNameTrue("[[I"); } @Test void isAllowedClassNameLongArrayTrue() { assertIsAllowedClassNameTrue("[J"); } @Test void isAllowedClassNameLongArrayArrayTrue() { assertIsAllowedClassNameTrue("[[J"); } @Test void isAllowedClassNameShortArrayTrue() { assertIsAllowedClassNameTrue("[S"); } @Test void isAllowedClassNameShortArrayArrayTrue() { assertIsAllowedClassNameTrue("[[S"); } @Test void isAllowedClassNameCollectionsInvokerTransformerFalse() { assertIsAllowedClassNameFalse("org.apache.commons.collections.functors.InvokerTransformer"); } @Test void isAllowedClassNameCollections4InvokerTransformerFalse() { assertIsAllowedClassNameFalse("org.apache.commons.collections4.functors.InvokerTransformer"); } @Test void isAllowedClassNameCollectionsInstantiateTransformerFalse() { assertIsAllowedClassNameFalse("org.apache.commons.collections.functors.InstantiateTransformer"); } @Test void isAllowedClassNameCollections4InstantiateTransformerFalse() { assertIsAllowedClassNameFalse("org.apache.commons.collections4.functors.InstantiateTransformer"); } @Test void isAllowedClassNameGroovyConvertedClosureFalse() { assertIsAllowedClassNameFalse("org.codehaus.groovy.runtime.ConvertedClosure"); } @Test void isAllowedClassNameGroovyMethodClosureFalse() { assertIsAllowedClassNameFalse("org.codehaus.groovy.runtime.MethodClosure"); } @Test void isAllowedClassNameSpringObjectFactoryFalse() { assertIsAllowedClassNameFalse("org.springframework.beans.factory.ObjectFactory"); } @Test void isAllowedClassNameCalanTemplatesImplFalse() { assertIsAllowedClassNameFalse("com.sun.org.apache.xalan.internal.xsltc.trax.TemplatesImpl"); } @Test void isAllowedClassNameCalanTemplatesImplArrayFalse() { assertIsAllowedClassNameFalse("[Lcom.sun.org.apache.xalan.internal.xsltc.trax.TemplatesImpl"); } @Test void isAllowedClassNameJavaRmiRegistryFalse() { assertIsAllowedClassNameFalse("java.rmi.registry.Registry"); } @Test void isAllowedClassNameJavaRmiServerRemoteObjectInvocationHandlerFalse() { assertIsAllowedClassNameFalse("java.rmi.server.RemoteObjectInvocationHandler"); } @Test void isAllowedClassNameJavaxXmlTransformTemplatesFalse() { assertIsAllowedClassNameFalse("javax.xml.transform.Templates"); } @Test void isAllowedClassNameJavaxManagementMBeanServerInvocationHandlerFalse() { assertIsAllowedClassNameFalse("javax.management.MBeanServerInvocationHandler"); } private static void assertIsAllowedClassNameTrue(final String className) { assertTrue(ByteArrayCacheEntrySerializer.RestrictedObjectInputStream.isAllowedClassName(className)); } private static void assertIsAllowedClassNameFalse(final String className) { assertFalse(ByteArrayCacheEntrySerializer.RestrictedObjectInputStream.isAllowedClassName(className)); } public void readWriteVerify(final HttpCacheStorageEntry writeEntry) throws Exception { // write the entry final byte[] bytes = impl.serialize(writeEntry); // read the entry final HttpCacheStorageEntry readEntry = impl.deserialize(bytes); // compare assertEquals(readEntry.getKey(), writeEntry.getKey()); assertThat(readEntry.getContent(), HttpCacheEntryMatcher.equivalent(writeEntry.getContent())); } private HttpCacheStorageEntry makeCacheEntryDeprecatedConstructorWithVariantMap(final String key) { final Header[] headers = new Header[5]; for (int i = 0; i < headers.length; i++) { headers[i] = new BasicHeader("header" + i, "value" + i); } final Set variants = new HashSet<>(); variants.add("test variant 1"); variants.add("test variant 2"); final HttpCacheEntry cacheEntry = HttpTestUtils.makeCacheEntry( Instant.now(), Instant.now(), HttpStatus.SC_OK, headers, variants); return new HttpCacheStorageEntry(key, cacheEntry); } private HttpCacheStorageEntry makeCacheEntryWithVariantMap(final String key) { final Header[] headers = new Header[5]; for (int i = 0; i < headers.length; i++) { headers[i] = new BasicHeader("header" + i, "value" + i); } final Set variants = new HashSet<>(); variants.add("test variant 1"); variants.add("test variant 2"); final HttpCacheEntry cacheEntry = HttpTestUtils.makeCacheEntry( Instant.now(), Instant.now(), HttpStatus.SC_OK, headers, variants); return new HttpCacheStorageEntry(key, cacheEntry); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCacheKeyGenerator.java0100664 0000000 0000000 00000045154 14704162040 031567 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cache; import java.net.URI; import java.net.URISyntaxException; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.Iterator; import java.util.List; import org.apache.hc.client5.http.cache.HttpCacheEntry; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHeaderIterator; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @SuppressWarnings({"boxing","static-access"}) // this is test code class TestCacheKeyGenerator { private CacheKeyGenerator extractor; @BeforeEach void setUp() { extractor = CacheKeyGenerator.INSTANCE; } @Test void testGetRequestUri() { Assertions.assertEquals("http://foo.example.com/stuff?huh", CacheKeyGenerator.getRequestUri( new HttpHost("bar.example.com"), new HttpGet("http://foo.example.com/stuff?huh"))); Assertions.assertEquals("http://bar.example.com/stuff?huh", CacheKeyGenerator.getRequestUri( new HttpHost("bar.example.com"), new HttpGet("/stuff?huh"))); Assertions.assertEquals("http://foo.example.com:8888/stuff?huh", CacheKeyGenerator.getRequestUri( new HttpHost("bar.example.com", 8080), new HttpGet("http://foo.example.com:8888/stuff?huh"))); Assertions.assertEquals("https://bar.example.com:8443/stuff?huh", CacheKeyGenerator.getRequestUri( new HttpHost("https", "bar.example.com", 8443), new HttpGet("/stuff?huh"))); Assertions.assertEquals("http://foo.example.com/", CacheKeyGenerator.getRequestUri( new HttpHost("bar.example.com"), new HttpGet("http://foo.example.com"))); Assertions.assertEquals("http://bar.example.com/stuff?huh", CacheKeyGenerator.getRequestUri( new HttpHost("bar.example.com"), new HttpGet("stuff?huh"))); } @Test void testNormalizeRequestUri() throws URISyntaxException { Assertions.assertEquals(URI.create("http://bar.example.com:80/stuff?huh"), CacheKeyGenerator.normalize(URI.create("//bar.example.com/stuff?huh"))); Assertions.assertEquals(URI.create("http://bar.example.com:80/stuff?huh"), CacheKeyGenerator.normalize(URI.create("http://bar.example.com/stuff?huh"))); Assertions.assertEquals(URI.create("http://bar.example.com:80/stuff?huh"), CacheKeyGenerator.normalize(URI.create("http://bar.example.com/stuff?huh#there"))); Assertions.assertEquals(URI.create("http://bar.example.com:80/stuff?huh"), CacheKeyGenerator.normalize(URI.create("HTTP://BAR.example.com/p1/p2/../../stuff?huh"))); } @Test void testExtractsUriFromAbsoluteUriInRequest() { final HttpHost host = new HttpHost("bar.example.com"); final HttpRequest req = new HttpGet("http://foo.example.com/"); Assertions.assertEquals("http://foo.example.com:80/", extractor.generateKey(host, req)); } @Test void testGetURIWithDefaultPortAndScheme() { Assertions.assertEquals("http://www.comcast.net:80/", extractor.generateKey( new HttpHost("www.comcast.net"), new BasicHttpRequest("GET", "/"))); Assertions.assertEquals("http://www.fancast.com:80/full_episodes", extractor.generateKey( new HttpHost("www.fancast.com"), new BasicHttpRequest("GET", "/full_episodes"))); } @Test void testGetURIWithDifferentScheme() { Assertions.assertEquals("https://www.comcast.net:443/", extractor.generateKey( new HttpHost("https", "www.comcast.net", -1), new BasicHttpRequest("GET", "/"))); Assertions.assertEquals("myhttp://www.fancast.com/full_episodes", extractor.generateKey( new HttpHost("myhttp", "www.fancast.com", -1), new BasicHttpRequest("GET", "/full_episodes"))); } @Test void testGetURIWithDifferentPort() { Assertions.assertEquals("http://www.comcast.net:8080/", extractor.generateKey( new HttpHost("www.comcast.net", 8080), new BasicHttpRequest("GET", "/"))); Assertions.assertEquals("http://www.fancast.com:9999/full_episodes", extractor.generateKey( new HttpHost("www.fancast.com", 9999), new BasicHttpRequest("GET", "/full_episodes"))); } @Test void testGetURIWithDifferentPortAndScheme() { Assertions.assertEquals("https://www.comcast.net:8080/", extractor.generateKey( new HttpHost("https", "www.comcast.net", 8080), new BasicHttpRequest("GET", "/"))); Assertions.assertEquals("myhttp://www.fancast.com:9999/full_episodes", extractor.generateKey( new HttpHost("myhttp", "www.fancast.com", 9999), new BasicHttpRequest("GET", "/full_episodes"))); } @Test void testEmptyPortEquivalentToDefaultPortForHttp() { final HttpHost host1 = new HttpHost("foo.example.com:"); final HttpHost host2 = new HttpHost("foo.example.com:80"); final HttpRequest req = new BasicHttpRequest("GET", "/"); Assertions.assertEquals(extractor.generateKey(host1, req), extractor.generateKey(host2, req)); } @Test void testEmptyPortEquivalentToDefaultPortForHttps() { final HttpHost host1 = new HttpHost("https", "foo.example.com", -1); final HttpHost host2 = new HttpHost("https", "foo.example.com", 443); final HttpRequest req = new BasicHttpRequest("GET", "/"); final String uri1 = extractor.generateKey(host1, req); final String uri2 = extractor.generateKey(host2, req); Assertions.assertEquals(uri1, uri2); } @Test void testEmptyPortEquivalentToDefaultPortForHttpsAbsoluteURI() { final HttpHost host = new HttpHost("https", "foo.example.com", -1); final HttpGet get1 = new HttpGet("https://bar.example.com:/"); final HttpGet get2 = new HttpGet("https://bar.example.com:443/"); final String uri1 = extractor.generateKey(host, get1); final String uri2 = extractor.generateKey(host, get2); Assertions.assertEquals(uri1, uri2); } @Test void testNotProvidedPortEquivalentToDefaultPortForHttpsAbsoluteURI() { final HttpHost host = new HttpHost("https", "foo.example.com", -1); final HttpGet get1 = new HttpGet("https://bar.example.com/"); final HttpGet get2 = new HttpGet("https://bar.example.com:443/"); final String uri1 = extractor.generateKey(host, get1); final String uri2 = extractor.generateKey(host, get2); Assertions.assertEquals(uri1, uri2); } @Test void testNotProvidedPortEquivalentToDefaultPortForHttp() { final HttpHost host1 = new HttpHost("foo.example.com"); final HttpHost host2 = new HttpHost("foo.example.com:80"); final HttpRequest req = new BasicHttpRequest("GET", "/"); Assertions.assertEquals(extractor.generateKey(host1, req), extractor.generateKey(host2, req)); } @Test void testHostNameComparisonsAreCaseInsensitive() { final HttpHost host1 = new HttpHost("foo.example.com"); final HttpHost host2 = new HttpHost("FOO.EXAMPLE.COM"); final HttpRequest req = new BasicHttpRequest("GET", "/"); Assertions.assertEquals(extractor.generateKey(host1, req), extractor.generateKey(host2, req)); } @Test void testSchemeNameComparisonsAreCaseInsensitive() { final HttpHost host1 = new HttpHost("http", "foo.example.com", -1); final HttpHost host2 = new HttpHost("HTTP", "foo.example.com", -1); final HttpRequest req = new BasicHttpRequest("GET", "/"); Assertions.assertEquals(extractor.generateKey(host1, req), extractor.generateKey(host2, req)); } @Test void testEmptyAbsPathIsEquivalentToSlash() { final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest req1 = new BasicHttpRequest("GET", "/"); final HttpRequest req2 = new HttpGet("http://foo.example.com"); Assertions.assertEquals(extractor.generateKey(host, req1), extractor.generateKey(host, req2)); } @Test void testExtraDotSegmentsAreIgnored() { final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest req1 = new BasicHttpRequest("GET", "/"); final HttpRequest req2 = new HttpGet("http://foo.example.com/./"); Assertions.assertEquals(extractor.generateKey(host, req1), extractor.generateKey(host, req2)); } @Test void testExtraDotDotSegmentsAreIgnored() { final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest req1 = new BasicHttpRequest("GET", "/"); final HttpRequest req2 = new HttpGet("http://foo.example.com/.././../"); Assertions.assertEquals(extractor.generateKey(host, req1), extractor.generateKey(host, req2)); } @Test void testIntermidateDotDotSegementsAreEquivalent() { final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest req1 = new BasicHttpRequest("GET", "/home.html"); final HttpRequest req2 = new BasicHttpRequest("GET", "/%7Esmith/../home.html"); Assertions.assertEquals(extractor.generateKey(host, req1), extractor.generateKey(host, req2)); } @Test void testIntermidateEncodedDotDotSegementsAreEquivalent() { final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest req1 = new BasicHttpRequest("GET", "/home.html"); final HttpRequest req2 = new BasicHttpRequest("GET", "/%7Esmith/../home.html"); Assertions.assertEquals(extractor.generateKey(host, req1), extractor.generateKey(host, req2)); } @Test void testIntermidateDotSegementsAreEquivalent() { final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest req1 = new BasicHttpRequest("GET", "/~smith/home.html"); final HttpRequest req2 = new BasicHttpRequest("GET", "/%7Esmith/./home.html"); Assertions.assertEquals(extractor.generateKey(host, req1), extractor.generateKey(host, req2)); } @Test void testEquivalentPathEncodingsAreEquivalent() { final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest req1 = new BasicHttpRequest("GET", "/~smith/home.html"); final HttpRequest req2 = new BasicHttpRequest("GET", "/%7Esmith/home.html"); Assertions.assertEquals(extractor.generateKey(host, req1), extractor.generateKey(host, req2)); } @Test void testEquivalentExtraPathEncodingsAreEquivalent() { final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest req1 = new BasicHttpRequest("GET", "/~smith/home.html"); final HttpRequest req2 = new BasicHttpRequest("GET", "/%7Esmith/home.html"); Assertions.assertEquals(extractor.generateKey(host, req1), extractor.generateKey(host, req2)); } @Test void testEquivalentExtraPathEncodingsWithPercentAreEquivalent() { final HttpHost host = new HttpHost("foo.example.com"); final HttpRequest req1 = new BasicHttpRequest("GET", "/~smith/home%20folder.html"); final HttpRequest req2 = new BasicHttpRequest("GET", "/%7Esmith/home%20folder.html"); Assertions.assertEquals(extractor.generateKey(host, req1), extractor.generateKey(host, req2)); } @Test void testGetURIWithQueryParameters() { Assertions.assertEquals("http://www.comcast.net:80/?foo=bar", extractor.generateKey( new HttpHost("http", "www.comcast.net", -1), new BasicHttpRequest("GET", "/?foo=bar"))); Assertions.assertEquals("http://www.fancast.com:80/full_episodes?foo=bar", extractor.generateKey( new HttpHost("http", "www.fancast.com", -1), new BasicHttpRequest("GET", "/full_episodes?foo=bar"))); } private static Iterator
headers(final Header... headers) { return new BasicHeaderIterator(headers, null); } @Test void testNormalizeHeaderElements() { final List tokens = new ArrayList<>(); CacheKeyGenerator.normalizeElements(headers( new BasicHeader("Accept-Encoding", "gzip,zip,deflate") ), tokens::add); Assertions.assertEquals(Arrays.asList("deflate", "gzip", "zip"), tokens); tokens.clear(); CacheKeyGenerator.normalizeElements(headers( new BasicHeader("Accept-Encoding", " gZip , Zip, , , deflate ") ), tokens::add); Assertions.assertEquals(Arrays.asList("deflate", "gzip", "zip"), tokens); tokens.clear(); CacheKeyGenerator.normalizeElements(headers( new BasicHeader("Accept-Encoding", "gZip,Zip,,"), new BasicHeader("Accept-Encoding", " gZip,Zip,,,"), new BasicHeader("Accept-Encoding", "gZip, ,,,deflate") ), tokens::add); Assertions.assertEquals(Arrays.asList("deflate", "gzip", "zip"), tokens); tokens.clear(); CacheKeyGenerator.normalizeElements(headers( new BasicHeader("Cookie", "name1 = value1 ; p1 = v1 ; P2 = \"v2\""), new BasicHeader("Cookie", "name3;;;"), new BasicHeader("Cookie", " name2 = \" value 2 \" ; ; ; ,,,") ), tokens::add); Assertions.assertEquals(Arrays.asList("name1=value1;p1=v1;p2=v2", "name2=\" value 2 \"", "name3"), tokens); } @Test void testGetVariantKey() { final HttpRequest request = BasicRequestBuilder.get("/blah") .addHeader(HttpHeaders.USER_AGENT, "some-agent") .addHeader(HttpHeaders.ACCEPT_ENCODING, "gzip,zip") .addHeader(HttpHeaders.ACCEPT_ENCODING, "deflate") .build(); Assertions.assertEquals("{user-agent=some-agent}", extractor.generateVariantKey(request, Collections.singletonList(HttpHeaders.USER_AGENT))); Assertions.assertEquals("{accept-encoding=deflate,gzip,zip}", extractor.generateVariantKey(request, Collections.singletonList(HttpHeaders.ACCEPT_ENCODING))); Assertions.assertEquals("{accept-encoding=deflate,gzip,zip&user-agent=some-agent}", extractor.generateVariantKey(request, Arrays.asList(HttpHeaders.USER_AGENT, HttpHeaders.ACCEPT_ENCODING))); } @Test void testGetVariantKeyInputNormalization() { final HttpRequest request = BasicRequestBuilder.get("/blah") .addHeader(HttpHeaders.USER_AGENT, "Some-Agent") .addHeader(HttpHeaders.ACCEPT_ENCODING, "gzip, ZIP,,") .addHeader(HttpHeaders.ACCEPT_ENCODING, "deflate") .build(); Assertions.assertEquals("{user-agent=some-agent}", extractor.generateVariantKey(request, Collections.singletonList(HttpHeaders.USER_AGENT))); Assertions.assertEquals("{accept-encoding=deflate,gzip,zip}", extractor.generateVariantKey(request, Collections.singletonList(HttpHeaders.ACCEPT_ENCODING))); Assertions.assertEquals("{accept-encoding=deflate,gzip,zip&user-agent=some-agent}", extractor.generateVariantKey(request, Arrays.asList(HttpHeaders.USER_AGENT, HttpHeaders.ACCEPT_ENCODING))); Assertions.assertEquals("{accept-encoding=deflate,gzip,zip&user-agent=some-agent}", extractor.generateVariantKey(request, Arrays.asList(HttpHeaders.USER_AGENT, HttpHeaders.ACCEPT_ENCODING, "USER-AGENT", HttpHeaders.ACCEPT_ENCODING))); } @Test void testGetVariantKeyInputNormalizationReservedChars() { final HttpRequest request = BasicRequestBuilder.get("/blah") .addHeader(HttpHeaders.USER_AGENT, "*===some-agent===*") .build(); Assertions.assertEquals("{user-agent=%2A%3D%3D%3Dsome-agent%3D%3D%3D%2A}", extractor.generateVariantKey(request, Collections.singletonList(HttpHeaders.USER_AGENT))); } @Test void testGetVariantKeyInputNoMatchingHeaders() { final HttpRequest request = BasicRequestBuilder.get("/blah") .build(); Assertions.assertEquals("{accept-encoding=&user-agent=}", extractor.generateVariantKey(request, Arrays.asList(HttpHeaders.ACCEPT_ENCODING, HttpHeaders.USER_AGENT))); } @Test void testGetVariantKeyFromCachedResponse() { final HttpRequest request = BasicRequestBuilder.get("/blah") .addHeader("User-Agent", "agent1") .addHeader("Accept-Encoding", "text/plain") .build(); final HttpCacheEntry entry1 = HttpTestUtils.makeCacheEntry(); Assertions.assertNull(extractor.generateVariantKey(request, entry1)); final HttpCacheEntry entry2 = HttpTestUtils.makeCacheEntry( new BasicHeader("Vary", "User-Agent, Accept-Encoding") ); Assertions.assertEquals("{accept-encoding=text%2Fplain&user-agent=agent1}", extractor.generateVariantKey(request, entry2)); } } httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/schedule/0040775 0000000 0000000 00000000000 14704162040 025264 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000172 14704162040 011631 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/schedule/TestExponentialBackingOffSchedulingStrategy.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/schedule/TestExponentialBackingOffSc0100664 0000000 0000000 00000005024 14704162040 032533 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.schedule; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestExponentialBackingOffSchedulingStrategy { private ExponentialBackOffSchedulingStrategy impl; @BeforeEach void setUp() { impl = new ExponentialBackOffSchedulingStrategy( ExponentialBackOffSchedulingStrategy.DEFAULT_BACK_OFF_RATE, ExponentialBackOffSchedulingStrategy.DEFAULT_INITIAL_EXPIRY, ExponentialBackOffSchedulingStrategy.DEFAULT_MAX_EXPIRY ); } @Test void testSchedule() { Assertions.assertEquals(TimeValue.ofMilliseconds(0), impl.schedule(0)); Assertions.assertEquals(TimeValue.ofMilliseconds(6000), impl.schedule(1)); Assertions.assertEquals(TimeValue.ofMilliseconds(60000), impl.schedule(2)); Assertions.assertEquals(TimeValue.ofMilliseconds(600000), impl.schedule(3)); Assertions.assertEquals(TimeValue.ofMilliseconds(6000000), impl.schedule(4)); Assertions.assertEquals(TimeValue.ofMilliseconds(60000000), impl.schedule(5)); Assertions.assertEquals(TimeValue.ofMilliseconds(86400000), impl.schedule(6)); Assertions.assertEquals(TimeValue.ofMilliseconds(86400000), impl.schedule(Integer.MAX_VALUE)); } } ././@LongLink0100644 0000000 0000000 00000000156 14704162040 011633 Lustar 0000000 0000000 httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/schedule/TestImmediateSchedulingStrategy.javahttpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/schedule/TestImmediateSchedulingStra0100664 0000000 0000000 00000003613 14704162040 032605 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.schedule; import org.apache.hc.client5.http.schedule.SchedulingStrategy; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestImmediateSchedulingStrategy { private SchedulingStrategy impl; @BeforeEach void setUp() { impl = new ImmediateSchedulingStrategy(); } @Test void testSchedule() { Assertions.assertEquals(TimeValue.ZERO_MILLISECONDS, impl.schedule(0)); Assertions.assertEquals(TimeValue.ZERO_MILLISECONDS, impl.schedule(1)); Assertions.assertEquals(TimeValue.ZERO_MILLISECONDS, impl.schedule(Integer.MAX_VALUE)); } } httpclient5-cache/pom.xml0100664 0000000 0000000 00000010446 15064565770 014454 0ustar000000000 0000000 4.0.0 org.apache.httpcomponents.client5 httpclient5-parent 5.5.1 httpclient5-cache Apache HttpClient Cache 2010 Apache HttpComponents HttpClient Cache jar org.apache.httpcomponents.client5.httpclient5.cache org.apache.httpcomponents.client5 httpclient5 org.slf4j slf4j-api org.ehcache.modules ehcache-api true org.apache.logging.log4j log4j-slf4j-impl true org.apache.logging.log4j log4j-core test net.spy spymemcached true org.hamcrest hamcrest test org.mockito mockito-core test org.apache.httpcomponents.client5 httpclient5 ${project.version} test-jar test org.junit.jupiter junit-jupiter test org.apache.maven.plugins maven-jar-plugin test-jar maven-project-info-reports-plugin false index dependencies dependency-info summary mvnw.cmd0100664 0000000 0000000 00000015400 15016633414 011266 0ustar000000000 0000000 <# : batch portion @REM ---------------------------------------------------------------------------- @REM Licensed to the Apache Software Foundation (ASF) under one @REM or more contributor license agreements. See the NOTICE file @REM distributed with this work for additional information @REM regarding copyright ownership. The ASF licenses this file @REM to you under the Apache License, Version 2.0 (the @REM "License"); you may not use this file except in compliance @REM with the License. You may obtain a copy of the License at @REM @REM http://www.apache.org/licenses/LICENSE-2.0 @REM @REM Unless required by applicable law or agreed to in writing, @REM software distributed under the License is distributed on an @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @REM KIND, either express or implied. See the License for the @REM specific language governing permissions and limitations @REM under the License. @REM ---------------------------------------------------------------------------- @REM ---------------------------------------------------------------------------- @REM Apache Maven Wrapper startup batch script, version 3.3.2 @REM @REM Optional ENV vars @REM MVNW_REPOURL - repo url base for downloading maven distribution @REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven @REM MVNW_VERBOSE - true: enable verbose log; others: silence the output @REM ---------------------------------------------------------------------------- @IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) @SET __MVNW_CMD__= @SET __MVNW_ERROR__= @SET __MVNW_PSMODULEP_SAVE=%PSModulePath% @SET PSModulePath= @FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) ) @SET PSModulePath=%__MVNW_PSMODULEP_SAVE% @SET __MVNW_PSMODULEP_SAVE= @SET __MVNW_ARG0_NAME__= @SET MVNW_USERNAME= @SET MVNW_PASSWORD= @IF NOT "%__MVNW_CMD__%"=="" (%__MVNW_CMD__% %*) @echo Cannot start maven from wrapper >&2 && exit /b 1 @GOTO :EOF : end batch / begin powershell #> $ErrorActionPreference = "Stop" if ($env:MVNW_VERBOSE -eq "true") { $VerbosePreference = "Continue" } # calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties $distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl if (!$distributionUrl) { Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" } switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { "maven-mvnd-*" { $USE_MVND = $true $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" $MVN_CMD = "mvnd.cmd" break } default { $USE_MVND = $false $MVN_CMD = $script -replace '^mvnw','mvn' break } } # apply MVNW_REPOURL and calculate MAVEN_HOME # maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ if ($env:MVNW_REPOURL) { $MVNW_REPO_PATTERN = if ($USE_MVND) { "/org/apache/maven/" } else { "/maven/mvnd/" } $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace '^.*'+$MVNW_REPO_PATTERN,'')" } $distributionUrlName = $distributionUrl -replace '^.*/','' $distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' $MAVEN_HOME_PARENT = "$HOME/.m2/wrapper/dists/$distributionUrlNameMain" if ($env:MAVEN_USER_HOME) { $MAVEN_HOME_PARENT = "$env:MAVEN_USER_HOME/wrapper/dists/$distributionUrlNameMain" } $MAVEN_HOME_NAME = ([System.Security.Cryptography.MD5]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' $MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" exit $? } if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" } # prepare tmp dir $TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile $TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" $TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null trap { if ($TMP_DOWNLOAD_DIR.Exists) { try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } } } New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null # Download and Install Apache Maven Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." Write-Verbose "Downloading from: $distributionUrl" Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" $webclient = New-Object System.Net.WebClient if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) } [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 $webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null # If specified, validate the SHA-256 sum of the Maven distribution zip file $distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum if ($distributionSha256Sum) { if ($USE_MVND) { Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." } Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." } } # unzip and move Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null Rename-Item -Path "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" -NewName $MAVEN_HOME_NAME | Out-Null try { Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null } catch { if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { Write-Error "fail to move MAVEN_HOME" } } finally { try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } } Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" BUILDING.txt0100664 0000000 0000000 00000002072 14666635064 011566 0ustar000000000 0000000 Building HttpComponents Client ============================ (1) Requisites -------------- JDK 1.7+ is required in order to compile and run HttpClient. HttpClient utilizes Maven as a distribution management and packaging tool. Version 3.3 or later is required. Maven installation and configuration instructions can be found here: http://maven.apache.org/run-maven/index.html (2) Executing test cases Execute the following command in order to compile and test the components mvn test (3) Building packages Execute the following command in order to build the JAR packages and install them to the local repository: mvn install The JAR packages can be found in the target folders of their respective modules httpclient5/target/httpclient5-.jar httpclient5-cache/target/httpclient5-cache-.jar httpclient5-fluent/target/httpclient5-fluent-.jar httpclient5-osgi/target/org.apache.httpcomponents.httpclient_.jar where is the release version (4) Validating packages Check for proper license headers with: mvn apache-rat:check run-example.sh0100775 0000000 0000000 00000005473 15016633414 012417 0ustar000000000 0000000 #!/usr/bin/env bash # ==================================================================== # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # ==================================================================== # # This software consists of voluntary contributions made by many # individuals on behalf of the Apache Software Foundation. For more # information on the Apache Software Foundation, please see # . set -e usage() { cat <&2 usage >&2 exit 1 ;; *) break;; esac done classname=$1 shift || true args=("$@") # list examples if no classname if [[ -z $classname ]]; then find "$project/src/test/java" -type f -name '*.java' | grep '/examples/' \ | sed -e 's|\.java$||' \ | xargs basename | sort exit 0 fi # compile tests and build classpath cpfile=$(mktemp) trap 'rm -f "$cpfile"' EXIT ./mvnw -q -pl "$project" -am test-compile dependency:build-classpath \ -DincludeScope=test -Dmdep.outputFile="$cpfile" # assemble classpath cp="$project/target/test-classes:$project/target/classes:$(cat "$cpfile")" # find fully qualified classname fqn=$(find "$project/src/test/java" -name "${classname}.java" | head -n1) if [[ -z $fqn ]]; then echo "example not found: $classname" >&2 usage >&2 exit 1 fi fqn=${fqn#"$project/src/test/java/"} fqn=${fqn%.java} fqn=${fqn//\//.} # run it if [[ "$verbose" = true ]]; then echo java -cp "$cp" "$fqn" "${args[@]}" >&2 fi java -cp "$cp" "$fqn" "${args[@]}" httpclient5-fluent/0040775 0000000 0000000 00000000000 15063503632 013353 5ustar000000000 0000000 httpclient5-fluent/src/0040775 0000000 0000000 00000000000 14666635064 014157 5ustar000000000 0000000 httpclient5-fluent/src/main/0040775 0000000 0000000 00000000000 14666635064 015103 5ustar000000000 0000000 httpclient5-fluent/src/main/java/0040775 0000000 0000000 00000000000 14666635064 016024 5ustar000000000 0000000 httpclient5-fluent/src/main/java/org/0040775 0000000 0000000 00000000000 14666635064 016613 5ustar000000000 0000000 httpclient5-fluent/src/main/java/org/apache/0040775 0000000 0000000 00000000000 14666635064 020034 5ustar000000000 0000000 httpclient5-fluent/src/main/java/org/apache/hc/0040775 0000000 0000000 00000000000 14666635064 020426 5ustar000000000 0000000 httpclient5-fluent/src/main/java/org/apache/hc/client5/0040775 0000000 0000000 00000000000 14666635064 021771 5ustar000000000 0000000 httpclient5-fluent/src/main/java/org/apache/hc/client5/http/0040775 0000000 0000000 00000000000 14666635064 022750 5ustar000000000 0000000 httpclient5-fluent/src/main/java/org/apache/hc/client5/http/fluent/0040775 0000000 0000000 00000000000 15005672016 024227 5ustar000000000 0000000 httpclient5-fluent/src/main/java/org/apache/hc/client5/http/fluent/package-info.java0100664 0000000 0000000 00000002450 14666635064 027432 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Simple facade APIs for HttpClient based on the concept of * a fluent interface. */ package org.apache.hc.client5.http.fluent; httpclient5-fluent/src/main/java/org/apache/hc/client5/http/fluent/Async.java0100664 0000000 0000000 00000010074 14666635064 026164 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.fluent; import java.util.concurrent.Future; import org.apache.hc.core5.concurrent.BasicFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.io.HttpClientResponseHandler; /** * Asynchronous executor for {@link Request}s. * * @since 4.3 */ public class Async { private Executor executor; private java.util.concurrent.Executor concurrentExec; public static Async newInstance() { return new Async(); } Async() { super(); } public Async use(final Executor executor) { this.executor = executor; return this; } public Async use(final java.util.concurrent.Executor concurrentExec) { this.concurrentExec = concurrentExec; return this; } static class ExecRunnable implements Runnable { private final BasicFuture future; private final Request request; private final Executor executor; private final HttpClientResponseHandler handler; ExecRunnable( final BasicFuture future, final Request request, final Executor executor, final HttpClientResponseHandler handler) { super(); this.future = future; this.request = request; this.executor = executor; this.handler = handler; } @Override public void run() { try { final Response response = this.executor.execute(this.request); final T result = response.handleResponse(this.handler); this.future.completed(result); } catch (final Exception ex) { this.future.failed(ex); } } } public Future execute( final Request request, final HttpClientResponseHandler handler, final FutureCallback callback) { final BasicFuture future = new BasicFuture<>(callback); final ExecRunnable runnable = new ExecRunnable<>( future, request, this.executor != null ? this.executor : Executor.newInstance(), handler); if (this.concurrentExec != null) { this.concurrentExec.execute(runnable); } else { final Thread t = new Thread(runnable); t.setDaemon(true); t.start(); } return future; } public Future execute(final Request request, final HttpClientResponseHandler handler) { return execute(request, handler, null); } public Future execute(final Request request, final FutureCallback callback) { return execute(request, new ContentResponseHandler(), callback); } public Future execute(final Request request) { return execute(request, new ContentResponseHandler(), null); } } httpclient5-fluent/src/main/java/org/apache/hc/client5/http/fluent/ContentResponseHandler.java0100664 0000000 0000000 00000007076 14666635064 031546 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.fluent; import java.io.IOException; import org.apache.hc.client5.http.HttpResponseException; import org.apache.hc.client5.http.impl.classic.AbstractHttpClientResponseHandler; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; /** * {@link org.apache.hc.core5.http.io.HttpClientResponseHandler} implementation * that converts {@link org.apache.hc.core5.http.HttpResponse} messages * to {@link Content} instances. * * @see Content * @since 4.4 */ public class ContentResponseHandler extends AbstractHttpClientResponseHandler { /** * The maximum length of the exception message, to avoid excessive memory usage. */ private static final int MAX_MESSAGE_LENGTH = 256; @Override public Content handleEntity(final HttpEntity entity) throws IOException { return entity != null ? new Content(EntityUtils.toByteArray(entity), ContentType.parse(entity.getContentType())) : Content.NO_CONTENT; } /** * Handles a successful response (2xx status code) and returns the response entity as a {@link Content} object. * If no response entity exists, {@link Content#NO_CONTENT} is returned. * * @param response the HTTP response. * @return a {@link Content} object that encapsulates the response body, or {@link Content#NO_CONTENT} if the * response body is {@code null} or has zero length. * @throws HttpResponseException if the response was unsuccessful (status code greater than 300). * @throws IOException if an I/O error occurs. */ @Override public Content handleResponse(final ClassicHttpResponse response) throws IOException { final int statusCode = response.getCode(); final HttpEntity entity = response.getEntity(); final ContentType contentType = (entity != null && entity.getContentType() != null) ? ContentType.parse(entity.getContentType()) : ContentType.DEFAULT_BINARY; if (statusCode >= 300) { throw new HttpResponseException(statusCode, response.getReasonPhrase(), entity != null ? EntityUtils.toByteArray(entity, MAX_MESSAGE_LENGTH) : null, contentType); } return new Content(entity != null ? EntityUtils.toByteArray(entity) : new byte[] {}, contentType); } } httpclient5-fluent/src/main/java/org/apache/hc/client5/http/fluent/Form.java0100664 0000000 0000000 00000003567 14666635064 026023 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.fluent; import java.util.ArrayList; import java.util.List; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicNameValuePair; /** * HTTP form used by the fluent facade. * * @since 4.2 */ public class Form { private final List params; public static Form form() { return new Form(); } Form() { super(); this.params = new ArrayList<>(); } public Form add(final String name, final String value) { this.params.add(new BasicNameValuePair(name, value)); return this; } public List build() { return new ArrayList<>(this.params); } } httpclient5-fluent/src/main/java/org/apache/hc/client5/http/fluent/Content.java0100664 0000000 0000000 00000005052 14666635064 026521 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.fluent; import java.io.ByteArrayInputStream; import java.io.InputStream; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import org.apache.hc.core5.http.ContentType; /** * This class represents arbitrary content of a specific type that can be consumed * multiple times and requires no explicit deallocation used by the fluent facade. * * @since 4.2 */ public class Content { public static final Content NO_CONTENT = new Content(new byte[] {}, ContentType.DEFAULT_BINARY); private final byte[] raw; private final ContentType type; public Content(final byte[] raw, final ContentType type) { super(); this.raw = raw; this.type = type; } public ContentType getType() { return this.type; } public byte[] asBytes() { return this.raw.clone(); } public String asString() { Charset charset = this.type.getCharset(); if (charset == null) { charset = StandardCharsets.ISO_8859_1; } return asString(charset); } /** * @since 4.4 */ public String asString(final Charset charset) { return new String(this.raw, charset); } public InputStream asStream() { return new ByteArrayInputStream(this.raw); } @Override public String toString() { return asString(); } } httpclient5-fluent/src/main/java/org/apache/hc/client5/http/fluent/HttpHeader.java0100664 0000000 0000000 00000003145 14666635064 027140 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.fluent; class HttpHeader { public static final String CONTENT_LENGTH = "Content-Length"; public static final String DATE = "Date"; public static final String CACHE_CONTROL = "Cache-Control"; public static final String CONTENT_TYPE = "Content-Type"; public static final String IF_MODIFIED_SINCE = "If-Modified-Since"; public static final String IF_UNMODIFIED_SINCE = "If-Unmodified-Since"; } httpclient5-fluent/src/main/java/org/apache/hc/client5/http/fluent/Executor.java0100664 0000000 0000000 00000027337 15005672016 026701 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.fluent; import java.io.IOException; import java.net.URISyntaxException; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsStore; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder; import org.apache.hc.client5.http.impl.auth.BasicAuthCache; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.impl.auth.BasicScheme; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; import org.apache.hc.client5.http.impl.compat.ClassicToAsyncAdaptor; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Executor for {@link Request}s. *

* A connection pool with maximum 100 connections per route and * a total maximum of 200 connections is used internally. * * @since 4.2 */ public class Executor { private static final ReentrantLock LOCK = new ReentrantLock(); private static volatile CloseableHttpClient CLIENT; private static volatile CloseableHttpClient ASYNC_CLIENT; static CloseableHttpClient GET_CLASSIC_CLIENT() { final CloseableHttpClient client = CLIENT; if (client != null) { return client; } LOCK.lock(); try { if (CLIENT == null) { CLIENT = HttpClientBuilder.create() .setConnectionManager(PoolingHttpClientConnectionManagerBuilder.create() .useSystemProperties() .setMaxConnPerRoute(100) .setMaxConnTotal(200) .setDefaultConnectionConfig(ConnectionConfig.custom() .setValidateAfterInactivity(TimeValue.ofSeconds(10)) .build()) .build()) .useSystemProperties() .evictExpiredConnections() .evictIdleConnections(TimeValue.ofMinutes(1)) .build(); } return CLIENT; } finally { LOCK.unlock(); } } static CloseableHttpClient GET_ASYNC_CLIENT() { final CloseableHttpClient client = ASYNC_CLIENT; if (client != null) { return client; } LOCK.lock(); try { if (ASYNC_CLIENT == null) { ASYNC_CLIENT = new ClassicToAsyncAdaptor(HttpAsyncClientBuilder.create() .setConnectionManager(PoolingAsyncClientConnectionManagerBuilder.create() .useSystemProperties() .setMaxConnPerRoute(100) .setMaxConnTotal(200) .setMessageMultiplexing(true) .setDefaultConnectionConfig(ConnectionConfig.custom() .setValidateAfterInactivity(TimeValue.ofSeconds(10)) .build()) .build()) .useSystemProperties() .evictExpiredConnections() .evictIdleConnections(TimeValue.ofMinutes(1)) .build(), Timeout.ofMinutes(5)); } return ASYNC_CLIENT; } finally { LOCK.unlock(); } } public static Executor newInstance() { return new Executor(GET_CLASSIC_CLIENT()); } public static Executor newInstance(final CloseableHttpClient httpclient) { return new Executor(httpclient != null ? httpclient : GET_CLASSIC_CLIENT()); } /** * This feature is considered experimental and may be discontinued in the future. * @since 5.5 */ @Experimental public static Executor newInstance(final CloseableHttpAsyncClient httpclient) { return new Executor(httpclient != null ? new ClassicToAsyncAdaptor(httpclient, Timeout.ofMinutes(5)) : GET_ASYNC_CLIENT()); } private final CloseableHttpClient httpclient; private final AuthCache authCache; private volatile CredentialsStore credentialsStore; private volatile CookieStore cookieStore; Executor(final CloseableHttpClient httpclient) { super(); this.httpclient = httpclient; this.authCache = new BasicAuthCache(); } /** * @return this instance. * @since 4.5 */ public Executor use(final CredentialsStore credentialsStore) { this.credentialsStore = credentialsStore; return this; } public Executor auth(final AuthScope authScope, final Credentials credentials) { CredentialsStore credentialsStoreSnapshot = credentialsStore; if (credentialsStoreSnapshot == null) { credentialsStoreSnapshot = new BasicCredentialsProvider(); this.credentialsStore = credentialsStoreSnapshot; } credentialsStoreSnapshot.setCredentials(authScope, credentials); return this; } public Executor auth(final HttpHost host, final Credentials credentials) { return auth(new AuthScope(host), credentials); } /** * @return this instance. * @since 4.4 */ public Executor auth(final String host, final Credentials credentials) { final HttpHost httpHost; try { httpHost = HttpHost.create(host); } catch (final URISyntaxException ex) { throw new IllegalArgumentException("Invalid host: " + host); } return auth(httpHost, credentials); } public Executor authPreemptive(final HttpHost host) { final CredentialsStore credentialsStoreSnapshot = credentialsStore; if (credentialsStoreSnapshot != null) { final Credentials credentials = credentialsStoreSnapshot.getCredentials(new AuthScope(host), null); if (credentials != null) { final BasicScheme basicScheme = new BasicScheme(); basicScheme.initPreemptive(credentials); this.authCache.put(host, basicScheme); } } return this; } /** * @return this instance. * @since 4.4 */ public Executor authPreemptive(final String host) { final HttpHost httpHost; try { httpHost = HttpHost.create(host); } catch (final URISyntaxException ex) { throw new IllegalArgumentException("Invalid host: " + host); } return authPreemptive(httpHost); } public Executor authPreemptiveProxy(final HttpHost proxy) { final CredentialsStore credentialsStoreSnapshot = credentialsStore; if (credentialsStoreSnapshot != null) { final Credentials credentials = credentialsStoreSnapshot.getCredentials(new AuthScope(proxy), null); if (credentials != null) { final BasicScheme basicScheme = new BasicScheme(); basicScheme.initPreemptive(credentials); this.authCache.put(proxy, basicScheme); } } return this; } /** * @return this instance. * @since 4.4 */ public Executor authPreemptiveProxy(final String proxy) { final HttpHost httpHost; try { httpHost = HttpHost.create(proxy); } catch (final URISyntaxException ex) { throw new IllegalArgumentException("Invalid host: " + proxy); } return authPreemptiveProxy(httpHost); } public Executor auth(final HttpHost host, final String username, final char[] password) { return auth(host, new UsernamePasswordCredentials(username, password)); } /** * @return this instance. * @deprecated Use {@link #auth(HttpHost, String, char[])}. */ @Deprecated public Executor auth(final HttpHost host, final String username, final char[] password, final String workstation, final String domain) { return auth(host, new org.apache.hc.client5.http.auth.NTCredentials(username, password, workstation, domain)); } public Executor clearAuth() { final CredentialsStore credentialsStoreSnapshot = credentialsStore; if (credentialsStoreSnapshot != null) { credentialsStoreSnapshot.clear(); } return this; } /** * @return this instance. * @since 4.5 */ public Executor use(final CookieStore cookieStore) { this.cookieStore = cookieStore; return this; } public Executor clearCookies() { final CookieStore cookieStoreSnapshot = cookieStore; if (cookieStoreSnapshot != null) { cookieStoreSnapshot.clear(); } return this; } /** * Executes the request. Please Note that response content must be processed * or discarded using {@link Response#discardContent()}, otherwise the * connection used for the request might not be released to the pool. * * @see Response#handleResponse(org.apache.hc.core5.http.io.HttpClientResponseHandler) * @see Response#discardContent() */ public Response execute( final Request request) throws IOException { final HttpClientContext localContext = HttpClientContext.create(); final CredentialsStore credentialsStoreSnapshot = credentialsStore; if (credentialsStoreSnapshot != null) { localContext.setCredentialsProvider(credentialsStoreSnapshot); } if (this.authCache != null) { localContext.setAuthCache(this.authCache); } final CookieStore cookieStoreSnapshot = cookieStore; if (cookieStoreSnapshot != null) { localContext.setCookieStore(cookieStoreSnapshot); } return new Response(request.internalExecute(this.httpclient, localContext)); } } httpclient5-fluent/src/main/java/org/apache/hc/client5/http/fluent/Response.java0100664 0000000 0000000 00000011701 14666635064 026703 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.fluent; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.HttpResponseException; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicResponseBuilder; /** * HTTP response used by the fluent facade. * * @since 4.2 */ public class Response { private final ClassicHttpResponse response; private boolean consumed; Response(final ClassicHttpResponse response) { super(); this.response = response; } private void assertNotConsumed() { if (this.consumed) { throw new IllegalStateException("Response content has been already consumed"); } } private void dispose() throws IOException { if (this.consumed) { return; } try { final HttpEntity entity = this.response.getEntity(); if (entity != null) { final InputStream content = entity.getContent(); if (content != null) { content.close(); } } } finally { this.consumed = true; this.response.close(); } } /** * Discards response content and deallocates all resources associated with it. */ public void discardContent() { try { dispose(); } catch (final Exception ignore) { } } /** * Handles the response using the specified {@link HttpClientResponseHandler} */ public T handleResponse(final HttpClientResponseHandler handler) throws IOException { assertNotConsumed(); try { return handler.handleResponse(this.response); } catch (final HttpException ex) { throw new ClientProtocolException(ex); } finally { dispose(); } } public Content returnContent() throws IOException { return handleResponse(new ContentResponseHandler()); } public HttpResponse returnResponse() throws IOException { assertNotConsumed(); try { final HttpEntity entity = this.response.getEntity(); return ClassicResponseBuilder.copy(response) .setEntity(entity != null ? new ByteArrayEntity( EntityUtils.toByteArray(entity), ContentType.parse(entity.getContentType())) : null) .build(); } finally { this.consumed = true; this.response.close(); } } public void saveContent(final File file) throws IOException { assertNotConsumed(); try { final int status = response.getCode(); if (status >= HttpStatus.SC_REDIRECTION) { throw new HttpResponseException(status, response.getReasonPhrase()); } try (FileOutputStream out = new FileOutputStream(file)) { final HttpEntity entity = this.response.getEntity(); if (entity != null) { entity.writeTo(out); } } } finally { this.consumed = true; this.response.close(); } } } httpclient5-fluent/src/main/java/org/apache/hc/client5/http/fluent/Request.java0100664 0000000 0000000 00000034567 15005672016 026536 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.fluent; import java.io.File; import java.io.IOException; import java.io.InputStream; import java.net.URI; import java.net.URISyntaxException; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.time.Instant; import java.util.ArrayList; import java.util.Arrays; import java.util.Date; import java.util.List; import java.util.Locale; import java.util.TimeZone; import org.apache.hc.client5.http.classic.methods.HttpUriRequestBase; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.FileEntity; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.net.WWWFormCodec; import org.apache.hc.core5.util.Timeout; /** * HTTP request used by the fluent facade. * * @since 4.2 */ public class Request { /** * @deprecated This attribute is no longer supported as a part of the public API. */ @Deprecated public static final String DATE_FORMAT = "EEE, dd MMM yyyy HH:mm:ss zzz"; /** * @deprecated This attribute is no longer supported as a part of the public API. */ @Deprecated public static final Locale DATE_LOCALE = Locale.US; /** * @deprecated This attribute is no longer supported as a part of the public API. */ @Deprecated public static final TimeZone TIME_ZONE = TimeZone.getTimeZone("GMT"); private final ClassicHttpRequest request; private Boolean useExpectContinue; private Timeout connectTimeout; private Timeout responseTimeout; private HttpHost proxy; public static Request create(final Method method, final URI uri) { return new Request(new HttpUriRequestBase(method.name(), uri)); } public static Request create(final String methodName, final String uri) { return new Request(new HttpUriRequestBase(methodName, URI.create(uri))); } public static Request create(final String methodName, final URI uri) { return new Request(new HttpUriRequestBase(methodName, uri)); } public static Request get(final URI uri) { return new Request(new BasicClassicHttpRequest(Method.GET, uri)); } public static Request get(final String uri) { return new Request(new BasicClassicHttpRequest(Method.GET, uri)); } public static Request head(final URI uri) { return new Request(new BasicClassicHttpRequest(Method.HEAD, uri)); } public static Request head(final String uri) { return new Request(new BasicClassicHttpRequest(Method.HEAD, uri)); } public static Request post(final URI uri) { return new Request(new BasicClassicHttpRequest(Method.POST, uri)); } public static Request post(final String uri) { return new Request(new BasicClassicHttpRequest(Method.POST, uri)); } public static Request patch(final URI uri) { return new Request(new BasicClassicHttpRequest(Method.PATCH, uri)); } public static Request patch(final String uri) { return new Request(new BasicClassicHttpRequest(Method.PATCH, uri)); } public static Request put(final URI uri) { return new Request(new BasicClassicHttpRequest(Method.PUT, uri)); } public static Request put(final String uri) { return new Request(new BasicClassicHttpRequest(Method.PUT, uri)); } public static Request trace(final URI uri) { return new Request(new BasicClassicHttpRequest(Method.TRACE, uri)); } public static Request trace(final String uri) { return new Request(new BasicClassicHttpRequest(Method.TRACE, uri)); } public static Request delete(final URI uri) { return new Request(new BasicClassicHttpRequest(Method.DELETE, uri)); } public static Request delete(final String uri) { return new Request(new BasicClassicHttpRequest(Method.DELETE, uri)); } public static Request options(final URI uri) { return new Request(new BasicClassicHttpRequest(Method.OPTIONS, uri)); } public static Request options(final String uri) { return new Request(new BasicClassicHttpRequest(Method.OPTIONS, uri)); } Request(final ClassicHttpRequest request) { super(); this.request = request; } @SuppressWarnings("deprecation") ClassicHttpResponse internalExecute( final CloseableHttpClient client, final HttpClientContext localContext) throws IOException { final RequestConfig.Builder builder; if (client instanceof Configurable) { builder = RequestConfig.copy(((Configurable) client).getConfig()); } else { builder = RequestConfig.custom(); } if (this.useExpectContinue != null) { builder.setExpectContinueEnabled(this.useExpectContinue.booleanValue()); } if (this.connectTimeout != null) { builder.setConnectTimeout(this.connectTimeout); } if (this.responseTimeout != null) { builder.setResponseTimeout(this.responseTimeout); } if (this.proxy != null) { builder.setProxy(this.proxy); } final RequestConfig config = builder.build(); localContext.setRequestConfig(config); return client.executeOpen(null, this.request, localContext); } public Response execute() throws IOException { return execute(Executor.GET_CLASSIC_CLIENT()); } /** * Execute the request using an HTTP/2 capable engine. The exact protocol version * will still have to be negotiated by individual connections. *

* This feature is considered experimental and may be discontinued in the future. * * @since 5.5 */ @Experimental public Response executeHttp2() throws IOException { return execute(Executor.GET_ASYNC_CLIENT()); } public Response execute(final CloseableHttpClient client) throws IOException { return new Response(internalExecute(client, HttpClientContext.create())); } //// HTTP header operations public Request addHeader(final Header header) { this.request.addHeader(header); return this; } /** * @return this instance. * @since 4.3 */ public Request setHeader(final Header header) { this.request.setHeader(header); return this; } public Request addHeader(final String name, final String value) { this.request.addHeader(name, value); return this; } /** * @return this instance. * @since 4.3 */ public Request setHeader(final String name, final String value) { this.request.setHeader(name, value); return this; } public Request removeHeader(final Header header) { this.request.removeHeader(header); return this; } public Request removeHeaders(final String name) { this.request.removeHeaders(name); return this; } public Request setHeaders(final Header... headers) { this.request.setHeaders(headers); return this; } public Request setCacheControl(final String cacheControl) { this.request.setHeader(HttpHeader.CACHE_CONTROL, cacheControl); return this; } ClassicHttpRequest getRequest() { return request; } /** * @return this instance. * @deprecated Use {@link #setDate(Instant)} */ @Deprecated public Request setDate(final Date date) { this.request.setHeader(HttpHeader.DATE, DateUtils.formatStandardDate(DateUtils.toInstant(date))); return this; } /** * @return this instance. * @deprecated Use {@link #setIfModifiedSince(Instant)} */ @Deprecated public Request setIfModifiedSince(final Date date) { this.request.setHeader(HttpHeader.IF_MODIFIED_SINCE, DateUtils.formatStandardDate(DateUtils.toInstant(date))); return this; } /** * @return this instance. * @deprecated Use {@link #setIfUnmodifiedSince(Instant)} */ @Deprecated public Request setIfUnmodifiedSince(final Date date) { this.request.setHeader(HttpHeader.IF_UNMODIFIED_SINCE, DateUtils.formatStandardDate(DateUtils.toInstant(date))); return this; } public Request setDate(final Instant instant) { this.request.setHeader(HttpHeader.DATE, DateUtils.formatStandardDate(instant)); return this; } public Request setIfModifiedSince(final Instant instant) { this.request.setHeader(HttpHeader.IF_MODIFIED_SINCE, DateUtils.formatStandardDate(instant)); return this; } public Request setIfUnmodifiedSince(final Instant instant) { this.request.setHeader(HttpHeader.IF_UNMODIFIED_SINCE, DateUtils.formatStandardDate(instant)); return this; } //// HTTP protocol parameter operations public Request version(final HttpVersion version) { this.request.setVersion(version); return this; } public Request useExpectContinue() { this.useExpectContinue = Boolean.TRUE; return this; } public Request userAgent(final String agent) { this.request.setHeader(HttpHeaders.USER_AGENT, agent); return this; } //// HTTP connection parameter operations public Request connectTimeout(final Timeout timeout) { this.connectTimeout = timeout; return this; } public Request responseTimeout(final Timeout timeout) { this.responseTimeout = timeout; return this; } //// HTTP connection route operations public Request viaProxy(final HttpHost proxy) { this.proxy = proxy; return this; } /** * @return this instance. * @since 4.4 */ public Request viaProxy(final String proxy) { try { this.proxy = HttpHost.create(proxy); } catch (final URISyntaxException e) { throw new IllegalArgumentException("Invalid host"); } return this; } //// HTTP entity operations public Request body(final HttpEntity entity) { this.request.setEntity(entity); return this; } public Request bodyForm(final Iterable formParams, final Charset charset) { final List paramList = new ArrayList<>(); for (final NameValuePair param : formParams) { paramList.add(param); } final ContentType contentType = charset != null ? ContentType.APPLICATION_FORM_URLENCODED.withCharset(charset) : ContentType.APPLICATION_FORM_URLENCODED; final String s = WWWFormCodec.format(paramList, contentType.getCharset()); return bodyString(s, contentType); } public Request bodyForm(final Iterable formParams) { return bodyForm(formParams, StandardCharsets.ISO_8859_1); } public Request bodyForm(final NameValuePair... formParams) { return bodyForm(Arrays.asList(formParams), StandardCharsets.ISO_8859_1); } public Request bodyString(final String s, final ContentType contentType) { final Charset charset = contentType != null ? contentType.getCharset() : null; final byte[] raw = charset != null ? s.getBytes(charset) : s.getBytes(); return body(new ByteArrayEntity(raw, contentType)); } public Request bodyFile(final File file, final ContentType contentType) { return body(new FileEntity(file, contentType)); } public Request bodyByteArray(final byte[] b) { return body(new ByteArrayEntity(b, null)); } /** * @return this instance. * @since 4.4 */ public Request bodyByteArray(final byte[] b, final ContentType contentType) { return body(new ByteArrayEntity(b, contentType)); } public Request bodyByteArray(final byte[] b, final int off, final int len) { return body(new ByteArrayEntity(b, off, len, null)); } /** * @return this instance. * @since 4.4 */ public Request bodyByteArray(final byte[] b, final int off, final int len, final ContentType contentType) { return body(new ByteArrayEntity(b, off, len, contentType)); } public Request bodyStream(final InputStream inStream) { return body(new InputStreamEntity(inStream, -1, null)); } public Request bodyStream(final InputStream inStream, final ContentType contentType) { return body(new InputStreamEntity(inStream, -1, contentType)); } @Override public String toString() { return this.request.toString(); } } httpclient5-fluent/src/test/0040775 0000000 0000000 00000000000 14666635064 015136 5ustar000000000 0000000 httpclient5-fluent/src/test/java/0040775 0000000 0000000 00000000000 14666635064 016057 5ustar000000000 0000000 httpclient5-fluent/src/test/java/org/0040775 0000000 0000000 00000000000 14666635064 016646 5ustar000000000 0000000 httpclient5-fluent/src/test/java/org/apache/0040775 0000000 0000000 00000000000 14666635064 020067 5ustar000000000 0000000 httpclient5-fluent/src/test/java/org/apache/hc/0040775 0000000 0000000 00000000000 14666635064 020461 5ustar000000000 0000000 httpclient5-fluent/src/test/java/org/apache/hc/client5/0040775 0000000 0000000 00000000000 14666635064 022024 5ustar000000000 0000000 httpclient5-fluent/src/test/java/org/apache/hc/client5/http/0040775 0000000 0000000 00000000000 14666635064 023003 5ustar000000000 0000000 httpclient5-fluent/src/test/java/org/apache/hc/client5/http/examples/0040775 0000000 0000000 00000000000 14666635064 024621 5ustar000000000 0000000 httpclient5-fluent/src/test/java/org/apache/hc/client5/http/examples/fluent/0040775 0000000 0000000 00000000000 15005672016 026100 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000150 14666635064 011647 Lustar 0000000 0000000 httpclient5-fluent/src/test/java/org/apache/hc/client5/http/examples/fluent/FluentResponseHandling.javahttpclient5-fluent/src/test/java/org/apache/hc/client5/http/examples/fluent/FluentResponseHandling.j0100664 0000000 0000000 00000007465 14666635064 032723 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples.fluent; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.HttpResponseException; import org.apache.hc.client5.http.fluent.Request; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpStatus; import org.w3c.dom.Document; import org.xml.sax.SAXException; /** * This example demonstrates how the HttpClient fluent API can be used to handle HTTP responses * without buffering content body in memory. */ public class FluentResponseHandling { public static void main(final String... args)throws Exception { final Document result = Request.get("http://somehost/content") .execute().handleResponse(response -> { final int status = response.getCode(); final HttpEntity entity = response.getEntity(); if (status >= HttpStatus.SC_REDIRECTION) { throw new HttpResponseException(status, response.getReasonPhrase()); } if (entity == null) { throw new ClientProtocolException("Response contains no content"); } final DocumentBuilderFactory dbfac = DocumentBuilderFactory.newInstance(); try { final DocumentBuilder docBuilder = dbfac.newDocumentBuilder(); final ContentType contentType = ContentType.parseLenient(entity.getContentType()); if (!contentType.equals(ContentType.APPLICATION_XML)) { throw new ClientProtocolException("Unexpected content type:" + contentType); } Charset charset = contentType.getCharset(); if (charset == null) { charset = StandardCharsets.ISO_8859_1; } return docBuilder.parse(entity.getContent(), charset.name()); } catch (final ParserConfigurationException ex) { throw new IllegalStateException(ex); } catch (final SAXException ex) { throw new ClientProtocolException("Malformed XML document", ex); } }); // Do something useful with the result System.out.println(result); } } httpclient5-fluent/src/test/java/org/apache/hc/client5/http/examples/fluent/FluentAsync.java0100664 0000000 0000000 00000006542 15005672016 031202 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples.fluent; import java.util.LinkedList; import java.util.Queue; import java.util.concurrent.ExecutionException; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import org.apache.hc.client5.http.fluent.Async; import org.apache.hc.client5.http.fluent.Content; import org.apache.hc.client5.http.fluent.Request; import org.apache.hc.core5.concurrent.FutureCallback; /** * This example demonstrates how the he HttpClient fluent API can be used to execute multiple * requests asynchronously using background threads. */ public class FluentAsync { public static void main(final String... args)throws Exception { // Use pool of two threads final ExecutorService threadpool = Executors.newFixedThreadPool(2); final Async async = Async.newInstance().use(threadpool); final Request[] requests = new Request[] { Request.get("http://www.google.com/"), Request.get("http://www.yahoo.com/"), Request.get("http://www.apache.org/"), Request.get("http://www.apple.com/") }; final Queue> queue = new LinkedList<>(); // Execute requests asynchronously for (final Request request: requests) { final Future future = async.execute(request, new FutureCallback() { @Override public void failed(final Exception ex) { System.out.println(ex.getMessage() + ": " + request); } @Override public void completed(final Content content) { System.out.println("Request completed: " + request); } @Override public void cancelled() { } }); queue.add(future); } while (!queue.isEmpty()) { final Future future = queue.remove(); try { future.get(); } catch (final ExecutionException ignore) { } } System.out.println("Done"); threadpool.shutdown(); } } httpclient5-fluent/src/test/java/org/apache/hc/client5/http/examples/fluent/FluentRequests.java0100664 0000000 0000000 00000005562 14666635064 031757 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples.fluent; import java.io.File; import org.apache.hc.client5.http.fluent.Form; import org.apache.hc.client5.http.fluent.Request; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.util.Timeout; /** * This example demonstrates basics of request execution with the HttpClient fluent API. */ public class FluentRequests { public static void main(final String... args)throws Exception { // Execute a GET with timeout settings and return response content as String. Request.get("http://somehost/") .connectTimeout(Timeout.ofSeconds(1)) .responseTimeout(Timeout.ofSeconds(5)) .execute().returnContent().asString(); // Execute a POST with the 'expect-continue' handshake, using HTTP/1.1, // containing a request body as String and return response content as byte array. Request.post("http://somehost/do-stuff") .useExpectContinue() .version(HttpVersion.HTTP_1_1) .bodyString("Important stuff", ContentType.DEFAULT_TEXT) .execute().returnContent().asBytes(); // Execute a POST with a custom header through the proxy containing a request body // as an HTML form and save the result to the file Request.post("http://somehost/some-form") .addHeader("X-Custom-header", "stuff") .viaProxy(new HttpHost("myproxy", 8080)) .bodyForm(Form.form().add("username", "vip").add("password", "secret").build()) .execute().saveContent(new File("result.dump")); } } httpclient5-fluent/src/test/java/org/apache/hc/client5/http/examples/fluent/FluentExecutor.java0100664 0000000 0000000 00000006662 14666635064 031744 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples.fluent; import java.io.File; import org.apache.hc.client5.http.fluent.Executor; import org.apache.hc.client5.http.fluent.Form; import org.apache.hc.client5.http.fluent.Request; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.util.Timeout; /** * This example demonstrates how the he HttpClient fluent API can be used to execute multiple * requests within the same security context. The Executor class maintains a common context shared * by all requests executed with it. The Executor is thread-safe and can be used to execute * requests concurrently from multiple threads of execution. */ public class FluentExecutor { public static void main(final String... args)throws Exception { final Executor executor = Executor.newInstance() .auth(new HttpHost("somehost"), "username", "password".toCharArray()) .auth(new HttpHost("myproxy", 8080), "username", "password".toCharArray()) .authPreemptive(new HttpHost("myproxy", 8080)); // Execute a GET with timeout settings and return response content as String. executor.execute(Request.get("http://somehost/") .connectTimeout(Timeout.ofSeconds(1))) .returnContent().asString(); // Execute a POST with the 'expect-continue' handshake, using HTTP/1.1, // containing a request body as String and return response content as byte array. executor.execute(Request.post("http://somehost/do-stuff") .useExpectContinue() .version(HttpVersion.HTTP_1_1) .bodyString("Important stuff", ContentType.DEFAULT_TEXT) ).returnContent().asBytes(); // Execute a POST with a custom header through the proxy containing a request body // as an HTML form and save the result to the file executor.execute(Request.post("http://somehost/some-form") .addHeader("X-Custom-header", "stuff") .viaProxy(new HttpHost("myproxy", 8080)) .bodyForm(Form.form().add("username", "vip").add("password", "secret").build()) ).saveContent(new File("result.dump")); } } httpclient5-fluent/src/test/java/org/apache/hc/client5/http/fluent/0040775 0000000 0000000 00000000000 14704162040 024256 5ustar000000000 0000000 httpclient5-fluent/src/test/java/org/apache/hc/client5/http/fluent/TestRequest.java0100664 0000000 0000000 00000006206 14704162040 027412 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.fluent; import java.lang.reflect.Method; import java.net.URI; import java.util.stream.Stream; import org.apache.hc.core5.http.ClassicHttpRequest; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; class TestRequest { private static final String URI_STRING_FIXTURE = "http://localhost"; private static final URI URI_FIXTURE = URI.create(URI_STRING_FIXTURE); static Stream data() { return Stream.of( Arguments.of("delete", "DELETE"), Arguments.of("get", "GET"), Arguments.of("head", "HEAD"), Arguments.of("options", "OPTIONS"), Arguments.of("patch", "PATCH"), Arguments.of("post", "POST"), Arguments.of("put", "PUT"), Arguments.of("trace", "TRACE") ); } @ParameterizedTest(name = "{index}: {0} => {1}") @MethodSource("data") void testCreateFromString(final String methodName, final String expectedMethod) throws Exception { final Method method = Request.class.getMethod(methodName, String.class); final Request request = (Request) method.invoke(null, URI_STRING_FIXTURE); final ClassicHttpRequest classicHttpRequest = request.getRequest(); Assertions.assertEquals(expectedMethod, classicHttpRequest.getMethod()); } @ParameterizedTest(name = "{index}: {0} => {1}") @MethodSource("data") void testCreateFromURI(final String methodName, final String expectedMethod) throws Exception { final Method method = Request.class.getMethod(methodName, URI.class); final Request request = (Request) method.invoke(null, URI_FIXTURE); final ClassicHttpRequest classicHttpRequest = request.getRequest(); Assertions.assertEquals(expectedMethod, classicHttpRequest.getMethod()); } } httpclient5-fluent/pom.xml0100664 0000000 0000000 00000007165 15064565770 014712 0ustar000000000 0000000 4.0.0 org.apache.httpcomponents.client5 httpclient5-parent 5.5.1 httpclient5-fluent Apache HttpClient Fluent 2011 Apache HttpComponents Client Fluent jar org.apache.httpcomponents.client5.httpclient5.fluent org.apache.httpcomponents.client5 httpclient5 org.apache.httpcomponents.client5 httpclient5 test tests org.slf4j slf4j-api org.apache.logging.log4j log4j-slf4j-impl test org.apache.logging.log4j log4j-core test org.junit.jupiter junit-jupiter test org.hamcrest hamcrest test org.mockito mockito-core test maven-project-info-reports-plugin false index dependencies dependency-info summary httpclient5/0040775 0000000 0000000 00000000000 15063503632 012060 5ustar000000000 0000000 httpclient5/src/0040775 0000000 0000000 00000000000 14666635064 012664 5ustar000000000 0000000 httpclient5/src/main/0040775 0000000 0000000 00000000000 14666635064 013610 5ustar000000000 0000000 httpclient5/src/main/resources/0040775 0000000 0000000 00000000000 14666635064 015622 5ustar000000000 0000000 httpclient5/src/main/resources/org/0040775 0000000 0000000 00000000000 14704162040 016367 5ustar000000000 0000000 httpclient5/src/main/resources/org/apache/0040775 0000000 0000000 00000000000 14666635064 017632 5ustar000000000 0000000 httpclient5/src/main/resources/org/apache/hc/0040775 0000000 0000000 00000000000 14666635064 020224 5ustar000000000 0000000 httpclient5/src/main/resources/org/apache/hc/client5/0040775 0000000 0000000 00000000000 14666635064 021567 5ustar000000000 0000000 httpclient5/src/main/resources/org/apache/hc/client5/version.properties0100664 0000000 0000000 00000001540 14666635064 025367 0ustar000000000 0000000 # # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # info.module = ${project.artifactId} info.release = ${project.version} httpclient5/src/main/resources/org/publicsuffix/0040775 0000000 0000000 00000000000 14704162040 021072 5ustar000000000 0000000 httpclient5/src/main/resources/org/publicsuffix/list/0040775 0000000 0000000 00000000000 15064566127 022063 5ustar000000000 0000000 httpclient5/src/main/resources/org/publicsuffix/list/effective_tld_names.dat0100664 0000000 0000000 00001167554 15064566127 026563 0ustar000000000 0000000 // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at https://mozilla.org/MPL/2.0/. // Please pull this list from, and only from https://publicsuffix.org/list/public_suffix_list.dat, // rather than any other VCS sites. Pulling from any other URL is not guaranteed to be supported. // VERSION: 2025-09-23_13-07-02_UTC // COMMIT: 6defc0e19dbbe27dc2a0798256077d0b82d9c455 // Instructions on pulling and using this list can be found at https://publicsuffix.org/list/. // ===BEGIN ICANN DOMAINS=== // ac : http://nic.ac/rules.htm ac com.ac edu.ac gov.ac mil.ac net.ac org.ac // ad : https://www.iana.org/domains/root/db/ad.html // Confirmed by Amadeu Abril i Abril (CORE) 2024-11-17 ad // ae : https://www.iana.org/domains/root/db/ae.html ae ac.ae co.ae gov.ae mil.ae net.ae org.ae sch.ae // aero : https://information.aero/registration/policies/dmp aero // 2LDs airline.aero airport.aero // 2LDs (currently not accepting registration, seemingly never have) // As of 2024-07, these are marked as reserved for potential 3LD // registrations (clause 11 "allocated subdomains" in the 2006 TLD // policy), but the relevant industry partners have not opened them up // for registration. Current status can be determined from the TLD's // policy document: 2LDs that are open for registration must list // their policy in the TLD's policy. Any 2LD without such a policy is // not open for registrations. accident-investigation.aero accident-prevention.aero aerobatic.aero aeroclub.aero aerodrome.aero agents.aero air-surveillance.aero air-traffic-control.aero aircraft.aero airtraffic.aero ambulance.aero association.aero author.aero ballooning.aero broker.aero caa.aero cargo.aero catering.aero certification.aero championship.aero charter.aero civilaviation.aero club.aero conference.aero consultant.aero consulting.aero control.aero council.aero crew.aero design.aero dgca.aero educator.aero emergency.aero engine.aero engineer.aero entertainment.aero equipment.aero exchange.aero express.aero federation.aero flight.aero freight.aero fuel.aero gliding.aero government.aero groundhandling.aero group.aero hanggliding.aero homebuilt.aero insurance.aero journal.aero journalist.aero leasing.aero logistics.aero magazine.aero maintenance.aero marketplace.aero media.aero microlight.aero modelling.aero navigation.aero parachuting.aero paragliding.aero passenger-association.aero pilot.aero press.aero production.aero recreation.aero repbody.aero res.aero research.aero rotorcraft.aero safety.aero scientist.aero services.aero show.aero skydiving.aero software.aero student.aero taxi.aero trader.aero trading.aero trainer.aero union.aero workinggroup.aero works.aero // af : https://www.nic.af/domain-price af com.af edu.af gov.af net.af org.af // ag : http://www.nic.ag/prices.htm ag co.ag com.ag net.ag nom.ag org.ag // ai : http://nic.com.ai/ ai com.ai net.ai off.ai org.ai // al : http://www.ert.gov.al/ert_alb/faq_det.html?Id=31 al com.al edu.al gov.al mil.al net.al org.al // am : https://www.amnic.net/policy/en/Policy_EN.pdf // Confirmed by ISOC AM 2024-11-18 am co.am com.am commune.am net.am org.am // ao : https://www.iana.org/domains/root/db/ao.html // https://www.dns.ao/ao/ ao co.ao ed.ao edu.ao gov.ao gv.ao it.ao og.ao org.ao pb.ao // aq : https://www.iana.org/domains/root/db/aq.html aq // ar : https://nic.ar/es/nic-argentina/normativa ar bet.ar com.ar coop.ar edu.ar gob.ar gov.ar int.ar mil.ar musica.ar mutual.ar net.ar org.ar seg.ar senasa.ar tur.ar // arpa : https://www.iana.org/domains/root/db/arpa.html // Confirmed by registry 2008-06-18 arpa e164.arpa home.arpa in-addr.arpa ip6.arpa iris.arpa uri.arpa urn.arpa // as : https://www.iana.org/domains/root/db/as.html as gov.as // asia : https://www.iana.org/domains/root/db/asia.html asia // at : https://www.iana.org/domains/root/db/at.html // Confirmed by registry 2008-06-17 at ac.at sth.ac.at co.at gv.at or.at // au : https://www.iana.org/domains/root/db/au.html // https://www.auda.org.au/ // Confirmed by registry 2025-07-16 au // 2LDs asn.au com.au edu.au gov.au id.au net.au org.au // Historic 2LDs (closed to new registration, but sites still exist) conf.au oz.au // CGDNs : https://www.auda.org.au/au-domain-names/the-different-au-domain-names/state-and-territory-domain-names/ act.au nsw.au nt.au qld.au sa.au tas.au vic.au wa.au // 3LDs act.edu.au catholic.edu.au // eq.edu.au - Removed at the request of the Queensland Department of Education nsw.edu.au nt.edu.au qld.edu.au sa.edu.au tas.edu.au vic.edu.au wa.edu.au // act.gov.au - Bug 984824 - Removed at request of Greg Tankard // nsw.gov.au - Bug 547985 - Removed at request of // nt.gov.au - Bug 940478 - Removed at request of Greg Connors qld.gov.au sa.gov.au tas.gov.au vic.gov.au wa.gov.au // 4LDs // education.tas.edu.au - Removed at the request of the Department of Education Tasmania // schools.nsw.edu.au - Removed at the request of the New South Wales Department of Education. // aw : https://www.iana.org/domains/root/db/aw.html aw com.aw // ax : https://www.iana.org/domains/root/db/ax.html ax // az : https://www.iana.org/domains/root/db/az.html // Confirmed via https://whois.az/?page_id=10 2024-12-11 az biz.az co.az com.az edu.az gov.az info.az int.az mil.az name.az net.az org.az pp.az // No longer available for registration, however domains exist as of 2024-12-11 // see https://whois.az/?page_id=783 pro.az // ba : https://www.iana.org/domains/root/db/ba.html ba com.ba edu.ba gov.ba mil.ba net.ba org.ba // bb : https://www.iana.org/domains/root/db/bb.html bb biz.bb co.bb com.bb edu.bb gov.bb info.bb net.bb org.bb store.bb tv.bb // bd : https://www.iana.org/domains/root/db/bd.html *.bd // be : https://www.iana.org/domains/root/db/be.html // Confirmed by registry 2008-06-08 be ac.be // bf : https://www.iana.org/domains/root/db/bf.html bf gov.bf // bg : https://www.iana.org/domains/root/db/bg.html // https://www.register.bg/user/static/rules/en/index.html bg 0.bg 1.bg 2.bg 3.bg 4.bg 5.bg 6.bg 7.bg 8.bg 9.bg a.bg b.bg c.bg d.bg e.bg f.bg g.bg h.bg i.bg j.bg k.bg l.bg m.bg n.bg o.bg p.bg q.bg r.bg s.bg t.bg u.bg v.bg w.bg x.bg y.bg z.bg // bh : https://www.iana.org/domains/root/db/bh.html bh com.bh edu.bh gov.bh net.bh org.bh // bi : https://www.iana.org/domains/root/db/bi.html // http://whois.nic.bi/ bi co.bi com.bi edu.bi or.bi org.bi // biz : https://www.iana.org/domains/root/db/biz.html biz // bj : https://nic.bj/bj-suffixes.txt // Submitted by registry bj africa.bj agro.bj architectes.bj assur.bj avocats.bj co.bj com.bj eco.bj econo.bj edu.bj info.bj loisirs.bj money.bj net.bj org.bj ote.bj restaurant.bj resto.bj tourism.bj univ.bj // bm : https://www.bermudanic.bm/domain-registration/index.php bm com.bm edu.bm gov.bm net.bm org.bm // bn : http://www.bnnic.bn/faqs bn com.bn edu.bn gov.bn net.bn org.bn // bo : https://nic.bo // Confirmed by registry 2024-11-19 bo com.bo edu.bo gob.bo int.bo mil.bo net.bo org.bo tv.bo web.bo // Social Domains academia.bo agro.bo arte.bo blog.bo bolivia.bo ciencia.bo cooperativa.bo democracia.bo deporte.bo ecologia.bo economia.bo empresa.bo indigena.bo industria.bo info.bo medicina.bo movimiento.bo musica.bo natural.bo nombre.bo noticias.bo patria.bo plurinacional.bo politica.bo profesional.bo pueblo.bo revista.bo salud.bo tecnologia.bo tksat.bo transporte.bo wiki.bo // br : http://registro.br/dominio/categoria.html // Submitted by registry br 9guacu.br abc.br adm.br adv.br agr.br aju.br am.br anani.br aparecida.br api.br app.br arq.br art.br ato.br b.br barueri.br belem.br bet.br bhz.br bib.br bio.br blog.br bmd.br boavista.br bsb.br campinagrande.br campinas.br caxias.br cim.br cng.br cnt.br com.br contagem.br coop.br coz.br cri.br cuiaba.br curitiba.br def.br des.br det.br dev.br ecn.br eco.br edu.br emp.br enf.br eng.br esp.br etc.br eti.br far.br feira.br flog.br floripa.br fm.br fnd.br fortal.br fot.br foz.br fst.br g12.br geo.br ggf.br goiania.br gov.br // gov.br 26 states + df https://en.wikipedia.org/wiki/States_of_Brazil ac.gov.br al.gov.br am.gov.br ap.gov.br ba.gov.br ce.gov.br df.gov.br es.gov.br go.gov.br ma.gov.br mg.gov.br ms.gov.br mt.gov.br pa.gov.br pb.gov.br pe.gov.br pi.gov.br pr.gov.br rj.gov.br rn.gov.br ro.gov.br rr.gov.br rs.gov.br sc.gov.br se.gov.br sp.gov.br to.gov.br gru.br ia.br imb.br ind.br inf.br jab.br jampa.br jdf.br joinville.br jor.br jus.br leg.br leilao.br lel.br log.br londrina.br macapa.br maceio.br manaus.br maringa.br mat.br med.br mil.br morena.br mp.br mus.br natal.br net.br niteroi.br *.nom.br not.br ntr.br odo.br ong.br org.br osasco.br palmas.br poa.br ppg.br pro.br psc.br psi.br pvh.br qsl.br radio.br rec.br recife.br rep.br ribeirao.br rio.br riobranco.br riopreto.br salvador.br sampa.br santamaria.br santoandre.br saobernardo.br saogonca.br seg.br sjc.br slg.br slz.br social.br sorocaba.br srv.br taxi.br tc.br tec.br teo.br the.br tmp.br trd.br tur.br tv.br udi.br vet.br vix.br vlog.br wiki.br xyz.br zlg.br // bs : http://www.nic.bs/rules.html bs com.bs edu.bs gov.bs net.bs org.bs // bt : https://www.iana.org/domains/root/db/bt.html bt com.bt edu.bt gov.bt net.bt org.bt // bv : No registrations at this time. // Submitted by registry bv // bw : https://www.iana.org/domains/root/db/bw.html // https://nic.net.bw/bw-name-structure bw ac.bw co.bw gov.bw net.bw org.bw // by : https://www.iana.org/domains/root/db/by.html // http://tld.by/rules_2006_en.html // list of other 2nd level tlds ? by gov.by mil.by // Official information does not indicate that com.by is a reserved // second-level domain, but it's being used as one (see www.google.com.by and // www.yahoo.com.by, for example), so we list it here for safety's sake. com.by // http://hoster.by/ of.by // bz : https://www.iana.org/domains/root/db/bz.html // http://www.belizenic.bz/ bz co.bz com.bz edu.bz gov.bz net.bz org.bz // ca : https://www.iana.org/domains/root/db/ca.html ca // ca geographical names ab.ca bc.ca mb.ca nb.ca nf.ca nl.ca ns.ca nt.ca nu.ca on.ca pe.ca qc.ca sk.ca yk.ca // gc.ca: https://en.wikipedia.org/wiki/.gc.ca // see also: http://registry.gc.ca/en/SubdomainFAQ gc.ca // cat : https://www.iana.org/domains/root/db/cat.html cat // cc : https://www.iana.org/domains/root/db/cc.html cc // cd : https://www.iana.org/domains/root/db/cd.html // https://www.nic.cd cd gov.cd // cf : https://www.iana.org/domains/root/db/cf.html cf // cg : https://www.iana.org/domains/root/db/cg.html cg // ch : https://www.iana.org/domains/root/db/ch.html ch // ci : https://www.iana.org/domains/root/db/ci.html ci ac.ci aéroport.ci asso.ci co.ci com.ci ed.ci edu.ci go.ci gouv.ci int.ci net.ci or.ci org.ci // ck : https://www.iana.org/domains/root/db/ck.html *.ck !www.ck // cl : https://www.nic.cl // Confirmed by .CL registry cl co.cl gob.cl gov.cl mil.cl // cm : https://www.iana.org/domains/root/db/cm.html plus bug 981927 cm co.cm com.cm gov.cm net.cm // cn : https://www.iana.org/domains/root/db/cn.html // Submitted by registry cn ac.cn com.cn edu.cn gov.cn mil.cn net.cn org.cn 公司.cn 網絡.cn 网络.cn // cn geographic names ah.cn bj.cn cq.cn fj.cn gd.cn gs.cn gx.cn gz.cn ha.cn hb.cn he.cn hi.cn hk.cn hl.cn hn.cn jl.cn js.cn jx.cn ln.cn mo.cn nm.cn nx.cn qh.cn sc.cn sd.cn sh.cn sn.cn sx.cn tj.cn tw.cn xj.cn xz.cn yn.cn zj.cn // co : https://www.iana.org/domains/root/db/co.html // https://www.cointernet.com.co/como-funciona-un-dominio-restringido // Confirmed by registry 2024-11-18 co com.co edu.co gov.co mil.co net.co nom.co org.co // com : https://www.iana.org/domains/root/db/com.html com // coop : https://www.iana.org/domains/root/db/coop.html coop // cr : https://nic.cr/capitulo-1-registro-de-un-nombre-de-dominio/ cr ac.cr co.cr ed.cr fi.cr go.cr or.cr sa.cr // cu : https://www.iana.org/domains/root/db/cu.html cu com.cu edu.cu gob.cu inf.cu nat.cu net.cu org.cu // cv : https://www.iana.org/domains/root/db/cv.html // https://ola.cv/domain-extensions-under-cv/ // Confirmed by registry 2024-11-26 cv com.cv edu.cv id.cv int.cv net.cv nome.cv org.cv publ.cv // cw : https://www.uoc.cw/cw-registry // Confirmed by registry 2024-11-19 cw com.cw edu.cw net.cw org.cw // cx : https://www.iana.org/domains/root/db/cx.html // list of other 2nd level tlds ? cx gov.cx // cy : http://www.nic.cy/ // Submitted by Panayiotou Fotia // https://nic.cy/wp-content/uploads/2024/01/Create-Request-for-domain-name-registration-1.pdf cy ac.cy biz.cy com.cy ekloges.cy gov.cy ltd.cy mil.cy net.cy org.cy press.cy pro.cy tm.cy // cz : https://www.iana.org/domains/root/db/cz.html // Confirmed by registry 2025-08-06 cz gov.cz // de : https://www.iana.org/domains/root/db/de.html // Confirmed by registry (with technical // reservations) 2008-07-01 de // dj : https://www.iana.org/domains/root/db/dj.html dj // dk : https://www.iana.org/domains/root/db/dk.html // Confirmed by registry 2008-06-17 dk // dm : https://www.iana.org/domains/root/db/dm.html // https://nic.dm/policies/pdf/DMRulesandGuidelines2024v1.pdf // Confirmed by registry 2024-11-19 dm co.dm com.dm edu.dm gov.dm net.dm org.dm // do : https://www.iana.org/domains/root/db/do.html do art.do com.do edu.do gob.do gov.do mil.do net.do org.do sld.do web.do // dz : http://www.nic.dz/images/pdf_nic/charte.pdf dz art.dz asso.dz com.dz edu.dz gov.dz net.dz org.dz pol.dz soc.dz tm.dz // ec : https://www.nic.ec/ // Submitted by registry ec abg.ec adm.ec agron.ec arqt.ec art.ec bar.ec chef.ec com.ec cont.ec cpa.ec cue.ec dent.ec dgn.ec disco.ec doc.ec edu.ec eng.ec esm.ec fin.ec fot.ec gal.ec gob.ec gov.ec gye.ec ibr.ec info.ec k12.ec lat.ec loj.ec med.ec mil.ec mktg.ec mon.ec net.ec ntr.ec odont.ec org.ec pro.ec prof.ec psic.ec psiq.ec pub.ec rio.ec rrpp.ec sal.ec tech.ec tul.ec tur.ec uio.ec vet.ec xxx.ec // edu : https://www.iana.org/domains/root/db/edu.html edu // ee : https://www.internet.ee/domains/general-domains-and-procedure-for-registration-of-sub-domains-under-general-domains ee aip.ee com.ee edu.ee fie.ee gov.ee lib.ee med.ee org.ee pri.ee riik.ee // eg : https://www.iana.org/domains/root/db/eg.html // https://domain.eg/en/domain-rules/subdomain-names-types/ eg ac.eg com.eg edu.eg eun.eg gov.eg info.eg me.eg mil.eg name.eg net.eg org.eg sci.eg sport.eg tv.eg // er : https://www.iana.org/domains/root/db/er.html *.er // es : https://www.dominios.es/en es com.es edu.es gob.es nom.es org.es // et : https://www.iana.org/domains/root/db/et.html et biz.et com.et edu.et gov.et info.et name.et net.et org.et // eu : https://www.iana.org/domains/root/db/eu.html eu // fi : https://www.iana.org/domains/root/db/fi.html fi // aland.fi : https://www.iana.org/domains/root/db/ax.html // This domain is being phased out in favor of .ax. As there are still many // domains under aland.fi, we still keep it on the list until aland.fi is // completely removed. aland.fi // fj : http://domains.fj/ // Submitted by registry 2020-02-11 fj ac.fj biz.fj com.fj gov.fj info.fj mil.fj name.fj net.fj org.fj pro.fj // fk : https://www.iana.org/domains/root/db/fk.html *.fk // fm : https://www.iana.org/domains/root/db/fm.html fm com.fm edu.fm net.fm org.fm // fo : https://www.iana.org/domains/root/db/fo.html fo // fr : https://www.afnic.fr/ https://www.afnic.fr/wp-media/uploads/2022/12/afnic-naming-policy-2023-01-01.pdf fr asso.fr com.fr gouv.fr nom.fr prd.fr tm.fr // Other SLDs now selfmanaged out of AFNIC range. Former "domaines sectoriels", still registration suffixes avoues.fr cci.fr greta.fr huissier-justice.fr // ga : https://www.iana.org/domains/root/db/ga.html ga // gb : This registry is effectively dormant // Submitted by registry gb // gd : https://www.iana.org/domains/root/db/gd.html gd edu.gd gov.gd // ge : https://nic.ge/en/administrator/the-ge-domain-regulations // Confirmed by registry 2024-11-20 ge com.ge edu.ge gov.ge net.ge org.ge pvt.ge school.ge // gf : https://www.iana.org/domains/root/db/gf.html gf // gg : https://www.channelisles.net/register-1/register-direct // Confirmed by registry 2013-11-28 gg co.gg net.gg org.gg // gh : https://www.iana.org/domains/root/db/gh.html // https://www.nic.gh/ // Although domains directly at second level are not possible at the moment, // they have been possible for some time and may come back. gh biz.gh com.gh edu.gh gov.gh mil.gh net.gh org.gh // gi : http://www.nic.gi/rules.html gi com.gi edu.gi gov.gi ltd.gi mod.gi org.gi // gl : https://www.iana.org/domains/root/db/gl.html // http://nic.gl gl co.gl com.gl edu.gl net.gl org.gl // gm : http://www.nic.gm/htmlpages%5Cgm-policy.htm gm // gn : http://psg.com/dns/gn/gn.txt // Submitted by registry gn ac.gn com.gn edu.gn gov.gn net.gn org.gn // gov : https://www.iana.org/domains/root/db/gov.html gov // gp : http://www.nic.gp/index.php?lang=en gp asso.gp com.gp edu.gp mobi.gp net.gp org.gp // gq : https://www.iana.org/domains/root/db/gq.html gq // gr : https://www.iana.org/domains/root/db/gr.html // Submitted by registry gr com.gr edu.gr gov.gr net.gr org.gr // gs : https://www.iana.org/domains/root/db/gs.html gs // gt : https://www.gt/sitio/registration_policy.php?lang=en gt com.gt edu.gt gob.gt ind.gt mil.gt net.gt org.gt // gu : http://gadao.gov.gu/register.html // University of Guam : https://www.uog.edu // Submitted by uognoc@triton.uog.edu gu com.gu edu.gu gov.gu guam.gu info.gu net.gu org.gu web.gu // gw : https://www.iana.org/domains/root/db/gw.html // gw : https://nic.gw/regras/ gw // gy : https://www.iana.org/domains/root/db/gy.html // http://registry.gy/ gy co.gy com.gy edu.gy gov.gy net.gy org.gy // hk : https://www.hkirc.hk // Submitted by registry hk com.hk edu.hk gov.hk idv.hk net.hk org.hk 个人.hk 個人.hk 公司.hk 政府.hk 敎育.hk 教育.hk 箇人.hk 組織.hk 組织.hk 網絡.hk 網络.hk 组織.hk 组织.hk 网絡.hk 网络.hk // hm : https://www.iana.org/domains/root/db/hm.html hm // hn : https://www.iana.org/domains/root/db/hn.html hn com.hn edu.hn gob.hn mil.hn net.hn org.hn // hr : http://www.dns.hr/documents/pdf/HRTLD-regulations.pdf hr com.hr from.hr iz.hr name.hr // ht : http://www.nic.ht/info/charte.cfm ht adult.ht art.ht asso.ht com.ht coop.ht edu.ht firm.ht gouv.ht info.ht med.ht net.ht org.ht perso.ht pol.ht pro.ht rel.ht shop.ht // hu : https://www.iana.org/domains/root/db/hu.html // Confirmed by registry 2008-06-12 hu 2000.hu agrar.hu bolt.hu casino.hu city.hu co.hu erotica.hu erotika.hu film.hu forum.hu games.hu hotel.hu info.hu ingatlan.hu jogasz.hu konyvelo.hu lakas.hu media.hu news.hu org.hu priv.hu reklam.hu sex.hu shop.hu sport.hu suli.hu szex.hu tm.hu tozsde.hu utazas.hu video.hu // id : https://www.iana.org/domains/root/db/id.html id ac.id biz.id co.id desa.id go.id kop.id mil.id my.id net.id or.id ponpes.id sch.id web.id // ie : https://www.iana.org/domains/root/db/ie.html ie gov.ie // il : http://www.isoc.org.il/domains/ // see also: https://en.isoc.org.il/il-cctld/registration-rules // ISOC-IL (operated by .il Registry) il ac.il co.il gov.il idf.il k12.il muni.il net.il org.il // xn--4dbrk0ce ("Israel", Hebrew) : IL ישראל // xn--4dbgdty6c.xn--4dbrk0ce. אקדמיה.ישראל // xn--5dbhl8d.xn--4dbrk0ce. ישוב.ישראל // xn--8dbq2a.xn--4dbrk0ce. צהל.ישראל // xn--hebda8b.xn--4dbrk0ce. ממשל.ישראל // im : https://www.nic.im/ // Submitted by registry im ac.im co.im ltd.co.im plc.co.im com.im net.im org.im tt.im tv.im // in : https://www.iana.org/domains/root/db/in.html // see also: https://registry.in/policies // Please note, that nic.in is not an official eTLD, but used by most // government institutions. in 5g.in 6g.in ac.in ai.in am.in bihar.in biz.in business.in ca.in cn.in co.in com.in coop.in cs.in delhi.in dr.in edu.in er.in firm.in gen.in gov.in gujarat.in ind.in info.in int.in internet.in io.in me.in mil.in net.in nic.in org.in pg.in post.in pro.in res.in travel.in tv.in uk.in up.in us.in // info : https://www.iana.org/domains/root/db/info.html info // int : https://www.iana.org/domains/root/db/int.html // Confirmed by registry 2008-06-18 int eu.int // io : http://www.nic.io/rules.htm io co.io com.io edu.io gov.io mil.io net.io nom.io org.io // iq : http://www.cmc.iq/english/iq/iqregister1.htm iq com.iq edu.iq gov.iq mil.iq net.iq org.iq // ir : http://www.nic.ir/Terms_and_Conditions_ir,_Appendix_1_Domain_Rules // Also see http://www.nic.ir/Internationalized_Domain_Names // Two .ir entries added at request of , 2010-04-16 ir ac.ir co.ir gov.ir id.ir net.ir org.ir sch.ir // xn--mgba3a4f16a.ir (.ir, Persian YEH) ایران.ir // xn--mgba3a4fra.ir (.ir, Arabic YEH) ايران.ir // is : http://www.isnic.is/domain/rules.php // Confirmed by registry 2024-11-17 is // it : https://www.iana.org/domains/root/db/it.html // https://www.nic.it/ it edu.it gov.it // Regions (3.3.1) // https://www.nic.it/en/manage-your-it/forms-and-docs -> "Assignment and Management of domain names" abr.it abruzzo.it aosta-valley.it aostavalley.it bas.it basilicata.it cal.it calabria.it cam.it campania.it emilia-romagna.it emiliaromagna.it emr.it friuli-v-giulia.it friuli-ve-giulia.it friuli-vegiulia.it friuli-venezia-giulia.it friuli-veneziagiulia.it friuli-vgiulia.it friuliv-giulia.it friulive-giulia.it friulivegiulia.it friulivenezia-giulia.it friuliveneziagiulia.it friulivgiulia.it fvg.it laz.it lazio.it lig.it liguria.it lom.it lombardia.it lombardy.it lucania.it mar.it marche.it mol.it molise.it piedmont.it piemonte.it pmn.it pug.it puglia.it sar.it sardegna.it sardinia.it sic.it sicilia.it sicily.it taa.it tos.it toscana.it trentin-sud-tirol.it trentin-süd-tirol.it trentin-sudtirol.it trentin-südtirol.it trentin-sued-tirol.it trentin-suedtirol.it trentino.it trentino-a-adige.it trentino-aadige.it trentino-alto-adige.it trentino-altoadige.it trentino-s-tirol.it trentino-stirol.it trentino-sud-tirol.it trentino-süd-tirol.it trentino-sudtirol.it trentino-südtirol.it trentino-sued-tirol.it trentino-suedtirol.it trentinoa-adige.it trentinoaadige.it trentinoalto-adige.it trentinoaltoadige.it trentinos-tirol.it trentinostirol.it trentinosud-tirol.it trentinosüd-tirol.it trentinosudtirol.it trentinosüdtirol.it trentinosued-tirol.it trentinosuedtirol.it trentinsud-tirol.it trentinsüd-tirol.it trentinsudtirol.it trentinsüdtirol.it trentinsued-tirol.it trentinsuedtirol.it tuscany.it umb.it umbria.it val-d-aosta.it val-daosta.it vald-aosta.it valdaosta.it valle-aosta.it valle-d-aosta.it valle-daosta.it valleaosta.it valled-aosta.it valledaosta.it vallee-aoste.it vallée-aoste.it vallee-d-aoste.it vallée-d-aoste.it valleeaoste.it valléeaoste.it valleedaoste.it valléedaoste.it vao.it vda.it ven.it veneto.it // Provinces (3.3.2) ag.it agrigento.it al.it alessandria.it alto-adige.it altoadige.it an.it ancona.it andria-barletta-trani.it andria-trani-barletta.it andriabarlettatrani.it andriatranibarletta.it ao.it aosta.it aoste.it ap.it aq.it aquila.it ar.it arezzo.it ascoli-piceno.it ascolipiceno.it asti.it at.it av.it avellino.it ba.it balsan.it balsan-sudtirol.it balsan-südtirol.it balsan-suedtirol.it bari.it barletta-trani-andria.it barlettatraniandria.it belluno.it benevento.it bergamo.it bg.it bi.it biella.it bl.it bn.it bo.it bologna.it bolzano.it bolzano-altoadige.it bozen.it bozen-sudtirol.it bozen-südtirol.it bozen-suedtirol.it br.it brescia.it brindisi.it bs.it bt.it bulsan.it bulsan-sudtirol.it bulsan-südtirol.it bulsan-suedtirol.it bz.it ca.it cagliari.it caltanissetta.it campidano-medio.it campidanomedio.it campobasso.it carbonia-iglesias.it carboniaiglesias.it carrara-massa.it carraramassa.it caserta.it catania.it catanzaro.it cb.it ce.it cesena-forli.it cesena-forlì.it cesenaforli.it cesenaforlì.it ch.it chieti.it ci.it cl.it cn.it co.it como.it cosenza.it cr.it cremona.it crotone.it cs.it ct.it cuneo.it cz.it dell-ogliastra.it dellogliastra.it en.it enna.it fc.it fe.it fermo.it ferrara.it fg.it fi.it firenze.it florence.it fm.it foggia.it forli-cesena.it forlì-cesena.it forlicesena.it forlìcesena.it fr.it frosinone.it ge.it genoa.it genova.it go.it gorizia.it gr.it grosseto.it iglesias-carbonia.it iglesiascarbonia.it im.it imperia.it is.it isernia.it kr.it la-spezia.it laquila.it laspezia.it latina.it lc.it le.it lecce.it lecco.it li.it livorno.it lo.it lodi.it lt.it lu.it lucca.it macerata.it mantova.it massa-carrara.it massacarrara.it matera.it mb.it mc.it me.it medio-campidano.it mediocampidano.it messina.it mi.it milan.it milano.it mn.it mo.it modena.it monza.it monza-brianza.it monza-e-della-brianza.it monzabrianza.it monzaebrianza.it monzaedellabrianza.it ms.it mt.it na.it naples.it napoli.it no.it novara.it nu.it nuoro.it og.it ogliastra.it olbia-tempio.it olbiatempio.it or.it oristano.it ot.it pa.it padova.it padua.it palermo.it parma.it pavia.it pc.it pd.it pe.it perugia.it pesaro-urbino.it pesarourbino.it pescara.it pg.it pi.it piacenza.it pisa.it pistoia.it pn.it po.it pordenone.it potenza.it pr.it prato.it pt.it pu.it pv.it pz.it ra.it ragusa.it ravenna.it rc.it re.it reggio-calabria.it reggio-emilia.it reggiocalabria.it reggioemilia.it rg.it ri.it rieti.it rimini.it rm.it rn.it ro.it roma.it rome.it rovigo.it sa.it salerno.it sassari.it savona.it si.it siena.it siracusa.it so.it sondrio.it sp.it sr.it ss.it südtirol.it suedtirol.it sv.it ta.it taranto.it te.it tempio-olbia.it tempioolbia.it teramo.it terni.it tn.it to.it torino.it tp.it tr.it trani-andria-barletta.it trani-barletta-andria.it traniandriabarletta.it tranibarlettaandria.it trapani.it trento.it treviso.it trieste.it ts.it turin.it tv.it ud.it udine.it urbino-pesaro.it urbinopesaro.it va.it varese.it vb.it vc.it ve.it venezia.it venice.it verbania.it vercelli.it verona.it vi.it vibo-valentia.it vibovalentia.it vicenza.it viterbo.it vr.it vs.it vt.it vv.it // je : https://www.iana.org/domains/root/db/je.html // Confirmed by registry 2013-11-28 je co.je net.je org.je // jm : http://www.com.jm/register.html *.jm // jo : https://www.dns.jo/JoFamily.aspx // Confirmed by registry 2024-11-17 jo agri.jo ai.jo com.jo edu.jo eng.jo fm.jo gov.jo mil.jo net.jo org.jo per.jo phd.jo sch.jo tv.jo // jobs : https://www.iana.org/domains/root/db/jobs.html jobs // jp : https://www.iana.org/domains/root/db/jp.html // http://jprs.co.jp/en/jpdomain.html // Confirmed by registry 2024-11-22 jp // jp organizational type names ac.jp ad.jp co.jp ed.jp go.jp gr.jp lg.jp ne.jp or.jp // jp prefecture type names aichi.jp akita.jp aomori.jp chiba.jp ehime.jp fukui.jp fukuoka.jp fukushima.jp gifu.jp gunma.jp hiroshima.jp hokkaido.jp hyogo.jp ibaraki.jp ishikawa.jp iwate.jp kagawa.jp kagoshima.jp kanagawa.jp kochi.jp kumamoto.jp kyoto.jp mie.jp miyagi.jp miyazaki.jp nagano.jp nagasaki.jp nara.jp niigata.jp oita.jp okayama.jp okinawa.jp osaka.jp saga.jp saitama.jp shiga.jp shimane.jp shizuoka.jp tochigi.jp tokushima.jp tokyo.jp tottori.jp toyama.jp wakayama.jp yamagata.jp yamaguchi.jp yamanashi.jp 三重.jp 京都.jp 佐賀.jp 兵庫.jp 北海道.jp 千葉.jp 和歌山.jp 埼玉.jp 大分.jp 大阪.jp 奈良.jp 宮城.jp 宮崎.jp 富山.jp 山口.jp 山形.jp 山梨.jp 岐阜.jp 岡山.jp 岩手.jp 島根.jp 広島.jp 徳島.jp 愛媛.jp 愛知.jp 新潟.jp 東京.jp 栃木.jp 沖縄.jp 滋賀.jp 熊本.jp 石川.jp 神奈川.jp 福井.jp 福岡.jp 福島.jp 秋田.jp 群馬.jp 茨城.jp 長崎.jp 長野.jp 青森.jp 静岡.jp 香川.jp 高知.jp 鳥取.jp 鹿児島.jp // jp geographic type names // http://jprs.jp/doc/rule/saisoku-1.html // 2024-11-22: JPRS confirmed that jp geographic type names no longer accept new registrations. // Once all existing registrations expire (marking full discontinuation), these suffixes // will be removed from the PSL. *.kawasaki.jp !city.kawasaki.jp *.kitakyushu.jp !city.kitakyushu.jp *.kobe.jp !city.kobe.jp *.nagoya.jp !city.nagoya.jp *.sapporo.jp !city.sapporo.jp *.sendai.jp !city.sendai.jp *.yokohama.jp !city.yokohama.jp // 4th level registration aisai.aichi.jp ama.aichi.jp anjo.aichi.jp asuke.aichi.jp chiryu.aichi.jp chita.aichi.jp fuso.aichi.jp gamagori.aichi.jp handa.aichi.jp hazu.aichi.jp hekinan.aichi.jp higashiura.aichi.jp ichinomiya.aichi.jp inazawa.aichi.jp inuyama.aichi.jp isshiki.aichi.jp iwakura.aichi.jp kanie.aichi.jp kariya.aichi.jp kasugai.aichi.jp kira.aichi.jp kiyosu.aichi.jp komaki.aichi.jp konan.aichi.jp kota.aichi.jp mihama.aichi.jp miyoshi.aichi.jp nishio.aichi.jp nisshin.aichi.jp obu.aichi.jp oguchi.aichi.jp oharu.aichi.jp okazaki.aichi.jp owariasahi.aichi.jp seto.aichi.jp shikatsu.aichi.jp shinshiro.aichi.jp shitara.aichi.jp tahara.aichi.jp takahama.aichi.jp tobishima.aichi.jp toei.aichi.jp togo.aichi.jp tokai.aichi.jp tokoname.aichi.jp toyoake.aichi.jp toyohashi.aichi.jp toyokawa.aichi.jp toyone.aichi.jp toyota.aichi.jp tsushima.aichi.jp yatomi.aichi.jp akita.akita.jp daisen.akita.jp fujisato.akita.jp gojome.akita.jp hachirogata.akita.jp happou.akita.jp higashinaruse.akita.jp honjo.akita.jp honjyo.akita.jp ikawa.akita.jp kamikoani.akita.jp kamioka.akita.jp katagami.akita.jp kazuno.akita.jp kitaakita.akita.jp kosaka.akita.jp kyowa.akita.jp misato.akita.jp mitane.akita.jp moriyoshi.akita.jp nikaho.akita.jp noshiro.akita.jp odate.akita.jp oga.akita.jp ogata.akita.jp semboku.akita.jp yokote.akita.jp yurihonjo.akita.jp aomori.aomori.jp gonohe.aomori.jp hachinohe.aomori.jp hashikami.aomori.jp hiranai.aomori.jp hirosaki.aomori.jp itayanagi.aomori.jp kuroishi.aomori.jp misawa.aomori.jp mutsu.aomori.jp nakadomari.aomori.jp noheji.aomori.jp oirase.aomori.jp owani.aomori.jp rokunohe.aomori.jp sannohe.aomori.jp shichinohe.aomori.jp shingo.aomori.jp takko.aomori.jp towada.aomori.jp tsugaru.aomori.jp tsuruta.aomori.jp abiko.chiba.jp asahi.chiba.jp chonan.chiba.jp chosei.chiba.jp choshi.chiba.jp chuo.chiba.jp funabashi.chiba.jp futtsu.chiba.jp hanamigawa.chiba.jp ichihara.chiba.jp ichikawa.chiba.jp ichinomiya.chiba.jp inzai.chiba.jp isumi.chiba.jp kamagaya.chiba.jp kamogawa.chiba.jp kashiwa.chiba.jp katori.chiba.jp katsuura.chiba.jp kimitsu.chiba.jp kisarazu.chiba.jp kozaki.chiba.jp kujukuri.chiba.jp kyonan.chiba.jp matsudo.chiba.jp midori.chiba.jp mihama.chiba.jp minamiboso.chiba.jp mobara.chiba.jp mutsuzawa.chiba.jp nagara.chiba.jp nagareyama.chiba.jp narashino.chiba.jp narita.chiba.jp noda.chiba.jp oamishirasato.chiba.jp omigawa.chiba.jp onjuku.chiba.jp otaki.chiba.jp sakae.chiba.jp sakura.chiba.jp shimofusa.chiba.jp shirako.chiba.jp shiroi.chiba.jp shisui.chiba.jp sodegaura.chiba.jp sosa.chiba.jp tako.chiba.jp tateyama.chiba.jp togane.chiba.jp tohnosho.chiba.jp tomisato.chiba.jp urayasu.chiba.jp yachimata.chiba.jp yachiyo.chiba.jp yokaichiba.chiba.jp yokoshibahikari.chiba.jp yotsukaido.chiba.jp ainan.ehime.jp honai.ehime.jp ikata.ehime.jp imabari.ehime.jp iyo.ehime.jp kamijima.ehime.jp kihoku.ehime.jp kumakogen.ehime.jp masaki.ehime.jp matsuno.ehime.jp matsuyama.ehime.jp namikata.ehime.jp niihama.ehime.jp ozu.ehime.jp saijo.ehime.jp seiyo.ehime.jp shikokuchuo.ehime.jp tobe.ehime.jp toon.ehime.jp uchiko.ehime.jp uwajima.ehime.jp yawatahama.ehime.jp echizen.fukui.jp eiheiji.fukui.jp fukui.fukui.jp ikeda.fukui.jp katsuyama.fukui.jp mihama.fukui.jp minamiechizen.fukui.jp obama.fukui.jp ohi.fukui.jp ono.fukui.jp sabae.fukui.jp sakai.fukui.jp takahama.fukui.jp tsuruga.fukui.jp wakasa.fukui.jp ashiya.fukuoka.jp buzen.fukuoka.jp chikugo.fukuoka.jp chikuho.fukuoka.jp chikujo.fukuoka.jp chikushino.fukuoka.jp chikuzen.fukuoka.jp chuo.fukuoka.jp dazaifu.fukuoka.jp fukuchi.fukuoka.jp hakata.fukuoka.jp higashi.fukuoka.jp hirokawa.fukuoka.jp hisayama.fukuoka.jp iizuka.fukuoka.jp inatsuki.fukuoka.jp kaho.fukuoka.jp kasuga.fukuoka.jp kasuya.fukuoka.jp kawara.fukuoka.jp keisen.fukuoka.jp koga.fukuoka.jp kurate.fukuoka.jp kurogi.fukuoka.jp kurume.fukuoka.jp minami.fukuoka.jp miyako.fukuoka.jp miyama.fukuoka.jp miyawaka.fukuoka.jp mizumaki.fukuoka.jp munakata.fukuoka.jp nakagawa.fukuoka.jp nakama.fukuoka.jp nishi.fukuoka.jp nogata.fukuoka.jp ogori.fukuoka.jp okagaki.fukuoka.jp okawa.fukuoka.jp oki.fukuoka.jp omuta.fukuoka.jp onga.fukuoka.jp onojo.fukuoka.jp oto.fukuoka.jp saigawa.fukuoka.jp sasaguri.fukuoka.jp shingu.fukuoka.jp shinyoshitomi.fukuoka.jp shonai.fukuoka.jp soeda.fukuoka.jp sue.fukuoka.jp tachiarai.fukuoka.jp tagawa.fukuoka.jp takata.fukuoka.jp toho.fukuoka.jp toyotsu.fukuoka.jp tsuiki.fukuoka.jp ukiha.fukuoka.jp umi.fukuoka.jp usui.fukuoka.jp yamada.fukuoka.jp yame.fukuoka.jp yanagawa.fukuoka.jp yukuhashi.fukuoka.jp aizubange.fukushima.jp aizumisato.fukushima.jp aizuwakamatsu.fukushima.jp asakawa.fukushima.jp bandai.fukushima.jp date.fukushima.jp fukushima.fukushima.jp furudono.fukushima.jp futaba.fukushima.jp hanawa.fukushima.jp higashi.fukushima.jp hirata.fukushima.jp hirono.fukushima.jp iitate.fukushima.jp inawashiro.fukushima.jp ishikawa.fukushima.jp iwaki.fukushima.jp izumizaki.fukushima.jp kagamiishi.fukushima.jp kaneyama.fukushima.jp kawamata.fukushima.jp kitakata.fukushima.jp kitashiobara.fukushima.jp koori.fukushima.jp koriyama.fukushima.jp kunimi.fukushima.jp miharu.fukushima.jp mishima.fukushima.jp namie.fukushima.jp nango.fukushima.jp nishiaizu.fukushima.jp nishigo.fukushima.jp okuma.fukushima.jp omotego.fukushima.jp ono.fukushima.jp otama.fukushima.jp samegawa.fukushima.jp shimogo.fukushima.jp shirakawa.fukushima.jp showa.fukushima.jp soma.fukushima.jp sukagawa.fukushima.jp taishin.fukushima.jp tamakawa.fukushima.jp tanagura.fukushima.jp tenei.fukushima.jp yabuki.fukushima.jp yamato.fukushima.jp yamatsuri.fukushima.jp yanaizu.fukushima.jp yugawa.fukushima.jp anpachi.gifu.jp ena.gifu.jp gifu.gifu.jp ginan.gifu.jp godo.gifu.jp gujo.gifu.jp hashima.gifu.jp hichiso.gifu.jp hida.gifu.jp higashishirakawa.gifu.jp ibigawa.gifu.jp ikeda.gifu.jp kakamigahara.gifu.jp kani.gifu.jp kasahara.gifu.jp kasamatsu.gifu.jp kawaue.gifu.jp kitagata.gifu.jp mino.gifu.jp minokamo.gifu.jp mitake.gifu.jp mizunami.gifu.jp motosu.gifu.jp nakatsugawa.gifu.jp ogaki.gifu.jp sakahogi.gifu.jp seki.gifu.jp sekigahara.gifu.jp shirakawa.gifu.jp tajimi.gifu.jp takayama.gifu.jp tarui.gifu.jp toki.gifu.jp tomika.gifu.jp wanouchi.gifu.jp yamagata.gifu.jp yaotsu.gifu.jp yoro.gifu.jp annaka.gunma.jp chiyoda.gunma.jp fujioka.gunma.jp higashiagatsuma.gunma.jp isesaki.gunma.jp itakura.gunma.jp kanna.gunma.jp kanra.gunma.jp katashina.gunma.jp kawaba.gunma.jp kiryu.gunma.jp kusatsu.gunma.jp maebashi.gunma.jp meiwa.gunma.jp midori.gunma.jp minakami.gunma.jp naganohara.gunma.jp nakanojo.gunma.jp nanmoku.gunma.jp numata.gunma.jp oizumi.gunma.jp ora.gunma.jp ota.gunma.jp shibukawa.gunma.jp shimonita.gunma.jp shinto.gunma.jp showa.gunma.jp takasaki.gunma.jp takayama.gunma.jp tamamura.gunma.jp tatebayashi.gunma.jp tomioka.gunma.jp tsukiyono.gunma.jp tsumagoi.gunma.jp ueno.gunma.jp yoshioka.gunma.jp asaminami.hiroshima.jp daiwa.hiroshima.jp etajima.hiroshima.jp fuchu.hiroshima.jp fukuyama.hiroshima.jp hatsukaichi.hiroshima.jp higashihiroshima.hiroshima.jp hongo.hiroshima.jp jinsekikogen.hiroshima.jp kaita.hiroshima.jp kui.hiroshima.jp kumano.hiroshima.jp kure.hiroshima.jp mihara.hiroshima.jp miyoshi.hiroshima.jp naka.hiroshima.jp onomichi.hiroshima.jp osakikamijima.hiroshima.jp otake.hiroshima.jp saka.hiroshima.jp sera.hiroshima.jp seranishi.hiroshima.jp shinichi.hiroshima.jp shobara.hiroshima.jp takehara.hiroshima.jp abashiri.hokkaido.jp abira.hokkaido.jp aibetsu.hokkaido.jp akabira.hokkaido.jp akkeshi.hokkaido.jp asahikawa.hokkaido.jp ashibetsu.hokkaido.jp ashoro.hokkaido.jp assabu.hokkaido.jp atsuma.hokkaido.jp bibai.hokkaido.jp biei.hokkaido.jp bifuka.hokkaido.jp bihoro.hokkaido.jp biratori.hokkaido.jp chippubetsu.hokkaido.jp chitose.hokkaido.jp date.hokkaido.jp ebetsu.hokkaido.jp embetsu.hokkaido.jp eniwa.hokkaido.jp erimo.hokkaido.jp esan.hokkaido.jp esashi.hokkaido.jp fukagawa.hokkaido.jp fukushima.hokkaido.jp furano.hokkaido.jp furubira.hokkaido.jp haboro.hokkaido.jp hakodate.hokkaido.jp hamatonbetsu.hokkaido.jp hidaka.hokkaido.jp higashikagura.hokkaido.jp higashikawa.hokkaido.jp hiroo.hokkaido.jp hokuryu.hokkaido.jp hokuto.hokkaido.jp honbetsu.hokkaido.jp horokanai.hokkaido.jp horonobe.hokkaido.jp ikeda.hokkaido.jp imakane.hokkaido.jp ishikari.hokkaido.jp iwamizawa.hokkaido.jp iwanai.hokkaido.jp kamifurano.hokkaido.jp kamikawa.hokkaido.jp kamishihoro.hokkaido.jp kamisunagawa.hokkaido.jp kamoenai.hokkaido.jp kayabe.hokkaido.jp kembuchi.hokkaido.jp kikonai.hokkaido.jp kimobetsu.hokkaido.jp kitahiroshima.hokkaido.jp kitami.hokkaido.jp kiyosato.hokkaido.jp koshimizu.hokkaido.jp kunneppu.hokkaido.jp kuriyama.hokkaido.jp kuromatsunai.hokkaido.jp kushiro.hokkaido.jp kutchan.hokkaido.jp kyowa.hokkaido.jp mashike.hokkaido.jp matsumae.hokkaido.jp mikasa.hokkaido.jp minamifurano.hokkaido.jp mombetsu.hokkaido.jp moseushi.hokkaido.jp mukawa.hokkaido.jp muroran.hokkaido.jp naie.hokkaido.jp nakagawa.hokkaido.jp nakasatsunai.hokkaido.jp nakatombetsu.hokkaido.jp nanae.hokkaido.jp nanporo.hokkaido.jp nayoro.hokkaido.jp nemuro.hokkaido.jp niikappu.hokkaido.jp niki.hokkaido.jp nishiokoppe.hokkaido.jp noboribetsu.hokkaido.jp numata.hokkaido.jp obihiro.hokkaido.jp obira.hokkaido.jp oketo.hokkaido.jp okoppe.hokkaido.jp otaru.hokkaido.jp otobe.hokkaido.jp otofuke.hokkaido.jp otoineppu.hokkaido.jp oumu.hokkaido.jp ozora.hokkaido.jp pippu.hokkaido.jp rankoshi.hokkaido.jp rebun.hokkaido.jp rikubetsu.hokkaido.jp rishiri.hokkaido.jp rishirifuji.hokkaido.jp saroma.hokkaido.jp sarufutsu.hokkaido.jp shakotan.hokkaido.jp shari.hokkaido.jp shibecha.hokkaido.jp shibetsu.hokkaido.jp shikabe.hokkaido.jp shikaoi.hokkaido.jp shimamaki.hokkaido.jp shimizu.hokkaido.jp shimokawa.hokkaido.jp shinshinotsu.hokkaido.jp shintoku.hokkaido.jp shiranuka.hokkaido.jp shiraoi.hokkaido.jp shiriuchi.hokkaido.jp sobetsu.hokkaido.jp sunagawa.hokkaido.jp taiki.hokkaido.jp takasu.hokkaido.jp takikawa.hokkaido.jp takinoue.hokkaido.jp teshikaga.hokkaido.jp tobetsu.hokkaido.jp tohma.hokkaido.jp tomakomai.hokkaido.jp tomari.hokkaido.jp toya.hokkaido.jp toyako.hokkaido.jp toyotomi.hokkaido.jp toyoura.hokkaido.jp tsubetsu.hokkaido.jp tsukigata.hokkaido.jp urakawa.hokkaido.jp urausu.hokkaido.jp uryu.hokkaido.jp utashinai.hokkaido.jp wakkanai.hokkaido.jp wassamu.hokkaido.jp yakumo.hokkaido.jp yoichi.hokkaido.jp aioi.hyogo.jp akashi.hyogo.jp ako.hyogo.jp amagasaki.hyogo.jp aogaki.hyogo.jp asago.hyogo.jp ashiya.hyogo.jp awaji.hyogo.jp fukusaki.hyogo.jp goshiki.hyogo.jp harima.hyogo.jp himeji.hyogo.jp ichikawa.hyogo.jp inagawa.hyogo.jp itami.hyogo.jp kakogawa.hyogo.jp kamigori.hyogo.jp kamikawa.hyogo.jp kasai.hyogo.jp kasuga.hyogo.jp kawanishi.hyogo.jp miki.hyogo.jp minamiawaji.hyogo.jp nishinomiya.hyogo.jp nishiwaki.hyogo.jp ono.hyogo.jp sanda.hyogo.jp sannan.hyogo.jp sasayama.hyogo.jp sayo.hyogo.jp shingu.hyogo.jp shinonsen.hyogo.jp shiso.hyogo.jp sumoto.hyogo.jp taishi.hyogo.jp taka.hyogo.jp takarazuka.hyogo.jp takasago.hyogo.jp takino.hyogo.jp tamba.hyogo.jp tatsuno.hyogo.jp toyooka.hyogo.jp yabu.hyogo.jp yashiro.hyogo.jp yoka.hyogo.jp yokawa.hyogo.jp ami.ibaraki.jp asahi.ibaraki.jp bando.ibaraki.jp chikusei.ibaraki.jp daigo.ibaraki.jp fujishiro.ibaraki.jp hitachi.ibaraki.jp hitachinaka.ibaraki.jp hitachiomiya.ibaraki.jp hitachiota.ibaraki.jp ibaraki.ibaraki.jp ina.ibaraki.jp inashiki.ibaraki.jp itako.ibaraki.jp iwama.ibaraki.jp joso.ibaraki.jp kamisu.ibaraki.jp kasama.ibaraki.jp kashima.ibaraki.jp kasumigaura.ibaraki.jp koga.ibaraki.jp miho.ibaraki.jp mito.ibaraki.jp moriya.ibaraki.jp naka.ibaraki.jp namegata.ibaraki.jp oarai.ibaraki.jp ogawa.ibaraki.jp omitama.ibaraki.jp ryugasaki.ibaraki.jp sakai.ibaraki.jp sakuragawa.ibaraki.jp shimodate.ibaraki.jp shimotsuma.ibaraki.jp shirosato.ibaraki.jp sowa.ibaraki.jp suifu.ibaraki.jp takahagi.ibaraki.jp tamatsukuri.ibaraki.jp tokai.ibaraki.jp tomobe.ibaraki.jp tone.ibaraki.jp toride.ibaraki.jp tsuchiura.ibaraki.jp tsukuba.ibaraki.jp uchihara.ibaraki.jp ushiku.ibaraki.jp yachiyo.ibaraki.jp yamagata.ibaraki.jp yawara.ibaraki.jp yuki.ibaraki.jp anamizu.ishikawa.jp hakui.ishikawa.jp hakusan.ishikawa.jp kaga.ishikawa.jp kahoku.ishikawa.jp kanazawa.ishikawa.jp kawakita.ishikawa.jp komatsu.ishikawa.jp nakanoto.ishikawa.jp nanao.ishikawa.jp nomi.ishikawa.jp nonoichi.ishikawa.jp noto.ishikawa.jp shika.ishikawa.jp suzu.ishikawa.jp tsubata.ishikawa.jp tsurugi.ishikawa.jp uchinada.ishikawa.jp wajima.ishikawa.jp fudai.iwate.jp fujisawa.iwate.jp hanamaki.iwate.jp hiraizumi.iwate.jp hirono.iwate.jp ichinohe.iwate.jp ichinoseki.iwate.jp iwaizumi.iwate.jp iwate.iwate.jp joboji.iwate.jp kamaishi.iwate.jp kanegasaki.iwate.jp karumai.iwate.jp kawai.iwate.jp kitakami.iwate.jp kuji.iwate.jp kunohe.iwate.jp kuzumaki.iwate.jp miyako.iwate.jp mizusawa.iwate.jp morioka.iwate.jp ninohe.iwate.jp noda.iwate.jp ofunato.iwate.jp oshu.iwate.jp otsuchi.iwate.jp rikuzentakata.iwate.jp shiwa.iwate.jp shizukuishi.iwate.jp sumita.iwate.jp tanohata.iwate.jp tono.iwate.jp yahaba.iwate.jp yamada.iwate.jp ayagawa.kagawa.jp higashikagawa.kagawa.jp kanonji.kagawa.jp kotohira.kagawa.jp manno.kagawa.jp marugame.kagawa.jp mitoyo.kagawa.jp naoshima.kagawa.jp sanuki.kagawa.jp tadotsu.kagawa.jp takamatsu.kagawa.jp tonosho.kagawa.jp uchinomi.kagawa.jp utazu.kagawa.jp zentsuji.kagawa.jp akune.kagoshima.jp amami.kagoshima.jp hioki.kagoshima.jp isa.kagoshima.jp isen.kagoshima.jp izumi.kagoshima.jp kagoshima.kagoshima.jp kanoya.kagoshima.jp kawanabe.kagoshima.jp kinko.kagoshima.jp kouyama.kagoshima.jp makurazaki.kagoshima.jp matsumoto.kagoshima.jp minamitane.kagoshima.jp nakatane.kagoshima.jp nishinoomote.kagoshima.jp satsumasendai.kagoshima.jp soo.kagoshima.jp tarumizu.kagoshima.jp yusui.kagoshima.jp aikawa.kanagawa.jp atsugi.kanagawa.jp ayase.kanagawa.jp chigasaki.kanagawa.jp ebina.kanagawa.jp fujisawa.kanagawa.jp hadano.kanagawa.jp hakone.kanagawa.jp hiratsuka.kanagawa.jp isehara.kanagawa.jp kaisei.kanagawa.jp kamakura.kanagawa.jp kiyokawa.kanagawa.jp matsuda.kanagawa.jp minamiashigara.kanagawa.jp miura.kanagawa.jp nakai.kanagawa.jp ninomiya.kanagawa.jp odawara.kanagawa.jp oi.kanagawa.jp oiso.kanagawa.jp sagamihara.kanagawa.jp samukawa.kanagawa.jp tsukui.kanagawa.jp yamakita.kanagawa.jp yamato.kanagawa.jp yokosuka.kanagawa.jp yugawara.kanagawa.jp zama.kanagawa.jp zushi.kanagawa.jp aki.kochi.jp geisei.kochi.jp hidaka.kochi.jp higashitsuno.kochi.jp ino.kochi.jp kagami.kochi.jp kami.kochi.jp kitagawa.kochi.jp kochi.kochi.jp mihara.kochi.jp motoyama.kochi.jp muroto.kochi.jp nahari.kochi.jp nakamura.kochi.jp nankoku.kochi.jp nishitosa.kochi.jp niyodogawa.kochi.jp ochi.kochi.jp okawa.kochi.jp otoyo.kochi.jp otsuki.kochi.jp sakawa.kochi.jp sukumo.kochi.jp susaki.kochi.jp tosa.kochi.jp tosashimizu.kochi.jp toyo.kochi.jp tsuno.kochi.jp umaji.kochi.jp yasuda.kochi.jp yusuhara.kochi.jp amakusa.kumamoto.jp arao.kumamoto.jp aso.kumamoto.jp choyo.kumamoto.jp gyokuto.kumamoto.jp kamiamakusa.kumamoto.jp kikuchi.kumamoto.jp kumamoto.kumamoto.jp mashiki.kumamoto.jp mifune.kumamoto.jp minamata.kumamoto.jp minamioguni.kumamoto.jp nagasu.kumamoto.jp nishihara.kumamoto.jp oguni.kumamoto.jp ozu.kumamoto.jp sumoto.kumamoto.jp takamori.kumamoto.jp uki.kumamoto.jp uto.kumamoto.jp yamaga.kumamoto.jp yamato.kumamoto.jp yatsushiro.kumamoto.jp ayabe.kyoto.jp fukuchiyama.kyoto.jp higashiyama.kyoto.jp ide.kyoto.jp ine.kyoto.jp joyo.kyoto.jp kameoka.kyoto.jp kamo.kyoto.jp kita.kyoto.jp kizu.kyoto.jp kumiyama.kyoto.jp kyotamba.kyoto.jp kyotanabe.kyoto.jp kyotango.kyoto.jp maizuru.kyoto.jp minami.kyoto.jp minamiyamashiro.kyoto.jp miyazu.kyoto.jp muko.kyoto.jp nagaokakyo.kyoto.jp nakagyo.kyoto.jp nantan.kyoto.jp oyamazaki.kyoto.jp sakyo.kyoto.jp seika.kyoto.jp tanabe.kyoto.jp uji.kyoto.jp ujitawara.kyoto.jp wazuka.kyoto.jp yamashina.kyoto.jp yawata.kyoto.jp asahi.mie.jp inabe.mie.jp ise.mie.jp kameyama.mie.jp kawagoe.mie.jp kiho.mie.jp kisosaki.mie.jp kiwa.mie.jp komono.mie.jp kumano.mie.jp kuwana.mie.jp matsusaka.mie.jp meiwa.mie.jp mihama.mie.jp minamiise.mie.jp misugi.mie.jp miyama.mie.jp nabari.mie.jp shima.mie.jp suzuka.mie.jp tado.mie.jp taiki.mie.jp taki.mie.jp tamaki.mie.jp toba.mie.jp tsu.mie.jp udono.mie.jp ureshino.mie.jp watarai.mie.jp yokkaichi.mie.jp furukawa.miyagi.jp higashimatsushima.miyagi.jp ishinomaki.miyagi.jp iwanuma.miyagi.jp kakuda.miyagi.jp kami.miyagi.jp kawasaki.miyagi.jp marumori.miyagi.jp matsushima.miyagi.jp minamisanriku.miyagi.jp misato.miyagi.jp murata.miyagi.jp natori.miyagi.jp ogawara.miyagi.jp ohira.miyagi.jp onagawa.miyagi.jp osaki.miyagi.jp rifu.miyagi.jp semine.miyagi.jp shibata.miyagi.jp shichikashuku.miyagi.jp shikama.miyagi.jp shiogama.miyagi.jp shiroishi.miyagi.jp tagajo.miyagi.jp taiwa.miyagi.jp tome.miyagi.jp tomiya.miyagi.jp wakuya.miyagi.jp watari.miyagi.jp yamamoto.miyagi.jp zao.miyagi.jp aya.miyazaki.jp ebino.miyazaki.jp gokase.miyazaki.jp hyuga.miyazaki.jp kadogawa.miyazaki.jp kawaminami.miyazaki.jp kijo.miyazaki.jp kitagawa.miyazaki.jp kitakata.miyazaki.jp kitaura.miyazaki.jp kobayashi.miyazaki.jp kunitomi.miyazaki.jp kushima.miyazaki.jp mimata.miyazaki.jp miyakonojo.miyazaki.jp miyazaki.miyazaki.jp morotsuka.miyazaki.jp nichinan.miyazaki.jp nishimera.miyazaki.jp nobeoka.miyazaki.jp saito.miyazaki.jp shiiba.miyazaki.jp shintomi.miyazaki.jp takaharu.miyazaki.jp takanabe.miyazaki.jp takazaki.miyazaki.jp tsuno.miyazaki.jp achi.nagano.jp agematsu.nagano.jp anan.nagano.jp aoki.nagano.jp asahi.nagano.jp azumino.nagano.jp chikuhoku.nagano.jp chikuma.nagano.jp chino.nagano.jp fujimi.nagano.jp hakuba.nagano.jp hara.nagano.jp hiraya.nagano.jp iida.nagano.jp iijima.nagano.jp iiyama.nagano.jp iizuna.nagano.jp ikeda.nagano.jp ikusaka.nagano.jp ina.nagano.jp karuizawa.nagano.jp kawakami.nagano.jp kiso.nagano.jp kisofukushima.nagano.jp kitaaiki.nagano.jp komagane.nagano.jp komoro.nagano.jp matsukawa.nagano.jp matsumoto.nagano.jp miasa.nagano.jp minamiaiki.nagano.jp minamimaki.nagano.jp minamiminowa.nagano.jp minowa.nagano.jp miyada.nagano.jp miyota.nagano.jp mochizuki.nagano.jp nagano.nagano.jp nagawa.nagano.jp nagiso.nagano.jp nakagawa.nagano.jp nakano.nagano.jp nozawaonsen.nagano.jp obuse.nagano.jp ogawa.nagano.jp okaya.nagano.jp omachi.nagano.jp omi.nagano.jp ookuwa.nagano.jp ooshika.nagano.jp otaki.nagano.jp otari.nagano.jp sakae.nagano.jp sakaki.nagano.jp saku.nagano.jp sakuho.nagano.jp shimosuwa.nagano.jp shinanomachi.nagano.jp shiojiri.nagano.jp suwa.nagano.jp suzaka.nagano.jp takagi.nagano.jp takamori.nagano.jp takayama.nagano.jp tateshina.nagano.jp tatsuno.nagano.jp togakushi.nagano.jp togura.nagano.jp tomi.nagano.jp ueda.nagano.jp wada.nagano.jp yamagata.nagano.jp yamanouchi.nagano.jp yasaka.nagano.jp yasuoka.nagano.jp chijiwa.nagasaki.jp futsu.nagasaki.jp goto.nagasaki.jp hasami.nagasaki.jp hirado.nagasaki.jp iki.nagasaki.jp isahaya.nagasaki.jp kawatana.nagasaki.jp kuchinotsu.nagasaki.jp matsuura.nagasaki.jp nagasaki.nagasaki.jp obama.nagasaki.jp omura.nagasaki.jp oseto.nagasaki.jp saikai.nagasaki.jp sasebo.nagasaki.jp seihi.nagasaki.jp shimabara.nagasaki.jp shinkamigoto.nagasaki.jp togitsu.nagasaki.jp tsushima.nagasaki.jp unzen.nagasaki.jp ando.nara.jp gose.nara.jp heguri.nara.jp higashiyoshino.nara.jp ikaruga.nara.jp ikoma.nara.jp kamikitayama.nara.jp kanmaki.nara.jp kashiba.nara.jp kashihara.nara.jp katsuragi.nara.jp kawai.nara.jp kawakami.nara.jp kawanishi.nara.jp koryo.nara.jp kurotaki.nara.jp mitsue.nara.jp miyake.nara.jp nara.nara.jp nosegawa.nara.jp oji.nara.jp ouda.nara.jp oyodo.nara.jp sakurai.nara.jp sango.nara.jp shimoichi.nara.jp shimokitayama.nara.jp shinjo.nara.jp soni.nara.jp takatori.nara.jp tawaramoto.nara.jp tenkawa.nara.jp tenri.nara.jp uda.nara.jp yamatokoriyama.nara.jp yamatotakada.nara.jp yamazoe.nara.jp yoshino.nara.jp aga.niigata.jp agano.niigata.jp gosen.niigata.jp itoigawa.niigata.jp izumozaki.niigata.jp joetsu.niigata.jp kamo.niigata.jp kariwa.niigata.jp kashiwazaki.niigata.jp minamiuonuma.niigata.jp mitsuke.niigata.jp muika.niigata.jp murakami.niigata.jp myoko.niigata.jp nagaoka.niigata.jp niigata.niigata.jp ojiya.niigata.jp omi.niigata.jp sado.niigata.jp sanjo.niigata.jp seiro.niigata.jp seirou.niigata.jp sekikawa.niigata.jp shibata.niigata.jp tagami.niigata.jp tainai.niigata.jp tochio.niigata.jp tokamachi.niigata.jp tsubame.niigata.jp tsunan.niigata.jp uonuma.niigata.jp yahiko.niigata.jp yoita.niigata.jp yuzawa.niigata.jp beppu.oita.jp bungoono.oita.jp bungotakada.oita.jp hasama.oita.jp hiji.oita.jp himeshima.oita.jp hita.oita.jp kamitsue.oita.jp kokonoe.oita.jp kuju.oita.jp kunisaki.oita.jp kusu.oita.jp oita.oita.jp saiki.oita.jp taketa.oita.jp tsukumi.oita.jp usa.oita.jp usuki.oita.jp yufu.oita.jp akaiwa.okayama.jp asakuchi.okayama.jp bizen.okayama.jp hayashima.okayama.jp ibara.okayama.jp kagamino.okayama.jp kasaoka.okayama.jp kibichuo.okayama.jp kumenan.okayama.jp kurashiki.okayama.jp maniwa.okayama.jp misaki.okayama.jp nagi.okayama.jp niimi.okayama.jp nishiawakura.okayama.jp okayama.okayama.jp satosho.okayama.jp setouchi.okayama.jp shinjo.okayama.jp shoo.okayama.jp soja.okayama.jp takahashi.okayama.jp tamano.okayama.jp tsuyama.okayama.jp wake.okayama.jp yakage.okayama.jp aguni.okinawa.jp ginowan.okinawa.jp ginoza.okinawa.jp gushikami.okinawa.jp haebaru.okinawa.jp higashi.okinawa.jp hirara.okinawa.jp iheya.okinawa.jp ishigaki.okinawa.jp ishikawa.okinawa.jp itoman.okinawa.jp izena.okinawa.jp kadena.okinawa.jp kin.okinawa.jp kitadaito.okinawa.jp kitanakagusuku.okinawa.jp kumejima.okinawa.jp kunigami.okinawa.jp minamidaito.okinawa.jp motobu.okinawa.jp nago.okinawa.jp naha.okinawa.jp nakagusuku.okinawa.jp nakijin.okinawa.jp nanjo.okinawa.jp nishihara.okinawa.jp ogimi.okinawa.jp okinawa.okinawa.jp onna.okinawa.jp shimoji.okinawa.jp taketomi.okinawa.jp tarama.okinawa.jp tokashiki.okinawa.jp tomigusuku.okinawa.jp tonaki.okinawa.jp urasoe.okinawa.jp uruma.okinawa.jp yaese.okinawa.jp yomitan.okinawa.jp yonabaru.okinawa.jp yonaguni.okinawa.jp zamami.okinawa.jp abeno.osaka.jp chihayaakasaka.osaka.jp chuo.osaka.jp daito.osaka.jp fujiidera.osaka.jp habikino.osaka.jp hannan.osaka.jp higashiosaka.osaka.jp higashisumiyoshi.osaka.jp higashiyodogawa.osaka.jp hirakata.osaka.jp ibaraki.osaka.jp ikeda.osaka.jp izumi.osaka.jp izumiotsu.osaka.jp izumisano.osaka.jp kadoma.osaka.jp kaizuka.osaka.jp kanan.osaka.jp kashiwara.osaka.jp katano.osaka.jp kawachinagano.osaka.jp kishiwada.osaka.jp kita.osaka.jp kumatori.osaka.jp matsubara.osaka.jp minato.osaka.jp minoh.osaka.jp misaki.osaka.jp moriguchi.osaka.jp neyagawa.osaka.jp nishi.osaka.jp nose.osaka.jp osakasayama.osaka.jp sakai.osaka.jp sayama.osaka.jp sennan.osaka.jp settsu.osaka.jp shijonawate.osaka.jp shimamoto.osaka.jp suita.osaka.jp tadaoka.osaka.jp taishi.osaka.jp tajiri.osaka.jp takaishi.osaka.jp takatsuki.osaka.jp tondabayashi.osaka.jp toyonaka.osaka.jp toyono.osaka.jp yao.osaka.jp ariake.saga.jp arita.saga.jp fukudomi.saga.jp genkai.saga.jp hamatama.saga.jp hizen.saga.jp imari.saga.jp kamimine.saga.jp kanzaki.saga.jp karatsu.saga.jp kashima.saga.jp kitagata.saga.jp kitahata.saga.jp kiyama.saga.jp kouhoku.saga.jp kyuragi.saga.jp nishiarita.saga.jp ogi.saga.jp omachi.saga.jp ouchi.saga.jp saga.saga.jp shiroishi.saga.jp taku.saga.jp tara.saga.jp tosu.saga.jp yoshinogari.saga.jp arakawa.saitama.jp asaka.saitama.jp chichibu.saitama.jp fujimi.saitama.jp fujimino.saitama.jp fukaya.saitama.jp hanno.saitama.jp hanyu.saitama.jp hasuda.saitama.jp hatogaya.saitama.jp hatoyama.saitama.jp hidaka.saitama.jp higashichichibu.saitama.jp higashimatsuyama.saitama.jp honjo.saitama.jp ina.saitama.jp iruma.saitama.jp iwatsuki.saitama.jp kamiizumi.saitama.jp kamikawa.saitama.jp kamisato.saitama.jp kasukabe.saitama.jp kawagoe.saitama.jp kawaguchi.saitama.jp kawajima.saitama.jp kazo.saitama.jp kitamoto.saitama.jp koshigaya.saitama.jp kounosu.saitama.jp kuki.saitama.jp kumagaya.saitama.jp matsubushi.saitama.jp minano.saitama.jp misato.saitama.jp miyashiro.saitama.jp miyoshi.saitama.jp moroyama.saitama.jp nagatoro.saitama.jp namegawa.saitama.jp niiza.saitama.jp ogano.saitama.jp ogawa.saitama.jp ogose.saitama.jp okegawa.saitama.jp omiya.saitama.jp otaki.saitama.jp ranzan.saitama.jp ryokami.saitama.jp saitama.saitama.jp sakado.saitama.jp satte.saitama.jp sayama.saitama.jp shiki.saitama.jp shiraoka.saitama.jp soka.saitama.jp sugito.saitama.jp toda.saitama.jp tokigawa.saitama.jp tokorozawa.saitama.jp tsurugashima.saitama.jp urawa.saitama.jp warabi.saitama.jp yashio.saitama.jp yokoze.saitama.jp yono.saitama.jp yorii.saitama.jp yoshida.saitama.jp yoshikawa.saitama.jp yoshimi.saitama.jp aisho.shiga.jp gamo.shiga.jp higashiomi.shiga.jp hikone.shiga.jp koka.shiga.jp konan.shiga.jp kosei.shiga.jp koto.shiga.jp kusatsu.shiga.jp maibara.shiga.jp moriyama.shiga.jp nagahama.shiga.jp nishiazai.shiga.jp notogawa.shiga.jp omihachiman.shiga.jp otsu.shiga.jp ritto.shiga.jp ryuoh.shiga.jp takashima.shiga.jp takatsuki.shiga.jp torahime.shiga.jp toyosato.shiga.jp yasu.shiga.jp akagi.shimane.jp ama.shimane.jp gotsu.shimane.jp hamada.shimane.jp higashiizumo.shimane.jp hikawa.shimane.jp hikimi.shimane.jp izumo.shimane.jp kakinoki.shimane.jp masuda.shimane.jp matsue.shimane.jp misato.shimane.jp nishinoshima.shimane.jp ohda.shimane.jp okinoshima.shimane.jp okuizumo.shimane.jp shimane.shimane.jp tamayu.shimane.jp tsuwano.shimane.jp unnan.shimane.jp yakumo.shimane.jp yasugi.shimane.jp yatsuka.shimane.jp arai.shizuoka.jp atami.shizuoka.jp fuji.shizuoka.jp fujieda.shizuoka.jp fujikawa.shizuoka.jp fujinomiya.shizuoka.jp fukuroi.shizuoka.jp gotemba.shizuoka.jp haibara.shizuoka.jp hamamatsu.shizuoka.jp higashiizu.shizuoka.jp ito.shizuoka.jp iwata.shizuoka.jp izu.shizuoka.jp izunokuni.shizuoka.jp kakegawa.shizuoka.jp kannami.shizuoka.jp kawanehon.shizuoka.jp kawazu.shizuoka.jp kikugawa.shizuoka.jp kosai.shizuoka.jp makinohara.shizuoka.jp matsuzaki.shizuoka.jp minamiizu.shizuoka.jp mishima.shizuoka.jp morimachi.shizuoka.jp nishiizu.shizuoka.jp numazu.shizuoka.jp omaezaki.shizuoka.jp shimada.shizuoka.jp shimizu.shizuoka.jp shimoda.shizuoka.jp shizuoka.shizuoka.jp susono.shizuoka.jp yaizu.shizuoka.jp yoshida.shizuoka.jp ashikaga.tochigi.jp bato.tochigi.jp haga.tochigi.jp ichikai.tochigi.jp iwafune.tochigi.jp kaminokawa.tochigi.jp kanuma.tochigi.jp karasuyama.tochigi.jp kuroiso.tochigi.jp mashiko.tochigi.jp mibu.tochigi.jp moka.tochigi.jp motegi.tochigi.jp nasu.tochigi.jp nasushiobara.tochigi.jp nikko.tochigi.jp nishikata.tochigi.jp nogi.tochigi.jp ohira.tochigi.jp ohtawara.tochigi.jp oyama.tochigi.jp sakura.tochigi.jp sano.tochigi.jp shimotsuke.tochigi.jp shioya.tochigi.jp takanezawa.tochigi.jp tochigi.tochigi.jp tsuga.tochigi.jp ujiie.tochigi.jp utsunomiya.tochigi.jp yaita.tochigi.jp aizumi.tokushima.jp anan.tokushima.jp ichiba.tokushima.jp itano.tokushima.jp kainan.tokushima.jp komatsushima.tokushima.jp matsushige.tokushima.jp mima.tokushima.jp minami.tokushima.jp miyoshi.tokushima.jp mugi.tokushima.jp nakagawa.tokushima.jp naruto.tokushima.jp sanagochi.tokushima.jp shishikui.tokushima.jp tokushima.tokushima.jp wajiki.tokushima.jp adachi.tokyo.jp akiruno.tokyo.jp akishima.tokyo.jp aogashima.tokyo.jp arakawa.tokyo.jp bunkyo.tokyo.jp chiyoda.tokyo.jp chofu.tokyo.jp chuo.tokyo.jp edogawa.tokyo.jp fuchu.tokyo.jp fussa.tokyo.jp hachijo.tokyo.jp hachioji.tokyo.jp hamura.tokyo.jp higashikurume.tokyo.jp higashimurayama.tokyo.jp higashiyamato.tokyo.jp hino.tokyo.jp hinode.tokyo.jp hinohara.tokyo.jp inagi.tokyo.jp itabashi.tokyo.jp katsushika.tokyo.jp kita.tokyo.jp kiyose.tokyo.jp kodaira.tokyo.jp koganei.tokyo.jp kokubunji.tokyo.jp komae.tokyo.jp koto.tokyo.jp kouzushima.tokyo.jp kunitachi.tokyo.jp machida.tokyo.jp meguro.tokyo.jp minato.tokyo.jp mitaka.tokyo.jp mizuho.tokyo.jp musashimurayama.tokyo.jp musashino.tokyo.jp nakano.tokyo.jp nerima.tokyo.jp ogasawara.tokyo.jp okutama.tokyo.jp ome.tokyo.jp oshima.tokyo.jp ota.tokyo.jp setagaya.tokyo.jp shibuya.tokyo.jp shinagawa.tokyo.jp shinjuku.tokyo.jp suginami.tokyo.jp sumida.tokyo.jp tachikawa.tokyo.jp taito.tokyo.jp tama.tokyo.jp toshima.tokyo.jp chizu.tottori.jp hino.tottori.jp kawahara.tottori.jp koge.tottori.jp kotoura.tottori.jp misasa.tottori.jp nanbu.tottori.jp nichinan.tottori.jp sakaiminato.tottori.jp tottori.tottori.jp wakasa.tottori.jp yazu.tottori.jp yonago.tottori.jp asahi.toyama.jp fuchu.toyama.jp fukumitsu.toyama.jp funahashi.toyama.jp himi.toyama.jp imizu.toyama.jp inami.toyama.jp johana.toyama.jp kamiichi.toyama.jp kurobe.toyama.jp nakaniikawa.toyama.jp namerikawa.toyama.jp nanto.toyama.jp nyuzen.toyama.jp oyabe.toyama.jp taira.toyama.jp takaoka.toyama.jp tateyama.toyama.jp toga.toyama.jp tonami.toyama.jp toyama.toyama.jp unazuki.toyama.jp uozu.toyama.jp yamada.toyama.jp arida.wakayama.jp aridagawa.wakayama.jp gobo.wakayama.jp hashimoto.wakayama.jp hidaka.wakayama.jp hirogawa.wakayama.jp inami.wakayama.jp iwade.wakayama.jp kainan.wakayama.jp kamitonda.wakayama.jp katsuragi.wakayama.jp kimino.wakayama.jp kinokawa.wakayama.jp kitayama.wakayama.jp koya.wakayama.jp koza.wakayama.jp kozagawa.wakayama.jp kudoyama.wakayama.jp kushimoto.wakayama.jp mihama.wakayama.jp misato.wakayama.jp nachikatsuura.wakayama.jp shingu.wakayama.jp shirahama.wakayama.jp taiji.wakayama.jp tanabe.wakayama.jp wakayama.wakayama.jp yuasa.wakayama.jp yura.wakayama.jp asahi.yamagata.jp funagata.yamagata.jp higashine.yamagata.jp iide.yamagata.jp kahoku.yamagata.jp kaminoyama.yamagata.jp kaneyama.yamagata.jp kawanishi.yamagata.jp mamurogawa.yamagata.jp mikawa.yamagata.jp murayama.yamagata.jp nagai.yamagata.jp nakayama.yamagata.jp nanyo.yamagata.jp nishikawa.yamagata.jp obanazawa.yamagata.jp oe.yamagata.jp oguni.yamagata.jp ohkura.yamagata.jp oishida.yamagata.jp sagae.yamagata.jp sakata.yamagata.jp sakegawa.yamagata.jp shinjo.yamagata.jp shirataka.yamagata.jp shonai.yamagata.jp takahata.yamagata.jp tendo.yamagata.jp tozawa.yamagata.jp tsuruoka.yamagata.jp yamagata.yamagata.jp yamanobe.yamagata.jp yonezawa.yamagata.jp yuza.yamagata.jp abu.yamaguchi.jp hagi.yamaguchi.jp hikari.yamaguchi.jp hofu.yamaguchi.jp iwakuni.yamaguchi.jp kudamatsu.yamaguchi.jp mitou.yamaguchi.jp nagato.yamaguchi.jp oshima.yamaguchi.jp shimonoseki.yamaguchi.jp shunan.yamaguchi.jp tabuse.yamaguchi.jp tokuyama.yamaguchi.jp toyota.yamaguchi.jp ube.yamaguchi.jp yuu.yamaguchi.jp chuo.yamanashi.jp doshi.yamanashi.jp fuefuki.yamanashi.jp fujikawa.yamanashi.jp fujikawaguchiko.yamanashi.jp fujiyoshida.yamanashi.jp hayakawa.yamanashi.jp hokuto.yamanashi.jp ichikawamisato.yamanashi.jp kai.yamanashi.jp kofu.yamanashi.jp koshu.yamanashi.jp kosuge.yamanashi.jp minami-alps.yamanashi.jp minobu.yamanashi.jp nakamichi.yamanashi.jp nanbu.yamanashi.jp narusawa.yamanashi.jp nirasaki.yamanashi.jp nishikatsura.yamanashi.jp oshino.yamanashi.jp otsuki.yamanashi.jp showa.yamanashi.jp tabayama.yamanashi.jp tsuru.yamanashi.jp uenohara.yamanashi.jp yamanakako.yamanashi.jp yamanashi.yamanashi.jp // ke : http://www.kenic.or.ke/index.php/en/ke-domains/ke-domains ke ac.ke co.ke go.ke info.ke me.ke mobi.ke ne.ke or.ke sc.ke // kg : http://www.domain.kg/dmn_n.html kg com.kg edu.kg gov.kg mil.kg net.kg org.kg // kh : http://www.mptc.gov.kh/dns_registration.htm *.kh // ki : https://www.iana.org/domains/root/db/ki.html ki biz.ki com.ki edu.ki gov.ki info.ki net.ki org.ki // km : https://www.iana.org/domains/root/db/km.html // http://www.domaine.km/documents/charte.doc km ass.km com.km edu.km gov.km mil.km nom.km org.km prd.km tm.km // These are only mentioned as proposed suggestions at domaine.km, but // https://www.iana.org/domains/root/db/km.html says they're available for registration: asso.km coop.km gouv.km medecin.km notaires.km pharmaciens.km presse.km veterinaire.km // kn : https://www.iana.org/domains/root/db/kn.html // http://www.dot.kn/domainRules.html kn edu.kn gov.kn net.kn org.kn // kp : http://www.kcce.kp/en_index.php kp com.kp edu.kp gov.kp org.kp rep.kp tra.kp // kr : https://www.iana.org/domains/root/db/kr.html // see also: https://krnic.kisa.or.kr/jsp/infoboard/law/domBylawsReg.jsp kr ac.kr ai.kr co.kr es.kr go.kr hs.kr io.kr it.kr kg.kr me.kr mil.kr ms.kr ne.kr or.kr pe.kr re.kr sc.kr // kr geographical names busan.kr chungbuk.kr chungnam.kr daegu.kr daejeon.kr gangwon.kr gwangju.kr gyeongbuk.kr gyeonggi.kr gyeongnam.kr incheon.kr jeju.kr jeonbuk.kr jeonnam.kr seoul.kr ulsan.kr // kw : https://www.nic.kw/policies/ // Confirmed by registry kw com.kw edu.kw emb.kw gov.kw ind.kw net.kw org.kw // ky : http://www.icta.ky/da_ky_reg_dom.php // Confirmed by registry 2008-06-17 ky com.ky edu.ky net.ky org.ky // kz : https://www.iana.org/domains/root/db/kz.html // see also: http://www.nic.kz/rules/index.jsp kz com.kz edu.kz gov.kz mil.kz net.kz org.kz // la : https://www.iana.org/domains/root/db/la.html // Submitted by registry la com.la edu.la gov.la info.la int.la net.la org.la per.la // lb : https://www.iana.org/domains/root/db/lb.html // Submitted by registry lb com.lb edu.lb gov.lb net.lb org.lb // lc : https://www.iana.org/domains/root/db/lc.html // see also: http://www.nic.lc/rules.htm lc co.lc com.lc edu.lc gov.lc net.lc org.lc // li : https://www.iana.org/domains/root/db/li.html li // lk : https://www.iana.org/domains/root/db/lk.html lk ac.lk assn.lk com.lk edu.lk gov.lk grp.lk hotel.lk int.lk ltd.lk net.lk ngo.lk org.lk sch.lk soc.lk web.lk // lr : http://psg.com/dns/lr/lr.txt // Submitted by registry lr com.lr edu.lr gov.lr net.lr org.lr // ls : http://www.nic.ls/ // Confirmed by registry ls ac.ls biz.ls co.ls edu.ls gov.ls info.ls net.ls org.ls sc.ls // lt : https://www.iana.org/domains/root/db/lt.html lt // gov.lt : http://www.gov.lt/index_en.php gov.lt // lu : http://www.dns.lu/en/ lu // lv : https://www.iana.org/domains/root/db/lv.html lv asn.lv com.lv conf.lv edu.lv gov.lv id.lv mil.lv net.lv org.lv // ly : http://www.nic.ly/regulations.php ly com.ly edu.ly gov.ly id.ly med.ly net.ly org.ly plc.ly sch.ly // ma : https://www.iana.org/domains/root/db/ma.html // http://www.anrt.ma/fr/admin/download/upload/file_fr782.pdf ma ac.ma co.ma gov.ma net.ma org.ma press.ma // mc : http://www.nic.mc/ mc asso.mc tm.mc // md : https://www.iana.org/domains/root/db/md.html md // me : https://www.iana.org/domains/root/db/me.html me ac.me co.me edu.me gov.me its.me net.me org.me priv.me // mg : https://nic.mg mg co.mg com.mg edu.mg gov.mg mil.mg nom.mg org.mg prd.mg // mh : https://www.iana.org/domains/root/db/mh.html mh // mil : https://www.iana.org/domains/root/db/mil.html mil // mk : https://www.iana.org/domains/root/db/mk.html // see also: http://dns.marnet.net.mk/postapka.php mk com.mk edu.mk gov.mk inf.mk name.mk net.mk org.mk // ml : https://www.iana.org/domains/root/db/ml.html // Confirmed by Boubacar NDIAYE 2024-12-31 ml ac.ml art.ml asso.ml com.ml edu.ml gouv.ml gov.ml info.ml inst.ml net.ml org.ml pr.ml presse.ml // mm : https://www.iana.org/domains/root/db/mm.html *.mm // mn : https://www.iana.org/domains/root/db/mn.html mn edu.mn gov.mn org.mn // mo : http://www.monic.net.mo/ mo com.mo edu.mo gov.mo net.mo org.mo // mobi : https://www.iana.org/domains/root/db/mobi.html mobi // mp : http://www.dot.mp/ // Confirmed by registry 2008-06-17 mp // mq : https://www.iana.org/domains/root/db/mq.html mq // mr : https://www.iana.org/domains/root/db/mr.html mr gov.mr // ms : https://www.iana.org/domains/root/db/ms.html ms com.ms edu.ms gov.ms net.ms org.ms // mt : https://www.nic.org.mt/go/policy // Submitted by registry mt com.mt edu.mt net.mt org.mt // mu : https://www.iana.org/domains/root/db/mu.html mu ac.mu co.mu com.mu gov.mu net.mu or.mu org.mu // museum : https://welcome.museum/wp-content/uploads/2018/05/20180525-Registration-Policy-MUSEUM-EN_VF-2.pdf https://welcome.museum/buy-your-dot-museum-2/ museum // mv : https://www.iana.org/domains/root/db/mv.html // "mv" included because, contra Wikipedia, google.mv exists. mv aero.mv biz.mv com.mv coop.mv edu.mv gov.mv info.mv int.mv mil.mv museum.mv name.mv net.mv org.mv pro.mv // mw : http://www.registrar.mw/ mw ac.mw biz.mw co.mw com.mw coop.mw edu.mw gov.mw int.mw net.mw org.mw // mx : http://www.nic.mx/ // Submitted by registry mx com.mx edu.mx gob.mx net.mx org.mx // my : http://www.mynic.my/ // Available strings: https://mynic.my/resources/domains/buying-a-domain/ my biz.my com.my edu.my gov.my mil.my name.my net.my org.my // mz : http://www.uem.mz/ // Submitted by registry mz ac.mz adv.mz co.mz edu.mz gov.mz mil.mz net.mz org.mz // na : http://www.na-nic.com.na/ na alt.na co.na com.na gov.na net.na org.na // name : http://www.nic.name/ // Regarding 2LDs: https://github.com/publicsuffix/list/issues/2306 name // nc : http://www.cctld.nc/ nc asso.nc nom.nc // ne : https://www.iana.org/domains/root/db/ne.html ne // net : https://www.iana.org/domains/root/db/net.html net // nf : https://www.iana.org/domains/root/db/nf.html nf arts.nf com.nf firm.nf info.nf net.nf other.nf per.nf rec.nf store.nf web.nf // ng : http://www.nira.org.ng/index.php/join-us/register-ng-domain/189-nira-slds ng com.ng edu.ng gov.ng i.ng mil.ng mobi.ng name.ng net.ng org.ng sch.ng // ni : http://www.nic.ni/ ni ac.ni biz.ni co.ni com.ni edu.ni gob.ni in.ni info.ni int.ni mil.ni net.ni nom.ni org.ni web.ni // nl : https://www.iana.org/domains/root/db/nl.html // https://www.sidn.nl/ nl // no : https://www.norid.no/en/om-domenenavn/regelverk-for-no/ // Norid geographical second level domains : https://www.norid.no/en/om-domenenavn/regelverk-for-no/vedlegg-b/ // Norid category second level domains : https://www.norid.no/en/om-domenenavn/regelverk-for-no/vedlegg-c/ // Norid category second-level domains managed by parties other than Norid : https://www.norid.no/en/om-domenenavn/regelverk-for-no/vedlegg-d/ // RSS feed: https://teknisk.norid.no/en/feed/ no // Norid category second level domains : https://www.norid.no/en/om-domenenavn/regelverk-for-no/vedlegg-c/ fhs.no folkebibl.no fylkesbibl.no idrett.no museum.no priv.no vgs.no // Norid category second-level domains managed by parties other than Norid : https://www.norid.no/en/om-domenenavn/regelverk-for-no/vedlegg-d/ dep.no herad.no kommune.no mil.no stat.no // Norid geographical second level domains : https://www.norid.no/en/om-domenenavn/regelverk-for-no/vedlegg-b/ // counties aa.no ah.no bu.no fm.no hl.no hm.no jan-mayen.no mr.no nl.no nt.no of.no ol.no oslo.no rl.no sf.no st.no svalbard.no tm.no tr.no va.no vf.no // primary and lower secondary schools per county gs.aa.no gs.ah.no gs.bu.no gs.fm.no gs.hl.no gs.hm.no gs.jan-mayen.no gs.mr.no gs.nl.no gs.nt.no gs.of.no gs.ol.no gs.oslo.no gs.rl.no gs.sf.no gs.st.no gs.svalbard.no gs.tm.no gs.tr.no gs.va.no gs.vf.no // cities akrehamn.no åkrehamn.no algard.no ålgård.no arna.no bronnoysund.no brønnøysund.no brumunddal.no bryne.no drobak.no drøbak.no egersund.no fetsund.no floro.no florø.no fredrikstad.no hokksund.no honefoss.no hønefoss.no jessheim.no jorpeland.no jørpeland.no kirkenes.no kopervik.no krokstadelva.no langevag.no langevåg.no leirvik.no mjondalen.no mjøndalen.no mo-i-rana.no mosjoen.no mosjøen.no nesoddtangen.no orkanger.no osoyro.no osøyro.no raholt.no råholt.no sandnessjoen.no sandnessjøen.no skedsmokorset.no slattum.no spjelkavik.no stathelle.no stavern.no stjordalshalsen.no stjørdalshalsen.no tananger.no tranby.no vossevangen.no // communities aarborte.no aejrie.no afjord.no åfjord.no agdenes.no nes.akershus.no aknoluokta.no ákŋoluokta.no al.no ål.no alaheadju.no álaheadju.no alesund.no ålesund.no alstahaug.no alta.no áltá.no alvdal.no amli.no åmli.no amot.no åmot.no andasuolo.no andebu.no andoy.no andøy.no ardal.no årdal.no aremark.no arendal.no ås.no aseral.no åseral.no asker.no askim.no askoy.no askøy.no askvoll.no asnes.no åsnes.no audnedaln.no aukra.no aure.no aurland.no aurskog-holand.no aurskog-høland.no austevoll.no austrheim.no averoy.no averøy.no badaddja.no bådåddjå.no bærum.no bahcavuotna.no báhcavuotna.no bahccavuotna.no báhccavuotna.no baidar.no báidár.no bajddar.no bájddar.no balat.no bálát.no balestrand.no ballangen.no balsfjord.no bamble.no bardu.no barum.no batsfjord.no båtsfjord.no bearalvahki.no bearalváhki.no beardu.no beiarn.no berg.no bergen.no berlevag.no berlevåg.no bievat.no bievát.no bindal.no birkenes.no bjarkoy.no bjarkøy.no bjerkreim.no bjugn.no bodo.no bodø.no bokn.no bomlo.no bømlo.no bremanger.no bronnoy.no brønnøy.no budejju.no nes.buskerud.no bygland.no bykle.no cahcesuolo.no čáhcesuolo.no davvenjarga.no davvenjárga.no davvesiida.no deatnu.no dielddanuorri.no divtasvuodna.no divttasvuotna.no donna.no dønna.no dovre.no drammen.no drangedal.no dyroy.no dyrøy.no eid.no eidfjord.no eidsberg.no eidskog.no eidsvoll.no eigersund.no elverum.no enebakk.no engerdal.no etne.no etnedal.no evenassi.no evenášši.no evenes.no evje-og-hornnes.no farsund.no fauske.no fedje.no fet.no finnoy.no finnøy.no fitjar.no fjaler.no fjell.no fla.no flå.no flakstad.no flatanger.no flekkefjord.no flesberg.no flora.no folldal.no forde.no førde.no forsand.no fosnes.no fræna.no frana.no frei.no frogn.no froland.no frosta.no froya.no frøya.no fuoisku.no fuossko.no fusa.no fyresdal.no gaivuotna.no gáivuotna.no galsa.no gálsá.no gamvik.no gangaviika.no gáŋgaviika.no gaular.no gausdal.no giehtavuoatna.no gildeskal.no gildeskål.no giske.no gjemnes.no gjerdrum.no gjerstad.no gjesdal.no gjovik.no gjøvik.no gloppen.no gol.no gran.no grane.no granvin.no gratangen.no grimstad.no grong.no grue.no gulen.no guovdageaidnu.no ha.no hå.no habmer.no hábmer.no hadsel.no hægebostad.no hagebostad.no halden.no halsa.no hamar.no hamaroy.no hammarfeasta.no hámmárfeasta.no hammerfest.no hapmir.no hápmir.no haram.no hareid.no harstad.no hasvik.no hattfjelldal.no haugesund.no os.hedmark.no valer.hedmark.no våler.hedmark.no hemne.no hemnes.no hemsedal.no hitra.no hjartdal.no hjelmeland.no hobol.no hobøl.no hof.no hol.no hole.no holmestrand.no holtalen.no holtålen.no os.hordaland.no hornindal.no horten.no hoyanger.no høyanger.no hoylandet.no høylandet.no hurdal.no hurum.no hvaler.no hyllestad.no ibestad.no inderoy.no inderøy.no iveland.no ivgu.no jevnaker.no jolster.no jølster.no jondal.no kafjord.no kåfjord.no karasjohka.no kárášjohka.no karasjok.no karlsoy.no karmoy.no karmøy.no kautokeino.no klabu.no klæbu.no klepp.no kongsberg.no kongsvinger.no kraanghke.no kråanghke.no kragero.no kragerø.no kristiansand.no kristiansund.no krodsherad.no krødsherad.no kvæfjord.no kvænangen.no kvafjord.no kvalsund.no kvam.no kvanangen.no kvinesdal.no kvinnherad.no kviteseid.no kvitsoy.no kvitsøy.no laakesvuemie.no lærdal.no lahppi.no láhppi.no lardal.no larvik.no lavagis.no lavangen.no leangaviika.no leaŋgaviika.no lebesby.no leikanger.no leirfjord.no leka.no leksvik.no lenvik.no lerdal.no lesja.no levanger.no lier.no lierne.no lillehammer.no lillesand.no lindas.no lindås.no lindesnes.no loabat.no loabát.no lodingen.no lødingen.no lom.no loppa.no lorenskog.no lørenskog.no loten.no løten.no lund.no lunner.no luroy.no lurøy.no luster.no lyngdal.no lyngen.no malatvuopmi.no málatvuopmi.no malselv.no målselv.no malvik.no mandal.no marker.no marnardal.no masfjorden.no masoy.no måsøy.no matta-varjjat.no mátta-várjjat.no meland.no meldal.no melhus.no meloy.no meløy.no meraker.no meråker.no midsund.no midtre-gauldal.no moareke.no moåreke.no modalen.no modum.no molde.no heroy.more-og-romsdal.no sande.more-og-romsdal.no herøy.møre-og-romsdal.no sande.møre-og-romsdal.no moskenes.no moss.no mosvik.no muosat.no muosát.no naamesjevuemie.no nååmesjevuemie.no nærøy.no namdalseid.no namsos.no namsskogan.no nannestad.no naroy.no narviika.no narvik.no naustdal.no navuotna.no návuotna.no nedre-eiker.no nesna.no nesodden.no nesseby.no nesset.no nissedal.no nittedal.no nord-aurdal.no nord-fron.no nord-odal.no norddal.no nordkapp.no bo.nordland.no bø.nordland.no heroy.nordland.no herøy.nordland.no nordre-land.no nordreisa.no nore-og-uvdal.no notodden.no notteroy.no nøtterøy.no odda.no oksnes.no øksnes.no omasvuotna.no oppdal.no oppegard.no oppegård.no orkdal.no orland.no ørland.no orskog.no ørskog.no orsta.no ørsta.no osen.no osteroy.no osterøy.no valer.ostfold.no våler.østfold.no ostre-toten.no østre-toten.no overhalla.no ovre-eiker.no øvre-eiker.no oyer.no øyer.no oygarden.no øygarden.no oystre-slidre.no øystre-slidre.no porsanger.no porsangu.no porsáŋgu.no porsgrunn.no rade.no råde.no radoy.no radøy.no rælingen.no rahkkeravju.no ráhkkerávju.no raisa.no ráisa.no rakkestad.no ralingen.no rana.no randaberg.no rauma.no rendalen.no rennebu.no rennesoy.no rennesøy.no rindal.no ringebu.no ringerike.no ringsaker.no risor.no risør.no rissa.no roan.no rodoy.no rødøy.no rollag.no romsa.no romskog.no rømskog.no roros.no røros.no rost.no røst.no royken.no røyken.no royrvik.no røyrvik.no ruovat.no rygge.no salangen.no salat.no sálat.no sálát.no saltdal.no samnanger.no sandefjord.no sandnes.no sandoy.no sandøy.no sarpsborg.no sauda.no sauherad.no sel.no selbu.no selje.no seljord.no siellak.no sigdal.no siljan.no sirdal.no skanit.no skánit.no skanland.no skånland.no skaun.no skedsmo.no ski.no skien.no skierva.no skiervá.no skiptvet.no skjak.no skjåk.no skjervoy.no skjervøy.no skodje.no smola.no smøla.no snaase.no snåase.no snasa.no snåsa.no snillfjord.no snoasa.no sogndal.no sogne.no søgne.no sokndal.no sola.no solund.no somna.no sømna.no sondre-land.no søndre-land.no songdalen.no sor-aurdal.no sør-aurdal.no sor-fron.no sør-fron.no sor-odal.no sør-odal.no sor-varanger.no sør-varanger.no sorfold.no sørfold.no sorreisa.no sørreisa.no sortland.no sorum.no sørum.no spydeberg.no stange.no stavanger.no steigen.no steinkjer.no stjordal.no stjørdal.no stokke.no stor-elvdal.no stord.no stordal.no storfjord.no strand.no stranda.no stryn.no sula.no suldal.no sund.no sunndal.no surnadal.no sveio.no svelvik.no sykkylven.no tana.no bo.telemark.no bø.telemark.no time.no tingvoll.no tinn.no tjeldsund.no tjome.no tjøme.no tokke.no tolga.no tonsberg.no tønsberg.no torsken.no træna.no trana.no tranoy.no tranøy.no troandin.no trogstad.no trøgstad.no tromsa.no tromso.no tromsø.no trondheim.no trysil.no tvedestrand.no tydal.no tynset.no tysfjord.no tysnes.no tysvær.no tysvar.no ullensaker.no ullensvang.no ulvik.no unjarga.no unjárga.no utsira.no vaapste.no vadso.no vadsø.no værøy.no vaga.no vågå.no vagan.no vågan.no vagsoy.no vågsøy.no vaksdal.no valle.no vang.no vanylven.no vardo.no vardø.no varggat.no várggát.no varoy.no vefsn.no vega.no vegarshei.no vegårshei.no vennesla.no verdal.no verran.no vestby.no sande.vestfold.no vestnes.no vestre-slidre.no vestre-toten.no vestvagoy.no vestvågøy.no vevelstad.no vik.no vikna.no vindafjord.no voagat.no volda.no voss.no // np : http://www.mos.com.np/register.html *.np // nr : http://cenpac.net.nr/dns/index.html // Submitted by registry nr biz.nr com.nr edu.nr gov.nr info.nr net.nr org.nr // nu : https://www.iana.org/domains/root/db/nu.html nu // nz : https://www.iana.org/domains/root/db/nz.html // Submitted by registry nz ac.nz co.nz cri.nz geek.nz gen.nz govt.nz health.nz iwi.nz kiwi.nz maori.nz māori.nz mil.nz net.nz org.nz parliament.nz school.nz // om : https://www.iana.org/domains/root/db/om.html om co.om com.om edu.om gov.om med.om museum.om net.om org.om pro.om // onion : https://tools.ietf.org/html/rfc7686 onion // org : https://www.iana.org/domains/root/db/org.html org // pa : http://www.nic.pa/ // Some additional second level "domains" resolve directly as hostnames, such as // pannet.pa, so we add a rule for "pa". pa abo.pa ac.pa com.pa edu.pa gob.pa ing.pa med.pa net.pa nom.pa org.pa sld.pa // pe : https://www.nic.pe/InformeFinalComision.pdf pe com.pe edu.pe gob.pe mil.pe net.pe nom.pe org.pe // pf : http://www.gobin.info/domainname/formulaire-pf.pdf pf com.pf edu.pf org.pf // pg : https://www.iana.org/domains/root/db/pg.html *.pg // ph : https://www.iana.org/domains/root/db/ph.html // Submitted by registry ph com.ph edu.ph gov.ph i.ph mil.ph net.ph ngo.ph org.ph // pk : https://pk5.pknic.net.pk/pk5/msgNamepk.PK // Contact Email: staff@pknic.net.pk pk ac.pk biz.pk com.pk edu.pk fam.pk gkp.pk gob.pk gog.pk gok.pk gop.pk gos.pk gov.pk net.pk org.pk web.pk // pl : https://www.dns.pl/en/ // Confirmed by registry 2024-11-18 pl com.pl net.pl org.pl // pl functional domains : https://www.dns.pl/en/list_of_functional_domain_names agro.pl aid.pl atm.pl auto.pl biz.pl edu.pl gmina.pl gsm.pl info.pl mail.pl media.pl miasta.pl mil.pl nieruchomosci.pl nom.pl pc.pl powiat.pl priv.pl realestate.pl rel.pl sex.pl shop.pl sklep.pl sos.pl szkola.pl targi.pl tm.pl tourism.pl travel.pl turystyka.pl // Government domains : https://www.dns.pl/informacje_o_rejestracji_domen_gov_pl // In accordance with the .gov.pl Domain Name Regulations : https://www.dns.pl/regulamin_gov_pl gov.pl ap.gov.pl griw.gov.pl ic.gov.pl is.gov.pl kmpsp.gov.pl konsulat.gov.pl kppsp.gov.pl kwp.gov.pl kwpsp.gov.pl mup.gov.pl mw.gov.pl oia.gov.pl oirm.gov.pl oke.gov.pl oow.gov.pl oschr.gov.pl oum.gov.pl pa.gov.pl pinb.gov.pl piw.gov.pl po.gov.pl pr.gov.pl psp.gov.pl psse.gov.pl pup.gov.pl rzgw.gov.pl sa.gov.pl sdn.gov.pl sko.gov.pl so.gov.pl sr.gov.pl starostwo.gov.pl ug.gov.pl ugim.gov.pl um.gov.pl umig.gov.pl upow.gov.pl uppo.gov.pl us.gov.pl uw.gov.pl uzs.gov.pl wif.gov.pl wiih.gov.pl winb.gov.pl wios.gov.pl witd.gov.pl wiw.gov.pl wkz.gov.pl wsa.gov.pl wskr.gov.pl wsse.gov.pl wuoz.gov.pl wzmiuw.gov.pl zp.gov.pl zpisdn.gov.pl // pl regional domains : https://www.dns.pl/en/list_of_regional_domain_names augustow.pl babia-gora.pl bedzin.pl beskidy.pl bialowieza.pl bialystok.pl bielawa.pl bieszczady.pl boleslawiec.pl bydgoszcz.pl bytom.pl cieszyn.pl czeladz.pl czest.pl dlugoleka.pl elblag.pl elk.pl glogow.pl gniezno.pl gorlice.pl grajewo.pl ilawa.pl jaworzno.pl jelenia-gora.pl jgora.pl kalisz.pl karpacz.pl kartuzy.pl kaszuby.pl katowice.pl kazimierz-dolny.pl kepno.pl ketrzyn.pl klodzko.pl kobierzyce.pl kolobrzeg.pl konin.pl konskowola.pl kutno.pl lapy.pl lebork.pl legnica.pl lezajsk.pl limanowa.pl lomza.pl lowicz.pl lubin.pl lukow.pl malbork.pl malopolska.pl mazowsze.pl mazury.pl mielec.pl mielno.pl mragowo.pl naklo.pl nowaruda.pl nysa.pl olawa.pl olecko.pl olkusz.pl olsztyn.pl opoczno.pl opole.pl ostroda.pl ostroleka.pl ostrowiec.pl ostrowwlkp.pl pila.pl pisz.pl podhale.pl podlasie.pl polkowice.pl pomorskie.pl pomorze.pl prochowice.pl pruszkow.pl przeworsk.pl pulawy.pl radom.pl rawa-maz.pl rybnik.pl rzeszow.pl sanok.pl sejny.pl skoczow.pl slask.pl slupsk.pl sosnowiec.pl stalowa-wola.pl starachowice.pl stargard.pl suwalki.pl swidnica.pl swiebodzin.pl swinoujscie.pl szczecin.pl szczytno.pl tarnobrzeg.pl tgory.pl turek.pl tychy.pl ustka.pl walbrzych.pl warmia.pl warszawa.pl waw.pl wegrow.pl wielun.pl wlocl.pl wloclawek.pl wodzislaw.pl wolomin.pl wroclaw.pl zachpomor.pl zagan.pl zarow.pl zgora.pl zgorzelec.pl // pm : https://www.afnic.fr/wp-media/uploads/2022/12/afnic-naming-policy-2023-01-01.pdf pm // pn : https://www.iana.org/domains/root/db/pn.html pn co.pn edu.pn gov.pn net.pn org.pn // post : https://www.iana.org/domains/root/db/post.html post // pr : http://www.nic.pr/index.asp?f=1 pr biz.pr com.pr edu.pr gov.pr info.pr isla.pr name.pr net.pr org.pr pro.pr // these aren't mentioned on nic.pr, but on https://www.iana.org/domains/root/db/pr.html ac.pr est.pr prof.pr // pro : http://registry.pro/get-pro pro aaa.pro aca.pro acct.pro avocat.pro bar.pro cpa.pro eng.pro jur.pro law.pro med.pro recht.pro // ps : https://www.iana.org/domains/root/db/ps.html // http://www.nic.ps/registration/policy.html#reg ps com.ps edu.ps gov.ps net.ps org.ps plo.ps sec.ps // pt : https://www.dns.pt/en/domain/pt-terms-and-conditions-registration-rules/ pt com.pt edu.pt gov.pt int.pt net.pt nome.pt org.pt publ.pt // pw : https://www.iana.org/domains/root/db/pw.html // Confirmed by registry in private correspondence with @dnsguru 2024-12-09 pw gov.pw // py : https://www.iana.org/domains/root/db/py.html // Submitted by registry py com.py coop.py edu.py gov.py mil.py net.py org.py // qa : http://domains.qa/en/ qa com.qa edu.qa gov.qa mil.qa name.qa net.qa org.qa sch.qa // re : https://www.afnic.fr/wp-media/uploads/2022/12/afnic-naming-policy-2023-01-01.pdf // Confirmed by registry 2024-11-18 re // Closed for registration on 2013-03-15 but domains are still maintained asso.re com.re // ro : http://www.rotld.ro/ ro arts.ro com.ro firm.ro info.ro nom.ro nt.ro org.ro rec.ro store.ro tm.ro www.ro // rs : https://www.rnids.rs/en/domains/national-domains rs ac.rs co.rs edu.rs gov.rs in.rs org.rs // ru : https://cctld.ru/files/pdf/docs/en/rules_ru-rf.pdf // Submitted by George Georgievsky ru // rw : https://www.iana.org/domains/root/db/rw.html rw ac.rw co.rw coop.rw gov.rw mil.rw net.rw org.rw // sa : http://www.nic.net.sa/ sa com.sa edu.sa gov.sa med.sa net.sa org.sa pub.sa sch.sa // sb : http://www.sbnic.net.sb/ // Submitted by registry sb com.sb edu.sb gov.sb net.sb org.sb // sc : http://www.nic.sc/ sc com.sc edu.sc gov.sc net.sc org.sc // sd : https://www.iana.org/domains/root/db/sd.html // Submitted by registry sd com.sd edu.sd gov.sd info.sd med.sd net.sd org.sd tv.sd // se : https://www.iana.org/domains/root/db/se.html // https://data.internetstiftelsen.se/barred_domains_list.txt -> Second level domains & Sub-domains // Confirmed by Registry Services 2024-11-20 se a.se ac.se b.se bd.se brand.se c.se d.se e.se f.se fh.se fhsk.se fhv.se g.se h.se i.se k.se komforb.se kommunalforbund.se komvux.se l.se lanbib.se m.se n.se naturbruksgymn.se o.se org.se p.se parti.se pp.se press.se r.se s.se t.se tm.se u.se w.se x.se y.se z.se // sg : https://www.sgnic.sg/domain-registration/sg-categories-rules // Confirmed by registry 2024-11-19 sg com.sg edu.sg gov.sg net.sg org.sg // sh : http://nic.sh/rules.htm sh com.sh gov.sh mil.sh net.sh org.sh // si : https://www.iana.org/domains/root/db/si.html si // sj : No registrations at this time. // Submitted by registry sj // sk : https://www.iana.org/domains/root/db/sk.html sk // sl : http://www.nic.sl // Submitted by registry sl com.sl edu.sl gov.sl net.sl org.sl // sm : https://www.iana.org/domains/root/db/sm.html sm // sn : https://www.iana.org/domains/root/db/sn.html sn art.sn com.sn edu.sn gouv.sn org.sn perso.sn univ.sn // so : http://sonic.so/policies/ so com.so edu.so gov.so me.so net.so org.so // sr : https://www.iana.org/domains/root/db/sr.html sr // ss : https://registry.nic.ss/ // Submitted by registry ss biz.ss co.ss com.ss edu.ss gov.ss me.ss net.ss org.ss sch.ss // st : http://www.nic.st/html/policyrules/ st co.st com.st consulado.st edu.st embaixada.st mil.st net.st org.st principe.st saotome.st store.st // su : https://www.iana.org/domains/root/db/su.html su // sv : https://www.iana.org/domains/root/db/sv.html sv com.sv edu.sv gob.sv org.sv red.sv // sx : https://www.iana.org/domains/root/db/sx.html // Submitted by registry sx gov.sx // sy : https://www.iana.org/domains/root/db/sy.html sy com.sy edu.sy gov.sy mil.sy net.sy org.sy // sz : https://www.iana.org/domains/root/db/sz.html // http://www.sispa.org.sz/ sz ac.sz co.sz org.sz // tc : https://www.iana.org/domains/root/db/tc.html tc // td : https://www.iana.org/domains/root/db/td.html td // tel : https://www.iana.org/domains/root/db/tel.html // http://www.telnic.org/ tel // tf : https://www.afnic.fr/wp-media/uploads/2022/12/afnic-naming-policy-2023-01-01.pdf tf // tg : https://www.iana.org/domains/root/db/tg.html // http://www.nic.tg/ tg // th : https://www.iana.org/domains/root/db/th.html // Submitted by registry th ac.th co.th go.th in.th mi.th net.th or.th // tj : http://www.nic.tj/policy.html tj ac.tj biz.tj co.tj com.tj edu.tj go.tj gov.tj int.tj mil.tj name.tj net.tj nic.tj org.tj test.tj web.tj // tk : https://www.iana.org/domains/root/db/tk.html tk // tl : https://www.iana.org/domains/root/db/tl.html tl gov.tl // tm : https://www.nic.tm/local.html // Confirmed by registry 2024-11-19 tm co.tm com.tm edu.tm gov.tm mil.tm net.tm nom.tm org.tm // tn : http://www.registre.tn/fr/ // https://whois.ati.tn/ tn com.tn ens.tn fin.tn gov.tn ind.tn info.tn intl.tn mincom.tn nat.tn net.tn org.tn perso.tn tourism.tn // to : https://www.iana.org/domains/root/db/to.html // Submitted by registry to com.to edu.to gov.to mil.to net.to org.to // tr : https://nic.tr/ // https://nic.tr/forms/eng/policies.pdf // https://nic.tr/index.php?USRACTN=PRICELST tr av.tr bbs.tr bel.tr biz.tr com.tr dr.tr edu.tr gen.tr gov.tr info.tr k12.tr kep.tr mil.tr name.tr net.tr org.tr pol.tr tel.tr tsk.tr tv.tr web.tr // Used by Northern Cyprus nc.tr // Used by government agencies of Northern Cyprus gov.nc.tr // tt : https://www.nic.tt/ // Confirmed by registry 2024-11-19 tt biz.tt co.tt com.tt edu.tt gov.tt info.tt mil.tt name.tt net.tt org.tt pro.tt // tv : https://www.iana.org/domains/root/db/tv.html // Not listing any 2LDs as reserved since none seem to exist in practice, // Wikipedia notwithstanding. tv // tw : https://www.iana.org/domains/root/db/tw.html // https://twnic.tw/dnservice_catag.php // Confirmed by registry 2024-11-26 tw club.tw com.tw ebiz.tw edu.tw game.tw gov.tw idv.tw mil.tw net.tw org.tw // tz : http://www.tznic.or.tz/index.php/domains // Submitted by registry tz ac.tz co.tz go.tz hotel.tz info.tz me.tz mil.tz mobi.tz ne.tz or.tz sc.tz tv.tz // ua : https://hostmaster.ua/policy/?ua // Submitted by registry ua // ua 2LD com.ua edu.ua gov.ua in.ua net.ua org.ua // ua geographic names // https://hostmaster.ua/2ld/ cherkassy.ua cherkasy.ua chernigov.ua chernihiv.ua chernivtsi.ua chernovtsy.ua ck.ua cn.ua cr.ua crimea.ua cv.ua dn.ua dnepropetrovsk.ua dnipropetrovsk.ua donetsk.ua dp.ua if.ua ivano-frankivsk.ua kh.ua kharkiv.ua kharkov.ua kherson.ua khmelnitskiy.ua khmelnytskyi.ua kiev.ua kirovograd.ua km.ua kr.ua kropyvnytskyi.ua krym.ua ks.ua kv.ua kyiv.ua lg.ua lt.ua lugansk.ua luhansk.ua lutsk.ua lv.ua lviv.ua mk.ua mykolaiv.ua nikolaev.ua od.ua odesa.ua odessa.ua pl.ua poltava.ua rivne.ua rovno.ua rv.ua sb.ua sebastopol.ua sevastopol.ua sm.ua sumy.ua te.ua ternopil.ua uz.ua uzhgorod.ua uzhhorod.ua vinnica.ua vinnytsia.ua vn.ua volyn.ua yalta.ua zakarpattia.ua zaporizhzhe.ua zaporizhzhia.ua zhitomir.ua zhytomyr.ua zp.ua zt.ua // ug : https://www.registry.co.ug/ // https://www.registry.co.ug, https://whois.co.ug // Confirmed by registry 2025-01-20 ug ac.ug co.ug com.ug edu.ug go.ug gov.ug mil.ug ne.ug or.ug org.ug sc.ug us.ug // uk : https://www.iana.org/domains/root/db/uk.html // Submitted by registry uk ac.uk co.uk gov.uk ltd.uk me.uk net.uk nhs.uk org.uk plc.uk police.uk *.sch.uk // us : https://www.iana.org/domains/root/db/us.html // Confirmed via the .us zone file by William Harrison 2024-12-10 us dni.us isa.us nsn.us // Geographic Names ak.us al.us ar.us as.us az.us ca.us co.us ct.us dc.us de.us fl.us ga.us gu.us hi.us ia.us id.us il.us in.us ks.us ky.us la.us ma.us md.us me.us mi.us mn.us mo.us ms.us mt.us nc.us nd.us ne.us nh.us nj.us nm.us nv.us ny.us oh.us ok.us or.us pa.us pr.us ri.us sc.us sd.us tn.us tx.us ut.us va.us vi.us vt.us wa.us wi.us wv.us wy.us // The registrar notes several more specific domains available in each state, // such as state.*.us, dst.*.us, etc., but resolution of these is somewhat // haphazard; in some states these domains resolve as addresses, while in others // only subdomains are available, or even nothing at all. We include the // most common ones where it's clear that different sites are different // entities. k12.ak.us k12.al.us k12.ar.us k12.as.us k12.az.us k12.ca.us k12.co.us k12.ct.us k12.dc.us k12.fl.us k12.ga.us k12.gu.us // k12.hi.us - Bug 614565 - Hawaii has a state-wide DOE login k12.ia.us k12.id.us k12.il.us k12.in.us k12.ks.us k12.ky.us k12.la.us k12.ma.us k12.md.us k12.me.us k12.mi.us k12.mn.us k12.mo.us k12.ms.us k12.mt.us k12.nc.us // k12.nd.us - Bug 1028347 - Removed at request of Travis Rosso k12.ne.us k12.nh.us k12.nj.us k12.nm.us k12.nv.us k12.ny.us k12.oh.us k12.ok.us k12.or.us k12.pa.us k12.pr.us // k12.ri.us - Removed at request of Kim Cournoyer k12.sc.us // k12.sd.us - Bug 934131 - Removed at request of James Booze k12.tn.us k12.tx.us k12.ut.us k12.va.us k12.vi.us k12.vt.us k12.wa.us k12.wi.us // k12.wv.us - Bug 947705 - Removed at request of Verne Britton cc.ak.us lib.ak.us cc.al.us lib.al.us cc.ar.us lib.ar.us cc.as.us lib.as.us cc.az.us lib.az.us cc.ca.us lib.ca.us cc.co.us lib.co.us cc.ct.us lib.ct.us cc.dc.us lib.dc.us cc.de.us cc.fl.us lib.fl.us cc.ga.us lib.ga.us cc.gu.us lib.gu.us cc.hi.us lib.hi.us cc.ia.us lib.ia.us cc.id.us lib.id.us cc.il.us lib.il.us cc.in.us lib.in.us cc.ks.us lib.ks.us cc.ky.us lib.ky.us cc.la.us lib.la.us cc.ma.us lib.ma.us cc.md.us lib.md.us cc.me.us lib.me.us cc.mi.us lib.mi.us cc.mn.us lib.mn.us cc.mo.us lib.mo.us cc.ms.us cc.mt.us lib.mt.us cc.nc.us lib.nc.us cc.nd.us lib.nd.us cc.ne.us lib.ne.us cc.nh.us lib.nh.us cc.nj.us lib.nj.us cc.nm.us lib.nm.us cc.nv.us lib.nv.us cc.ny.us lib.ny.us cc.oh.us lib.oh.us cc.ok.us lib.ok.us cc.or.us lib.or.us cc.pa.us lib.pa.us cc.pr.us lib.pr.us cc.ri.us lib.ri.us cc.sc.us lib.sc.us cc.sd.us lib.sd.us cc.tn.us lib.tn.us cc.tx.us lib.tx.us cc.ut.us lib.ut.us cc.va.us lib.va.us cc.vi.us lib.vi.us cc.vt.us lib.vt.us cc.wa.us lib.wa.us cc.wi.us lib.wi.us cc.wv.us cc.wy.us k12.wy.us // lib.wv.us - Bug 941670 - Removed at request of Larry W Arnold lib.wy.us // k12.ma.us contains school districts in Massachusetts. The 4LDs are // managed independently except for private (PVT), charter (CHTR) and // parochial (PAROCH) schools. Those are delegated directly to the // 5LD operators. chtr.k12.ma.us paroch.k12.ma.us pvt.k12.ma.us // Merit Network, Inc. maintains the registry for =~ /(k12|cc|lib).mi.us/ and the following // see also: https://domreg.merit.edu : domreg@merit.edu // see also: whois -h whois.domreg.merit.edu help ann-arbor.mi.us cog.mi.us dst.mi.us eaton.mi.us gen.mi.us mus.mi.us tec.mi.us washtenaw.mi.us // uy : http://www.nic.org.uy/ uy com.uy edu.uy gub.uy mil.uy net.uy org.uy // uz : http://www.reg.uz/ uz co.uz com.uz net.uz org.uz // va : https://www.iana.org/domains/root/db/va.html va // vc : https://www.iana.org/domains/root/db/vc.html // Submitted by registry vc com.vc edu.vc gov.vc mil.vc net.vc org.vc // ve : https://registro.nic.ve/ // Submitted by registry nic@nic.ve and nicve@conatel.gob.ve ve arts.ve bib.ve co.ve com.ve e12.ve edu.ve emprende.ve firm.ve gob.ve gov.ve info.ve int.ve mil.ve net.ve nom.ve org.ve rar.ve rec.ve store.ve tec.ve web.ve // vg : https://www.iana.org/domains/root/db/vg.html // Confirmed by registry 2025-01-10 vg edu.vg // vi : https://www.iana.org/domains/root/db/vi.html vi co.vi com.vi k12.vi net.vi org.vi // vn : https://www.vnnic.vn/en/domain/cctld-vn // https://vnnic.vn/sites/default/files/tailieu/vn.cctld.domains.txt vn ac.vn ai.vn biz.vn com.vn edu.vn gov.vn health.vn id.vn info.vn int.vn io.vn name.vn net.vn org.vn pro.vn // vn geographical names angiang.vn bacgiang.vn backan.vn baclieu.vn bacninh.vn baria-vungtau.vn bentre.vn binhdinh.vn binhduong.vn binhphuoc.vn binhthuan.vn camau.vn cantho.vn caobang.vn daklak.vn daknong.vn danang.vn dienbien.vn dongnai.vn dongthap.vn gialai.vn hagiang.vn haiduong.vn haiphong.vn hanam.vn hanoi.vn hatinh.vn haugiang.vn hoabinh.vn hungyen.vn khanhhoa.vn kiengiang.vn kontum.vn laichau.vn lamdong.vn langson.vn laocai.vn longan.vn namdinh.vn nghean.vn ninhbinh.vn ninhthuan.vn phutho.vn phuyen.vn quangbinh.vn quangnam.vn quangngai.vn quangninh.vn quangtri.vn soctrang.vn sonla.vn tayninh.vn thaibinh.vn thainguyen.vn thanhhoa.vn thanhphohochiminh.vn thuathienhue.vn tiengiang.vn travinh.vn tuyenquang.vn vinhlong.vn vinhphuc.vn yenbai.vn // vu : https://www.iana.org/domains/root/db/vu.html // http://www.vunic.vu/ vu com.vu edu.vu net.vu org.vu // wf : https://www.afnic.fr/wp-media/uploads/2022/12/afnic-naming-policy-2023-01-01.pdf wf // ws : https://www.iana.org/domains/root/db/ws.html // http://samoanic.ws/index.dhtml ws com.ws edu.ws gov.ws net.ws org.ws // yt : https://www.afnic.fr/wp-media/uploads/2022/12/afnic-naming-policy-2023-01-01.pdf yt // IDN ccTLDs // When submitting patches, please maintain a sort by ISO 3166 ccTLD, then // U-label, and follow this format: // // A-Label ("", [, variant info]) : // // [sponsoring org] // U-Label // xn--mgbaam7a8h ("Emerat", Arabic) : AE // http://nic.ae/english/arabicdomain/rules.jsp امارات // xn--y9a3aq ("hye", Armenian) : AM // ISOC AM (operated by .am Registry) հայ // xn--54b7fta0cc ("Bangla", Bangla) : BD বাংলা // xn--90ae ("bg", Bulgarian) : BG бг // xn--mgbcpq6gpa1a ("albahrain", Arabic) : BH البحرين // xn--90ais ("bel", Belarusian/Russian Cyrillic) : BY // Operated by .by registry бел // xn--fiqs8s ("Zhongguo/China", Chinese, Simplified) : CN // CNNIC // https://www.cnnic.cn/11/192/index.html 中国 // xn--fiqz9s ("Zhongguo/China", Chinese, Traditional) : CN // CNNIC // https://www.cnnic.com.cn/AU/MediaC/Announcement/201609/t20160905_54470.htm 中國 // xn--lgbbat1ad8j ("Algeria/Al Jazair", Arabic) : DZ الجزائر // xn--wgbh1c ("Egypt/Masr", Arabic) : EG // http://www.dotmasr.eg/ مصر // xn--e1a4c ("eu", Cyrillic) : EU // https://eurid.eu ею // xn--qxa6a ("eu", Greek) : EU // https://eurid.eu ευ // xn--mgbah1a3hjkrd ("Mauritania", Arabic) : MR موريتانيا // xn--node ("ge", Georgian Mkhedruli) : GE გე // xn--qxam ("el", Greek) : GR // Hellenic Ministry of Infrastructure, Transport, and Networks ελ // xn--j6w193g ("Hong Kong", Chinese) : HK // https://www.hkirc.hk // Submitted by registry // https://www.hkirc.hk/content.jsp?id=30#!/34 香港 個人.香港 公司.香港 政府.香港 教育.香港 組織.香港 網絡.香港 // xn--2scrj9c ("Bharat", Kannada) : IN // India ಭಾರತ // xn--3hcrj9c ("Bharat", Oriya) : IN // India ଭାରତ // xn--45br5cyl ("Bharatam", Assamese) : IN // India ভাৰত // xn--h2breg3eve ("Bharatam", Sanskrit) : IN // India भारतम् // xn--h2brj9c8c ("Bharot", Santali) : IN // India भारोत // xn--mgbgu82a ("Bharat", Sindhi) : IN // India ڀارت // xn--rvc1e0am3e ("Bharatam", Malayalam) : IN // India ഭാരതം // xn--h2brj9c ("Bharat", Devanagari) : IN // India भारत // xn--mgbbh1a ("Bharat", Kashmiri) : IN // India بارت // xn--mgbbh1a71e ("Bharat", Arabic) : IN // India بھارت // xn--fpcrj9c3d ("Bharat", Telugu) : IN // India భారత్ // xn--gecrj9c ("Bharat", Gujarati) : IN // India ભારત // xn--s9brj9c ("Bharat", Gurmukhi) : IN // India ਭਾਰਤ // xn--45brj9c ("Bharat", Bengali) : IN // India ভারত // xn--xkc2dl3a5ee0h ("India", Tamil) : IN // India இந்தியா // xn--mgba3a4f16a ("Iran", Persian) : IR ایران // xn--mgba3a4fra ("Iran", Arabic) : IR ايران // xn--mgbtx2b ("Iraq", Arabic) : IQ // Communications and Media Commission عراق // xn--mgbayh7gpa ("al-Ordon", Arabic) : JO // National Information Technology Center (NITC) // Royal Scientific Society, Al-Jubeiha الاردن // xn--3e0b707e ("Republic of Korea", Hangul) : KR 한국 // xn--80ao21a ("Kaz", Kazakh) : KZ қаз // xn--q7ce6a ("Lao", Lao) : LA ລາວ // xn--fzc2c9e2c ("Lanka", Sinhalese-Sinhala) : LK // https://nic.lk ලංකා // xn--xkc2al3hye2a ("Ilangai", Tamil) : LK // https://nic.lk இலங்கை // xn--mgbc0a9azcg ("Morocco/al-Maghrib", Arabic) : MA المغرب // xn--d1alf ("mkd", Macedonian) : MK // MARnet мкд // xn--l1acc ("mon", Mongolian) : MN мон // xn--mix891f ("Macao", Chinese, Traditional) : MO // MONIC / HNET Asia (Registry Operator for .mo) 澳門 // xn--mix082f ("Macao", Chinese, Simplified) : MO 澳门 // xn--mgbx4cd0ab ("Malaysia", Malay) : MY مليسيا // xn--mgb9awbf ("Oman", Arabic) : OM عمان // xn--mgbai9azgqp6j ("Pakistan", Urdu/Arabic) : PK پاکستان // xn--mgbai9a5eva00b ("Pakistan", Urdu/Arabic, variant) : PK پاكستان // xn--ygbi2ammx ("Falasteen", Arabic) : PS // The Palestinian National Internet Naming Authority (PNINA) // http://www.pnina.ps فلسطين // xn--90a3ac ("srb", Cyrillic) : RS // https://www.rnids.rs/en/domains/national-domains срб ак.срб обр.срб од.срб орг.срб пр.срб упр.срб // xn--p1ai ("rf", Russian-Cyrillic) : RU // https://cctld.ru/files/pdf/docs/en/rules_ru-rf.pdf // Submitted by George Georgievsky рф // xn--wgbl6a ("Qatar", Arabic) : QA // http://www.ict.gov.qa/ قطر // xn--mgberp4a5d4ar ("AlSaudiah", Arabic) : SA // http://www.nic.net.sa/ السعودية // xn--mgberp4a5d4a87g ("AlSaudiah", Arabic, variant): SA السعودیة // xn--mgbqly7c0a67fbc ("AlSaudiah", Arabic, variant) : SA السعودیۃ // xn--mgbqly7cvafr ("AlSaudiah", Arabic, variant) : SA السعوديه // xn--mgbpl2fh ("sudan", Arabic) : SD // Operated by .sd registry سودان // xn--yfro4i67o Singapore ("Singapore", Chinese) : SG 新加坡 // xn--clchc0ea0b2g2a9gcd ("Singapore", Tamil) : SG சிங்கப்பூர் // xn--ogbpf8fl ("Syria", Arabic) : SY سورية // xn--mgbtf8fl ("Syria", Arabic, variant) : SY سوريا // xn--o3cw4h ("Thai", Thai) : TH // http://www.thnic.co.th ไทย ทหาร.ไทย ธุรกิจ.ไทย เน็ต.ไทย รัฐบาล.ไทย ศึกษา.ไทย องค์กร.ไทย // xn--pgbs0dh ("Tunisia", Arabic) : TN // http://nic.tn تونس // xn--kpry57d ("Taiwan", Chinese, Traditional) : TW // https://twnic.tw/dnservice_catag.php 台灣 // xn--kprw13d ("Taiwan", Chinese, Simplified) : TW // http://www.twnic.net/english/dn/dn_07a.htm 台湾 // xn--nnx388a ("Taiwan", Chinese, variant) : TW 臺灣 // xn--j1amh ("ukr", Cyrillic) : UA укр // xn--mgb2ddes ("AlYemen", Arabic) : YE اليمن // xxx : http://icmregistry.com xxx // ye : http://www.y.net.ye/services/domain_name.htm ye com.ye edu.ye gov.ye mil.ye net.ye org.ye // za : https://www.iana.org/domains/root/db/za.html ac.za agric.za alt.za co.za edu.za gov.za grondar.za law.za mil.za net.za ngo.za nic.za nis.za nom.za org.za school.za tm.za web.za // zm : https://zicta.zm/ // Submitted by registry zm ac.zm biz.zm co.zm com.zm edu.zm gov.zm info.zm mil.zm net.zm org.zm sch.zm // zw : https://www.potraz.gov.zw/ // Confirmed by registry 2017-01-25 zw ac.zw co.zw gov.zw mil.zw org.zw // newGTLDs // List of new gTLDs imported from https://www.icann.org/resources/registries/gtlds/v2/gtlds.json on 2025-08-27T15:19:08Z // This list is auto-generated, don't edit it manually. // aaa : American Automobile Association, Inc. // https://www.iana.org/domains/root/db/aaa.html aaa // aarp : AARP // https://www.iana.org/domains/root/db/aarp.html aarp // abb : ABB Ltd // https://www.iana.org/domains/root/db/abb.html abb // abbott : Abbott Laboratories, Inc. // https://www.iana.org/domains/root/db/abbott.html abbott // abbvie : AbbVie Inc. // https://www.iana.org/domains/root/db/abbvie.html abbvie // abc : Disney Enterprises, Inc. // https://www.iana.org/domains/root/db/abc.html abc // able : Able Inc. // https://www.iana.org/domains/root/db/able.html able // abogado : Registry Services, LLC // https://www.iana.org/domains/root/db/abogado.html abogado // abudhabi : Abu Dhabi Systems and Information Centre // https://www.iana.org/domains/root/db/abudhabi.html abudhabi // academy : Binky Moon, LLC // https://www.iana.org/domains/root/db/academy.html academy // accenture : Accenture plc // https://www.iana.org/domains/root/db/accenture.html accenture // accountant : dot Accountant Limited // https://www.iana.org/domains/root/db/accountant.html accountant // accountants : Binky Moon, LLC // https://www.iana.org/domains/root/db/accountants.html accountants // aco : ACO Severin Ahlmann GmbH & Co. KG // https://www.iana.org/domains/root/db/aco.html aco // actor : Dog Beach, LLC // https://www.iana.org/domains/root/db/actor.html actor // ads : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/ads.html ads // adult : ICM Registry AD LLC // https://www.iana.org/domains/root/db/adult.html adult // aeg : Aktiebolaget Electrolux // https://www.iana.org/domains/root/db/aeg.html aeg // aetna : Aetna Life Insurance Company // https://www.iana.org/domains/root/db/aetna.html aetna // afl : Australian Football League // https://www.iana.org/domains/root/db/afl.html afl // africa : ZA Central Registry NPC trading as Registry.Africa // https://www.iana.org/domains/root/db/africa.html africa // agakhan : Fondation Aga Khan (Aga Khan Foundation) // https://www.iana.org/domains/root/db/agakhan.html agakhan // agency : Binky Moon, LLC // https://www.iana.org/domains/root/db/agency.html agency // aig : American International Group, Inc. // https://www.iana.org/domains/root/db/aig.html aig // airbus : Airbus S.A.S. // https://www.iana.org/domains/root/db/airbus.html airbus // airforce : Dog Beach, LLC // https://www.iana.org/domains/root/db/airforce.html airforce // airtel : Bharti Airtel Limited // https://www.iana.org/domains/root/db/airtel.html airtel // akdn : Fondation Aga Khan (Aga Khan Foundation) // https://www.iana.org/domains/root/db/akdn.html akdn // alibaba : Alibaba Group Holding Limited // https://www.iana.org/domains/root/db/alibaba.html alibaba // alipay : Alibaba Group Holding Limited // https://www.iana.org/domains/root/db/alipay.html alipay // allfinanz : Allfinanz Deutsche Vermögensberatung Aktiengesellschaft // https://www.iana.org/domains/root/db/allfinanz.html allfinanz // allstate : Allstate Fire and Casualty Insurance Company // https://www.iana.org/domains/root/db/allstate.html allstate // ally : Ally Financial Inc. // https://www.iana.org/domains/root/db/ally.html ally // alsace : Region Grand Est // https://www.iana.org/domains/root/db/alsace.html alsace // alstom : ALSTOM // https://www.iana.org/domains/root/db/alstom.html alstom // amazon : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/amazon.html amazon // americanexpress : American Express Travel Related Services Company, Inc. // https://www.iana.org/domains/root/db/americanexpress.html americanexpress // americanfamily : AmFam, Inc. // https://www.iana.org/domains/root/db/americanfamily.html americanfamily // amex : American Express Travel Related Services Company, Inc. // https://www.iana.org/domains/root/db/amex.html amex // amfam : AmFam, Inc. // https://www.iana.org/domains/root/db/amfam.html amfam // amica : Amica Mutual Insurance Company // https://www.iana.org/domains/root/db/amica.html amica // amsterdam : Gemeente Amsterdam // https://www.iana.org/domains/root/db/amsterdam.html amsterdam // analytics : Campus IP LLC // https://www.iana.org/domains/root/db/analytics.html analytics // android : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/android.html android // anquan : Beijing Qihu Keji Co., Ltd. // https://www.iana.org/domains/root/db/anquan.html anquan // anz : Australia and New Zealand Banking Group Limited // https://www.iana.org/domains/root/db/anz.html anz // aol : Yahoo Inc. // https://www.iana.org/domains/root/db/aol.html aol // apartments : Binky Moon, LLC // https://www.iana.org/domains/root/db/apartments.html apartments // app : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/app.html app // apple : Apple Inc. // https://www.iana.org/domains/root/db/apple.html apple // aquarelle : Aquarelle.com // https://www.iana.org/domains/root/db/aquarelle.html aquarelle // arab : League of Arab States // https://www.iana.org/domains/root/db/arab.html arab // aramco : Aramco Services Company // https://www.iana.org/domains/root/db/aramco.html aramco // archi : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/archi.html archi // army : Dog Beach, LLC // https://www.iana.org/domains/root/db/army.html army // art : UK Creative Ideas Limited // https://www.iana.org/domains/root/db/art.html art // arte : Association Relative à la Télévision Européenne G.E.I.E. // https://www.iana.org/domains/root/db/arte.html arte // asda : Asda Stores Limited // https://www.iana.org/domains/root/db/asda.html asda // associates : Binky Moon, LLC // https://www.iana.org/domains/root/db/associates.html associates // athleta : The Gap, Inc. // https://www.iana.org/domains/root/db/athleta.html athleta // attorney : Dog Beach, LLC // https://www.iana.org/domains/root/db/attorney.html attorney // auction : Dog Beach, LLC // https://www.iana.org/domains/root/db/auction.html auction // audi : AUDI Aktiengesellschaft // https://www.iana.org/domains/root/db/audi.html audi // audible : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/audible.html audible // audio : XYZ.COM LLC // https://www.iana.org/domains/root/db/audio.html audio // auspost : Australian Postal Corporation // https://www.iana.org/domains/root/db/auspost.html auspost // author : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/author.html author // auto : XYZ.COM LLC // https://www.iana.org/domains/root/db/auto.html auto // autos : XYZ.COM LLC // https://www.iana.org/domains/root/db/autos.html autos // aws : AWS Registry LLC // https://www.iana.org/domains/root/db/aws.html aws // axa : AXA Group Operations SAS // https://www.iana.org/domains/root/db/axa.html axa // azure : Microsoft Corporation // https://www.iana.org/domains/root/db/azure.html azure // baby : XYZ.COM LLC // https://www.iana.org/domains/root/db/baby.html baby // baidu : Baidu, Inc. // https://www.iana.org/domains/root/db/baidu.html baidu // banamex : Citigroup Inc. // https://www.iana.org/domains/root/db/banamex.html banamex // band : Dog Beach, LLC // https://www.iana.org/domains/root/db/band.html band // bank : fTLD Registry Services LLC // https://www.iana.org/domains/root/db/bank.html bank // bar : Punto 2012 Sociedad Anonima Promotora de Inversion de Capital Variable // https://www.iana.org/domains/root/db/bar.html bar // barcelona : Municipi de Barcelona // https://www.iana.org/domains/root/db/barcelona.html barcelona // barclaycard : Barclays Bank PLC // https://www.iana.org/domains/root/db/barclaycard.html barclaycard // barclays : Barclays Bank PLC // https://www.iana.org/domains/root/db/barclays.html barclays // barefoot : Gallo Vineyards, Inc. // https://www.iana.org/domains/root/db/barefoot.html barefoot // bargains : Binky Moon, LLC // https://www.iana.org/domains/root/db/bargains.html bargains // baseball : MLB Advanced Media DH, LLC // https://www.iana.org/domains/root/db/baseball.html baseball // basketball : Fédération Internationale de Basketball (FIBA) // https://www.iana.org/domains/root/db/basketball.html basketball // bauhaus : Werkhaus GmbH // https://www.iana.org/domains/root/db/bauhaus.html bauhaus // bayern : Bayern Connect GmbH // https://www.iana.org/domains/root/db/bayern.html bayern // bbc : British Broadcasting Corporation // https://www.iana.org/domains/root/db/bbc.html bbc // bbt : BB&T Corporation // https://www.iana.org/domains/root/db/bbt.html bbt // bbva : BANCO BILBAO VIZCAYA ARGENTARIA, S.A. // https://www.iana.org/domains/root/db/bbva.html bbva // bcg : The Boston Consulting Group, Inc. // https://www.iana.org/domains/root/db/bcg.html bcg // bcn : Municipi de Barcelona // https://www.iana.org/domains/root/db/bcn.html bcn // beats : Beats Electronics, LLC // https://www.iana.org/domains/root/db/beats.html beats // beauty : XYZ.COM LLC // https://www.iana.org/domains/root/db/beauty.html beauty // beer : Registry Services, LLC // https://www.iana.org/domains/root/db/beer.html beer // berlin : dotBERLIN GmbH & Co. KG // https://www.iana.org/domains/root/db/berlin.html berlin // best : BestTLD Pty Ltd // https://www.iana.org/domains/root/db/best.html best // bestbuy : BBY Solutions, Inc. // https://www.iana.org/domains/root/db/bestbuy.html bestbuy // bet : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/bet.html bet // bharti : Bharti Enterprises (Holding) Private Limited // https://www.iana.org/domains/root/db/bharti.html bharti // bible : American Bible Society // https://www.iana.org/domains/root/db/bible.html bible // bid : dot Bid Limited // https://www.iana.org/domains/root/db/bid.html bid // bike : Binky Moon, LLC // https://www.iana.org/domains/root/db/bike.html bike // bing : Microsoft Corporation // https://www.iana.org/domains/root/db/bing.html bing // bingo : Binky Moon, LLC // https://www.iana.org/domains/root/db/bingo.html bingo // bio : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/bio.html bio // black : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/black.html black // blackfriday : Registry Services, LLC // https://www.iana.org/domains/root/db/blackfriday.html blackfriday // blockbuster : Dish DBS Corporation // https://www.iana.org/domains/root/db/blockbuster.html blockbuster // blog : Knock Knock WHOIS There, LLC // https://www.iana.org/domains/root/db/blog.html blog // bloomberg : Bloomberg IP Holdings LLC // https://www.iana.org/domains/root/db/bloomberg.html bloomberg // blue : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/blue.html blue // bms : Bristol-Myers Squibb Company // https://www.iana.org/domains/root/db/bms.html bms // bmw : Bayerische Motoren Werke Aktiengesellschaft // https://www.iana.org/domains/root/db/bmw.html bmw // bnpparibas : BNP Paribas // https://www.iana.org/domains/root/db/bnpparibas.html bnpparibas // boats : XYZ.COM LLC // https://www.iana.org/domains/root/db/boats.html boats // boehringer : Boehringer Ingelheim International GmbH // https://www.iana.org/domains/root/db/boehringer.html boehringer // bofa : Bank of America Corporation // https://www.iana.org/domains/root/db/bofa.html bofa // bom : Núcleo de Informação e Coordenação do Ponto BR - NIC.br // https://www.iana.org/domains/root/db/bom.html bom // bond : ShortDot SA // https://www.iana.org/domains/root/db/bond.html bond // boo : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/boo.html boo // book : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/book.html book // booking : Booking.com B.V. // https://www.iana.org/domains/root/db/booking.html booking // bosch : Robert Bosch GMBH // https://www.iana.org/domains/root/db/bosch.html bosch // bostik : Bostik SA // https://www.iana.org/domains/root/db/bostik.html bostik // boston : Registry Services, LLC // https://www.iana.org/domains/root/db/boston.html boston // bot : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/bot.html bot // boutique : Binky Moon, LLC // https://www.iana.org/domains/root/db/boutique.html boutique // box : Intercap Registry Inc. // https://www.iana.org/domains/root/db/box.html box // bradesco : Banco Bradesco S.A. // https://www.iana.org/domains/root/db/bradesco.html bradesco // bridgestone : Bridgestone Corporation // https://www.iana.org/domains/root/db/bridgestone.html bridgestone // broadway : Celebrate Broadway, Inc. // https://www.iana.org/domains/root/db/broadway.html broadway // broker : Dog Beach, LLC // https://www.iana.org/domains/root/db/broker.html broker // brother : Brother Industries, Ltd. // https://www.iana.org/domains/root/db/brother.html brother // brussels : DNS.be vzw // https://www.iana.org/domains/root/db/brussels.html brussels // build : Plan Bee LLC // https://www.iana.org/domains/root/db/build.html build // builders : Binky Moon, LLC // https://www.iana.org/domains/root/db/builders.html builders // business : Binky Moon, LLC // https://www.iana.org/domains/root/db/business.html business // buy : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/buy.html buy // buzz : DOTSTRATEGY CO. // https://www.iana.org/domains/root/db/buzz.html buzz // bzh : Association www.bzh // https://www.iana.org/domains/root/db/bzh.html bzh // cab : Binky Moon, LLC // https://www.iana.org/domains/root/db/cab.html cab // cafe : Binky Moon, LLC // https://www.iana.org/domains/root/db/cafe.html cafe // cal : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/cal.html cal // call : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/call.html call // calvinklein : PVH gTLD Holdings LLC // https://www.iana.org/domains/root/db/calvinklein.html calvinklein // cam : Cam Connecting SARL // https://www.iana.org/domains/root/db/cam.html cam // camera : Binky Moon, LLC // https://www.iana.org/domains/root/db/camera.html camera // camp : Binky Moon, LLC // https://www.iana.org/domains/root/db/camp.html camp // canon : Canon Inc. // https://www.iana.org/domains/root/db/canon.html canon // capetown : ZA Central Registry NPC trading as ZA Central Registry // https://www.iana.org/domains/root/db/capetown.html capetown // capital : Binky Moon, LLC // https://www.iana.org/domains/root/db/capital.html capital // capitalone : Capital One Financial Corporation // https://www.iana.org/domains/root/db/capitalone.html capitalone // car : XYZ.COM LLC // https://www.iana.org/domains/root/db/car.html car // caravan : Caravan International, Inc. // https://www.iana.org/domains/root/db/caravan.html caravan // cards : Binky Moon, LLC // https://www.iana.org/domains/root/db/cards.html cards // care : Binky Moon, LLC // https://www.iana.org/domains/root/db/care.html care // career : dotCareer LLC // https://www.iana.org/domains/root/db/career.html career // careers : Binky Moon, LLC // https://www.iana.org/domains/root/db/careers.html careers // cars : XYZ.COM LLC // https://www.iana.org/domains/root/db/cars.html cars // casa : Registry Services, LLC // https://www.iana.org/domains/root/db/casa.html casa // case : Digity, LLC // https://www.iana.org/domains/root/db/case.html case // cash : Binky Moon, LLC // https://www.iana.org/domains/root/db/cash.html cash // casino : Binky Moon, LLC // https://www.iana.org/domains/root/db/casino.html casino // catering : Binky Moon, LLC // https://www.iana.org/domains/root/db/catering.html catering // catholic : Pontificium Consilium de Comunicationibus Socialibus (PCCS) (Pontifical Council for Social Communication) // https://www.iana.org/domains/root/db/catholic.html catholic // cba : COMMONWEALTH BANK OF AUSTRALIA // https://www.iana.org/domains/root/db/cba.html cba // cbn : The Christian Broadcasting Network, Inc. // https://www.iana.org/domains/root/db/cbn.html cbn // cbre : CBRE, Inc. // https://www.iana.org/domains/root/db/cbre.html cbre // center : Binky Moon, LLC // https://www.iana.org/domains/root/db/center.html center // ceo : XYZ.COM LLC // https://www.iana.org/domains/root/db/ceo.html ceo // cern : European Organization for Nuclear Research ("CERN") // https://www.iana.org/domains/root/db/cern.html cern // cfa : CFA Institute // https://www.iana.org/domains/root/db/cfa.html cfa // cfd : ShortDot SA // https://www.iana.org/domains/root/db/cfd.html cfd // chanel : Chanel International B.V. // https://www.iana.org/domains/root/db/chanel.html chanel // channel : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/channel.html channel // charity : Public Interest Registry // https://www.iana.org/domains/root/db/charity.html charity // chase : JPMorgan Chase Bank, National Association // https://www.iana.org/domains/root/db/chase.html chase // chat : Binky Moon, LLC // https://www.iana.org/domains/root/db/chat.html chat // cheap : Binky Moon, LLC // https://www.iana.org/domains/root/db/cheap.html cheap // chintai : CHINTAI Corporation // https://www.iana.org/domains/root/db/chintai.html chintai // christmas : XYZ.COM LLC // https://www.iana.org/domains/root/db/christmas.html christmas // chrome : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/chrome.html chrome // church : Binky Moon, LLC // https://www.iana.org/domains/root/db/church.html church // cipriani : Hotel Cipriani Srl // https://www.iana.org/domains/root/db/cipriani.html cipriani // circle : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/circle.html circle // cisco : Cisco Technology, Inc. // https://www.iana.org/domains/root/db/cisco.html cisco // citadel : Citadel Domain LLC // https://www.iana.org/domains/root/db/citadel.html citadel // citi : Citigroup Inc. // https://www.iana.org/domains/root/db/citi.html citi // citic : CITIC Group Corporation // https://www.iana.org/domains/root/db/citic.html citic // city : Binky Moon, LLC // https://www.iana.org/domains/root/db/city.html city // claims : Binky Moon, LLC // https://www.iana.org/domains/root/db/claims.html claims // cleaning : Binky Moon, LLC // https://www.iana.org/domains/root/db/cleaning.html cleaning // click : Waterford Limited // https://www.iana.org/domains/root/db/click.html click // clinic : Binky Moon, LLC // https://www.iana.org/domains/root/db/clinic.html clinic // clinique : The Estée Lauder Companies Inc. // https://www.iana.org/domains/root/db/clinique.html clinique // clothing : Binky Moon, LLC // https://www.iana.org/domains/root/db/clothing.html clothing // cloud : Aruba PEC S.p.A. // https://www.iana.org/domains/root/db/cloud.html cloud // club : Registry Services, LLC // https://www.iana.org/domains/root/db/club.html club // clubmed : Club Méditerranée S.A. // https://www.iana.org/domains/root/db/clubmed.html clubmed // coach : Binky Moon, LLC // https://www.iana.org/domains/root/db/coach.html coach // codes : Binky Moon, LLC // https://www.iana.org/domains/root/db/codes.html codes // coffee : Binky Moon, LLC // https://www.iana.org/domains/root/db/coffee.html coffee // college : XYZ.COM LLC // https://www.iana.org/domains/root/db/college.html college // cologne : dotKoeln GmbH // https://www.iana.org/domains/root/db/cologne.html cologne // commbank : COMMONWEALTH BANK OF AUSTRALIA // https://www.iana.org/domains/root/db/commbank.html commbank // community : Binky Moon, LLC // https://www.iana.org/domains/root/db/community.html community // company : Binky Moon, LLC // https://www.iana.org/domains/root/db/company.html company // compare : Registry Services, LLC // https://www.iana.org/domains/root/db/compare.html compare // computer : Binky Moon, LLC // https://www.iana.org/domains/root/db/computer.html computer // comsec : VeriSign, Inc. // https://www.iana.org/domains/root/db/comsec.html comsec // condos : Binky Moon, LLC // https://www.iana.org/domains/root/db/condos.html condos // construction : Binky Moon, LLC // https://www.iana.org/domains/root/db/construction.html construction // consulting : Dog Beach, LLC // https://www.iana.org/domains/root/db/consulting.html consulting // contact : Dog Beach, LLC // https://www.iana.org/domains/root/db/contact.html contact // contractors : Binky Moon, LLC // https://www.iana.org/domains/root/db/contractors.html contractors // cooking : Registry Services, LLC // https://www.iana.org/domains/root/db/cooking.html cooking // cool : Binky Moon, LLC // https://www.iana.org/domains/root/db/cool.html cool // corsica : Collectivité de Corse // https://www.iana.org/domains/root/db/corsica.html corsica // country : Internet Naming Company LLC // https://www.iana.org/domains/root/db/country.html country // coupon : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/coupon.html coupon // coupons : Binky Moon, LLC // https://www.iana.org/domains/root/db/coupons.html coupons // courses : Registry Services, LLC // https://www.iana.org/domains/root/db/courses.html courses // cpa : American Institute of Certified Public Accountants // https://www.iana.org/domains/root/db/cpa.html cpa // credit : Binky Moon, LLC // https://www.iana.org/domains/root/db/credit.html credit // creditcard : Binky Moon, LLC // https://www.iana.org/domains/root/db/creditcard.html creditcard // creditunion : DotCooperation LLC // https://www.iana.org/domains/root/db/creditunion.html creditunion // cricket : dot Cricket Limited // https://www.iana.org/domains/root/db/cricket.html cricket // crown : Crown Equipment Corporation // https://www.iana.org/domains/root/db/crown.html crown // crs : Federated Co-operatives Limited // https://www.iana.org/domains/root/db/crs.html crs // cruise : Viking River Cruises (Bermuda) Ltd. // https://www.iana.org/domains/root/db/cruise.html cruise // cruises : Binky Moon, LLC // https://www.iana.org/domains/root/db/cruises.html cruises // cuisinella : SCHMIDT GROUPE S.A.S. // https://www.iana.org/domains/root/db/cuisinella.html cuisinella // cymru : Nominet UK // https://www.iana.org/domains/root/db/cymru.html cymru // cyou : ShortDot SA // https://www.iana.org/domains/root/db/cyou.html cyou // dad : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/dad.html dad // dance : Dog Beach, LLC // https://www.iana.org/domains/root/db/dance.html dance // data : Dish DBS Corporation // https://www.iana.org/domains/root/db/data.html data // date : dot Date Limited // https://www.iana.org/domains/root/db/date.html date // dating : Binky Moon, LLC // https://www.iana.org/domains/root/db/dating.html dating // datsun : NISSAN MOTOR CO., LTD. // https://www.iana.org/domains/root/db/datsun.html datsun // day : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/day.html day // dclk : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/dclk.html dclk // dds : Registry Services, LLC // https://www.iana.org/domains/root/db/dds.html dds // deal : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/deal.html deal // dealer : Intercap Registry Inc. // https://www.iana.org/domains/root/db/dealer.html dealer // deals : Binky Moon, LLC // https://www.iana.org/domains/root/db/deals.html deals // degree : Dog Beach, LLC // https://www.iana.org/domains/root/db/degree.html degree // delivery : Binky Moon, LLC // https://www.iana.org/domains/root/db/delivery.html delivery // dell : Dell Inc. // https://www.iana.org/domains/root/db/dell.html dell // deloitte : Deloitte Touche Tohmatsu // https://www.iana.org/domains/root/db/deloitte.html deloitte // delta : Delta Air Lines, Inc. // https://www.iana.org/domains/root/db/delta.html delta // democrat : Dog Beach, LLC // https://www.iana.org/domains/root/db/democrat.html democrat // dental : Binky Moon, LLC // https://www.iana.org/domains/root/db/dental.html dental // dentist : Dog Beach, LLC // https://www.iana.org/domains/root/db/dentist.html dentist // desi // https://www.iana.org/domains/root/db/desi.html desi // design : Registry Services, LLC // https://www.iana.org/domains/root/db/design.html design // dev : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/dev.html dev // dhl : Deutsche Post AG // https://www.iana.org/domains/root/db/dhl.html dhl // diamonds : Binky Moon, LLC // https://www.iana.org/domains/root/db/diamonds.html diamonds // diet : XYZ.COM LLC // https://www.iana.org/domains/root/db/diet.html diet // digital : Binky Moon, LLC // https://www.iana.org/domains/root/db/digital.html digital // direct : Binky Moon, LLC // https://www.iana.org/domains/root/db/direct.html direct // directory : Binky Moon, LLC // https://www.iana.org/domains/root/db/directory.html directory // discount : Binky Moon, LLC // https://www.iana.org/domains/root/db/discount.html discount // discover : Discover Financial Services // https://www.iana.org/domains/root/db/discover.html discover // dish : Dish DBS Corporation // https://www.iana.org/domains/root/db/dish.html dish // diy : Internet Naming Company LLC // https://www.iana.org/domains/root/db/diy.html diy // dnp : Dai Nippon Printing Co., Ltd. // https://www.iana.org/domains/root/db/dnp.html dnp // docs : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/docs.html docs // doctor : Binky Moon, LLC // https://www.iana.org/domains/root/db/doctor.html doctor // dog : Binky Moon, LLC // https://www.iana.org/domains/root/db/dog.html dog // domains : Binky Moon, LLC // https://www.iana.org/domains/root/db/domains.html domains // dot : Dish DBS Corporation // https://www.iana.org/domains/root/db/dot.html dot // download : dot Support Limited // https://www.iana.org/domains/root/db/download.html download // drive : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/drive.html drive // dtv : Dish DBS Corporation // https://www.iana.org/domains/root/db/dtv.html dtv // dubai : Dubai Smart Government Department // https://www.iana.org/domains/root/db/dubai.html dubai // dunlop : The Goodyear Tire & Rubber Company // https://www.iana.org/domains/root/db/dunlop.html dunlop // dupont : DuPont Specialty Products USA, LLC // https://www.iana.org/domains/root/db/dupont.html dupont // durban : ZA Central Registry NPC trading as ZA Central Registry // https://www.iana.org/domains/root/db/durban.html durban // dvag : Deutsche Vermögensberatung Aktiengesellschaft DVAG // https://www.iana.org/domains/root/db/dvag.html dvag // dvr : DISH Technologies L.L.C. // https://www.iana.org/domains/root/db/dvr.html dvr // earth : Interlink Systems Innovation Institute K.K. // https://www.iana.org/domains/root/db/earth.html earth // eat : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/eat.html eat // eco : Big Room Inc. // https://www.iana.org/domains/root/db/eco.html eco // edeka : EDEKA Verband kaufmännischer Genossenschaften e.V. // https://www.iana.org/domains/root/db/edeka.html edeka // education : Binky Moon, LLC // https://www.iana.org/domains/root/db/education.html education // email : Binky Moon, LLC // https://www.iana.org/domains/root/db/email.html email // emerck : Merck KGaA // https://www.iana.org/domains/root/db/emerck.html emerck // energy : Binky Moon, LLC // https://www.iana.org/domains/root/db/energy.html energy // engineer : Dog Beach, LLC // https://www.iana.org/domains/root/db/engineer.html engineer // engineering : Binky Moon, LLC // https://www.iana.org/domains/root/db/engineering.html engineering // enterprises : Binky Moon, LLC // https://www.iana.org/domains/root/db/enterprises.html enterprises // epson : Seiko Epson Corporation // https://www.iana.org/domains/root/db/epson.html epson // equipment : Binky Moon, LLC // https://www.iana.org/domains/root/db/equipment.html equipment // ericsson : Telefonaktiebolaget L M Ericsson // https://www.iana.org/domains/root/db/ericsson.html ericsson // erni : ERNI Group Holding AG // https://www.iana.org/domains/root/db/erni.html erni // esq : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/esq.html esq // estate : Binky Moon, LLC // https://www.iana.org/domains/root/db/estate.html estate // eurovision : European Broadcasting Union (EBU) // https://www.iana.org/domains/root/db/eurovision.html eurovision // eus : Puntueus Fundazioa // https://www.iana.org/domains/root/db/eus.html eus // events : Binky Moon, LLC // https://www.iana.org/domains/root/db/events.html events // exchange : Binky Moon, LLC // https://www.iana.org/domains/root/db/exchange.html exchange // expert : Binky Moon, LLC // https://www.iana.org/domains/root/db/expert.html expert // exposed : Binky Moon, LLC // https://www.iana.org/domains/root/db/exposed.html exposed // express : Binky Moon, LLC // https://www.iana.org/domains/root/db/express.html express // extraspace : Extra Space Storage LLC // https://www.iana.org/domains/root/db/extraspace.html extraspace // fage : Fage International S.A. // https://www.iana.org/domains/root/db/fage.html fage // fail : Binky Moon, LLC // https://www.iana.org/domains/root/db/fail.html fail // fairwinds : FairWinds Partners, LLC // https://www.iana.org/domains/root/db/fairwinds.html fairwinds // faith : dot Faith Limited // https://www.iana.org/domains/root/db/faith.html faith // family : Dog Beach, LLC // https://www.iana.org/domains/root/db/family.html family // fan : Dog Beach, LLC // https://www.iana.org/domains/root/db/fan.html fan // fans : ZDNS International Limited // https://www.iana.org/domains/root/db/fans.html fans // farm : Binky Moon, LLC // https://www.iana.org/domains/root/db/farm.html farm // farmers : Farmers Insurance Exchange // https://www.iana.org/domains/root/db/farmers.html farmers // fashion : Registry Services, LLC // https://www.iana.org/domains/root/db/fashion.html fashion // fast : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/fast.html fast // fedex : Federal Express Corporation // https://www.iana.org/domains/root/db/fedex.html fedex // feedback : Top Level Spectrum, Inc. // https://www.iana.org/domains/root/db/feedback.html feedback // ferrari : Fiat Chrysler Automobiles N.V. // https://www.iana.org/domains/root/db/ferrari.html ferrari // ferrero : Ferrero Trading Lux S.A. // https://www.iana.org/domains/root/db/ferrero.html ferrero // fidelity : Fidelity Brokerage Services LLC // https://www.iana.org/domains/root/db/fidelity.html fidelity // fido : Rogers Communications Canada Inc. // https://www.iana.org/domains/root/db/fido.html fido // film : Motion Picture Domain Registry Pty Ltd // https://www.iana.org/domains/root/db/film.html film // final : Núcleo de Informação e Coordenação do Ponto BR - NIC.br // https://www.iana.org/domains/root/db/final.html final // finance : Binky Moon, LLC // https://www.iana.org/domains/root/db/finance.html finance // financial : Binky Moon, LLC // https://www.iana.org/domains/root/db/financial.html financial // fire : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/fire.html fire // firestone : Bridgestone Licensing Services, Inc // https://www.iana.org/domains/root/db/firestone.html firestone // firmdale : Firmdale Holdings Limited // https://www.iana.org/domains/root/db/firmdale.html firmdale // fish : Binky Moon, LLC // https://www.iana.org/domains/root/db/fish.html fish // fishing : Registry Services, LLC // https://www.iana.org/domains/root/db/fishing.html fishing // fit : Registry Services, LLC // https://www.iana.org/domains/root/db/fit.html fit // fitness : Binky Moon, LLC // https://www.iana.org/domains/root/db/fitness.html fitness // flickr : Flickr, Inc. // https://www.iana.org/domains/root/db/flickr.html flickr // flights : Binky Moon, LLC // https://www.iana.org/domains/root/db/flights.html flights // flir : FLIR Systems, Inc. // https://www.iana.org/domains/root/db/flir.html flir // florist : Binky Moon, LLC // https://www.iana.org/domains/root/db/florist.html florist // flowers : XYZ.COM LLC // https://www.iana.org/domains/root/db/flowers.html flowers // fly : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/fly.html fly // foo : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/foo.html foo // food : Internet Naming Company LLC // https://www.iana.org/domains/root/db/food.html food // football : Binky Moon, LLC // https://www.iana.org/domains/root/db/football.html football // ford : Ford Motor Company // https://www.iana.org/domains/root/db/ford.html ford // forex : Dog Beach, LLC // https://www.iana.org/domains/root/db/forex.html forex // forsale : Dog Beach, LLC // https://www.iana.org/domains/root/db/forsale.html forsale // forum : Waterford Limited // https://www.iana.org/domains/root/db/forum.html forum // foundation : Public Interest Registry // https://www.iana.org/domains/root/db/foundation.html foundation // fox : FOX Registry, LLC // https://www.iana.org/domains/root/db/fox.html fox // free : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/free.html free // fresenius : Fresenius Immobilien-Verwaltungs-GmbH // https://www.iana.org/domains/root/db/fresenius.html fresenius // frl : FRLregistry B.V. // https://www.iana.org/domains/root/db/frl.html frl // frogans : OP3FT // https://www.iana.org/domains/root/db/frogans.html frogans // frontier : Frontier Communications Corporation // https://www.iana.org/domains/root/db/frontier.html frontier // ftr : Frontier Communications Corporation // https://www.iana.org/domains/root/db/ftr.html ftr // fujitsu : Fujitsu Limited // https://www.iana.org/domains/root/db/fujitsu.html fujitsu // fun : Radix Technologies Inc SEZC // https://www.iana.org/domains/root/db/fun.html fun // fund : Binky Moon, LLC // https://www.iana.org/domains/root/db/fund.html fund // furniture : Binky Moon, LLC // https://www.iana.org/domains/root/db/furniture.html furniture // futbol : Dog Beach, LLC // https://www.iana.org/domains/root/db/futbol.html futbol // fyi : Binky Moon, LLC // https://www.iana.org/domains/root/db/fyi.html fyi // gal : Asociación puntoGAL // https://www.iana.org/domains/root/db/gal.html gal // gallery : Binky Moon, LLC // https://www.iana.org/domains/root/db/gallery.html gallery // gallo : Gallo Vineyards, Inc. // https://www.iana.org/domains/root/db/gallo.html gallo // gallup : Gallup, Inc. // https://www.iana.org/domains/root/db/gallup.html gallup // game : XYZ.COM LLC // https://www.iana.org/domains/root/db/game.html game // games : Dog Beach, LLC // https://www.iana.org/domains/root/db/games.html games // gap : The Gap, Inc. // https://www.iana.org/domains/root/db/gap.html gap // garden : Registry Services, LLC // https://www.iana.org/domains/root/db/garden.html garden // gay : Registry Services, LLC // https://www.iana.org/domains/root/db/gay.html gay // gbiz : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/gbiz.html gbiz // gdn : Joint Stock Company "Navigation-information systems" // https://www.iana.org/domains/root/db/gdn.html gdn // gea : GEA Group Aktiengesellschaft // https://www.iana.org/domains/root/db/gea.html gea // gent : Easyhost BV // https://www.iana.org/domains/root/db/gent.html gent // genting : Resorts World Inc Pte. Ltd. // https://www.iana.org/domains/root/db/genting.html genting // george : Wal-Mart Stores, Inc. // https://www.iana.org/domains/root/db/george.html george // ggee : GMO Internet, Inc. // https://www.iana.org/domains/root/db/ggee.html ggee // gift : DotGift, LLC // https://www.iana.org/domains/root/db/gift.html gift // gifts : Binky Moon, LLC // https://www.iana.org/domains/root/db/gifts.html gifts // gives : Public Interest Registry // https://www.iana.org/domains/root/db/gives.html gives // giving : Public Interest Registry // https://www.iana.org/domains/root/db/giving.html giving // glass : Binky Moon, LLC // https://www.iana.org/domains/root/db/glass.html glass // gle : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/gle.html gle // global : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/global.html global // globo : Globo Comunicação e Participações S.A // https://www.iana.org/domains/root/db/globo.html globo // gmail : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/gmail.html gmail // gmbh : Binky Moon, LLC // https://www.iana.org/domains/root/db/gmbh.html gmbh // gmo : GMO Internet, Inc. // https://www.iana.org/domains/root/db/gmo.html gmo // gmx : 1&1 Mail & Media GmbH // https://www.iana.org/domains/root/db/gmx.html gmx // godaddy : Go Daddy East, LLC // https://www.iana.org/domains/root/db/godaddy.html godaddy // gold : Binky Moon, LLC // https://www.iana.org/domains/root/db/gold.html gold // goldpoint : YODOBASHI CAMERA CO.,LTD. // https://www.iana.org/domains/root/db/goldpoint.html goldpoint // golf : Binky Moon, LLC // https://www.iana.org/domains/root/db/golf.html golf // goo : NTT DOCOMO, INC. // https://www.iana.org/domains/root/db/goo.html goo // goodyear : The Goodyear Tire & Rubber Company // https://www.iana.org/domains/root/db/goodyear.html goodyear // goog : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/goog.html goog // google : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/google.html google // gop : Republican State Leadership Committee, Inc. // https://www.iana.org/domains/root/db/gop.html gop // got : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/got.html got // grainger : Grainger Registry Services, LLC // https://www.iana.org/domains/root/db/grainger.html grainger // graphics : Binky Moon, LLC // https://www.iana.org/domains/root/db/graphics.html graphics // gratis : Binky Moon, LLC // https://www.iana.org/domains/root/db/gratis.html gratis // green : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/green.html green // gripe : Binky Moon, LLC // https://www.iana.org/domains/root/db/gripe.html gripe // grocery : Wal-Mart Stores, Inc. // https://www.iana.org/domains/root/db/grocery.html grocery // group : Binky Moon, LLC // https://www.iana.org/domains/root/db/group.html group // gucci : Guccio Gucci S.p.a. // https://www.iana.org/domains/root/db/gucci.html gucci // guge : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/guge.html guge // guide : Binky Moon, LLC // https://www.iana.org/domains/root/db/guide.html guide // guitars : XYZ.COM LLC // https://www.iana.org/domains/root/db/guitars.html guitars // guru : Binky Moon, LLC // https://www.iana.org/domains/root/db/guru.html guru // hair : XYZ.COM LLC // https://www.iana.org/domains/root/db/hair.html hair // hamburg : Hamburg Top-Level-Domain GmbH // https://www.iana.org/domains/root/db/hamburg.html hamburg // hangout : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/hangout.html hangout // haus : Dog Beach, LLC // https://www.iana.org/domains/root/db/haus.html haus // hbo : HBO Registry Services, Inc. // https://www.iana.org/domains/root/db/hbo.html hbo // hdfc : HDFC BANK LIMITED // https://www.iana.org/domains/root/db/hdfc.html hdfc // hdfcbank : HDFC BANK LIMITED // https://www.iana.org/domains/root/db/hdfcbank.html hdfcbank // health : Registry Services, LLC // https://www.iana.org/domains/root/db/health.html health // healthcare : Binky Moon, LLC // https://www.iana.org/domains/root/db/healthcare.html healthcare // help : Innovation service Limited // https://www.iana.org/domains/root/db/help.html help // helsinki : City of Helsinki // https://www.iana.org/domains/root/db/helsinki.html helsinki // here : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/here.html here // hermes : HERMES INTERNATIONAL // https://www.iana.org/domains/root/db/hermes.html hermes // hiphop : Dot Hip Hop, LLC // https://www.iana.org/domains/root/db/hiphop.html hiphop // hisamitsu : Hisamitsu Pharmaceutical Co.,Inc. // https://www.iana.org/domains/root/db/hisamitsu.html hisamitsu // hitachi : Hitachi, Ltd. // https://www.iana.org/domains/root/db/hitachi.html hitachi // hiv : Internet Naming Company LLC // https://www.iana.org/domains/root/db/hiv.html hiv // hkt : PCCW-HKT DataCom Services Limited // https://www.iana.org/domains/root/db/hkt.html hkt // hockey : Binky Moon, LLC // https://www.iana.org/domains/root/db/hockey.html hockey // holdings : Binky Moon, LLC // https://www.iana.org/domains/root/db/holdings.html holdings // holiday : Binky Moon, LLC // https://www.iana.org/domains/root/db/holiday.html holiday // homedepot : Home Depot Product Authority, LLC // https://www.iana.org/domains/root/db/homedepot.html homedepot // homegoods : The TJX Companies, Inc. // https://www.iana.org/domains/root/db/homegoods.html homegoods // homes : XYZ.COM LLC // https://www.iana.org/domains/root/db/homes.html homes // homesense : The TJX Companies, Inc. // https://www.iana.org/domains/root/db/homesense.html homesense // honda : Honda Motor Co., Ltd. // https://www.iana.org/domains/root/db/honda.html honda // horse : Registry Services, LLC // https://www.iana.org/domains/root/db/horse.html horse // hospital : Binky Moon, LLC // https://www.iana.org/domains/root/db/hospital.html hospital // host : Radix Technologies Inc SEZC // https://www.iana.org/domains/root/db/host.html host // hosting : XYZ.COM LLC // https://www.iana.org/domains/root/db/hosting.html hosting // hot : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/hot.html hot // hotel : HOTEL Top-Level-Domain S.a.r.l // https://www.iana.org/domains/root/db/hotel.html hotel // hotels : Booking.com B.V. // https://www.iana.org/domains/root/db/hotels.html hotels // hotmail : Microsoft Corporation // https://www.iana.org/domains/root/db/hotmail.html hotmail // house : Binky Moon, LLC // https://www.iana.org/domains/root/db/house.html house // how : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/how.html how // hsbc : HSBC Global Services (UK) Limited // https://www.iana.org/domains/root/db/hsbc.html hsbc // hughes : Hughes Satellite Systems Corporation // https://www.iana.org/domains/root/db/hughes.html hughes // hyatt : Hyatt GTLD, L.L.C. // https://www.iana.org/domains/root/db/hyatt.html hyatt // hyundai : Hyundai Motor Company // https://www.iana.org/domains/root/db/hyundai.html hyundai // ibm : International Business Machines Corporation // https://www.iana.org/domains/root/db/ibm.html ibm // icbc : Industrial and Commercial Bank of China Limited // https://www.iana.org/domains/root/db/icbc.html icbc // ice : IntercontinentalExchange, Inc. // https://www.iana.org/domains/root/db/ice.html ice // icu : ShortDot SA // https://www.iana.org/domains/root/db/icu.html icu // ieee : IEEE Global LLC // https://www.iana.org/domains/root/db/ieee.html ieee // ifm : ifm electronic gmbh // https://www.iana.org/domains/root/db/ifm.html ifm // ikano : Ikano S.A. // https://www.iana.org/domains/root/db/ikano.html ikano // imamat : Fondation Aga Khan (Aga Khan Foundation) // https://www.iana.org/domains/root/db/imamat.html imamat // imdb : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/imdb.html imdb // immo : Binky Moon, LLC // https://www.iana.org/domains/root/db/immo.html immo // immobilien : Dog Beach, LLC // https://www.iana.org/domains/root/db/immobilien.html immobilien // inc : Intercap Registry Inc. // https://www.iana.org/domains/root/db/inc.html inc // industries : Binky Moon, LLC // https://www.iana.org/domains/root/db/industries.html industries // infiniti : NISSAN MOTOR CO., LTD. // https://www.iana.org/domains/root/db/infiniti.html infiniti // ing : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/ing.html ing // ink : Registry Services, LLC // https://www.iana.org/domains/root/db/ink.html ink // institute : Binky Moon, LLC // https://www.iana.org/domains/root/db/institute.html institute // insurance : fTLD Registry Services LLC // https://www.iana.org/domains/root/db/insurance.html insurance // insure : Binky Moon, LLC // https://www.iana.org/domains/root/db/insure.html insure // international : Binky Moon, LLC // https://www.iana.org/domains/root/db/international.html international // intuit : Intuit Administrative Services, Inc. // https://www.iana.org/domains/root/db/intuit.html intuit // investments : Binky Moon, LLC // https://www.iana.org/domains/root/db/investments.html investments // ipiranga : Ipiranga Produtos de Petroleo S.A. // https://www.iana.org/domains/root/db/ipiranga.html ipiranga // irish : Binky Moon, LLC // https://www.iana.org/domains/root/db/irish.html irish // ismaili : Fondation Aga Khan (Aga Khan Foundation) // https://www.iana.org/domains/root/db/ismaili.html ismaili // ist : Istanbul Metropolitan Municipality // https://www.iana.org/domains/root/db/ist.html ist // istanbul : Istanbul Metropolitan Municipality // https://www.iana.org/domains/root/db/istanbul.html istanbul // itau : Itau Unibanco Holding S.A. // https://www.iana.org/domains/root/db/itau.html itau // itv : ITV Services Limited // https://www.iana.org/domains/root/db/itv.html itv // jaguar : Jaguar Land Rover Ltd // https://www.iana.org/domains/root/db/jaguar.html jaguar // java : Oracle Corporation // https://www.iana.org/domains/root/db/java.html java // jcb : JCB Co., Ltd. // https://www.iana.org/domains/root/db/jcb.html jcb // jeep : FCA US LLC. // https://www.iana.org/domains/root/db/jeep.html jeep // jetzt : Binky Moon, LLC // https://www.iana.org/domains/root/db/jetzt.html jetzt // jewelry : Binky Moon, LLC // https://www.iana.org/domains/root/db/jewelry.html jewelry // jio : Reliance Industries Limited // https://www.iana.org/domains/root/db/jio.html jio // jll : Jones Lang LaSalle Incorporated // https://www.iana.org/domains/root/db/jll.html jll // jmp : Matrix IP LLC // https://www.iana.org/domains/root/db/jmp.html jmp // jnj : Johnson & Johnson Services, Inc. // https://www.iana.org/domains/root/db/jnj.html jnj // joburg : ZA Central Registry NPC trading as ZA Central Registry // https://www.iana.org/domains/root/db/joburg.html joburg // jot : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/jot.html jot // joy : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/joy.html joy // jpmorgan : JPMorgan Chase Bank, National Association // https://www.iana.org/domains/root/db/jpmorgan.html jpmorgan // jprs : Japan Registry Services Co., Ltd. // https://www.iana.org/domains/root/db/jprs.html jprs // juegos : Dog Beach, LLC // https://www.iana.org/domains/root/db/juegos.html juegos // juniper : JUNIPER NETWORKS, INC. // https://www.iana.org/domains/root/db/juniper.html juniper // kaufen : Dog Beach, LLC // https://www.iana.org/domains/root/db/kaufen.html kaufen // kddi : KDDI CORPORATION // https://www.iana.org/domains/root/db/kddi.html kddi // kerryhotels : Kerry Trading Co. Limited // https://www.iana.org/domains/root/db/kerryhotels.html kerryhotels // kerryproperties : Kerry Trading Co. Limited // https://www.iana.org/domains/root/db/kerryproperties.html kerryproperties // kfh : Kuwait Finance House // https://www.iana.org/domains/root/db/kfh.html kfh // kia : KIA MOTORS CORPORATION // https://www.iana.org/domains/root/db/kia.html kia // kids : DotKids Foundation Limited // https://www.iana.org/domains/root/db/kids.html kids // kim : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/kim.html kim // kindle : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/kindle.html kindle // kitchen : Binky Moon, LLC // https://www.iana.org/domains/root/db/kitchen.html kitchen // kiwi : DOT KIWI LIMITED // https://www.iana.org/domains/root/db/kiwi.html kiwi // koeln : dotKoeln GmbH // https://www.iana.org/domains/root/db/koeln.html koeln // komatsu : Komatsu Ltd. // https://www.iana.org/domains/root/db/komatsu.html komatsu // kosher : Kosher Marketing Assets LLC // https://www.iana.org/domains/root/db/kosher.html kosher // kpmg : KPMG International Cooperative (KPMG International Genossenschaft) // https://www.iana.org/domains/root/db/kpmg.html kpmg // kpn : Koninklijke KPN N.V. // https://www.iana.org/domains/root/db/kpn.html kpn // krd : KRG Department of Information Technology // https://www.iana.org/domains/root/db/krd.html krd // kred : KredTLD Pty Ltd // https://www.iana.org/domains/root/db/kred.html kred // kuokgroup : Kerry Trading Co. Limited // https://www.iana.org/domains/root/db/kuokgroup.html kuokgroup // kyoto : Academic Institution: Kyoto Jyoho Gakuen // https://www.iana.org/domains/root/db/kyoto.html kyoto // lacaixa : Fundación Bancaria Caixa d’Estalvis i Pensions de Barcelona, “la Caixa” // https://www.iana.org/domains/root/db/lacaixa.html lacaixa // lamborghini : Automobili Lamborghini S.p.A. // https://www.iana.org/domains/root/db/lamborghini.html lamborghini // lamer : The Estée Lauder Companies Inc. // https://www.iana.org/domains/root/db/lamer.html lamer // land : Binky Moon, LLC // https://www.iana.org/domains/root/db/land.html land // landrover : Jaguar Land Rover Ltd // https://www.iana.org/domains/root/db/landrover.html landrover // lanxess : LANXESS Corporation // https://www.iana.org/domains/root/db/lanxess.html lanxess // lasalle : Jones Lang LaSalle Incorporated // https://www.iana.org/domains/root/db/lasalle.html lasalle // lat : XYZ.COM LLC // https://www.iana.org/domains/root/db/lat.html lat // latino : Dish DBS Corporation // https://www.iana.org/domains/root/db/latino.html latino // latrobe : La Trobe University // https://www.iana.org/domains/root/db/latrobe.html latrobe // law : Registry Services, LLC // https://www.iana.org/domains/root/db/law.html law // lawyer : Dog Beach, LLC // https://www.iana.org/domains/root/db/lawyer.html lawyer // lds : IRI Domain Management, LLC // https://www.iana.org/domains/root/db/lds.html lds // lease : Binky Moon, LLC // https://www.iana.org/domains/root/db/lease.html lease // leclerc : A.C.D. LEC Association des Centres Distributeurs Edouard Leclerc // https://www.iana.org/domains/root/db/leclerc.html leclerc // lefrak : LeFrak Organization, Inc. // https://www.iana.org/domains/root/db/lefrak.html lefrak // legal : Binky Moon, LLC // https://www.iana.org/domains/root/db/legal.html legal // lego : LEGO Juris A/S // https://www.iana.org/domains/root/db/lego.html lego // lexus : TOYOTA MOTOR CORPORATION // https://www.iana.org/domains/root/db/lexus.html lexus // lgbt : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/lgbt.html lgbt // lidl : Schwarz Domains und Services GmbH & Co. KG // https://www.iana.org/domains/root/db/lidl.html lidl // life : Binky Moon, LLC // https://www.iana.org/domains/root/db/life.html life // lifeinsurance : American Council of Life Insurers // https://www.iana.org/domains/root/db/lifeinsurance.html lifeinsurance // lifestyle : Internet Naming Company LLC // https://www.iana.org/domains/root/db/lifestyle.html lifestyle // lighting : Binky Moon, LLC // https://www.iana.org/domains/root/db/lighting.html lighting // like : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/like.html like // lilly : Eli Lilly and Company // https://www.iana.org/domains/root/db/lilly.html lilly // limited : Binky Moon, LLC // https://www.iana.org/domains/root/db/limited.html limited // limo : Binky Moon, LLC // https://www.iana.org/domains/root/db/limo.html limo // lincoln : Ford Motor Company // https://www.iana.org/domains/root/db/lincoln.html lincoln // link : Nova Registry Ltd // https://www.iana.org/domains/root/db/link.html link // live : Dog Beach, LLC // https://www.iana.org/domains/root/db/live.html live // living : Internet Naming Company LLC // https://www.iana.org/domains/root/db/living.html living // llc : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/llc.html llc // llp : Intercap Registry Inc. // https://www.iana.org/domains/root/db/llp.html llp // loan : dot Loan Limited // https://www.iana.org/domains/root/db/loan.html loan // loans : Binky Moon, LLC // https://www.iana.org/domains/root/db/loans.html loans // locker : Orange Domains LLC // https://www.iana.org/domains/root/db/locker.html locker // locus : Locus Analytics LLC // https://www.iana.org/domains/root/db/locus.html locus // lol : XYZ.COM LLC // https://www.iana.org/domains/root/db/lol.html lol // london : Dot London Domains Limited // https://www.iana.org/domains/root/db/london.html london // lotte : Lotte Holdings Co., Ltd. // https://www.iana.org/domains/root/db/lotte.html lotte // lotto : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/lotto.html lotto // love : Waterford Limited // https://www.iana.org/domains/root/db/love.html love // lpl : LPL Holdings, Inc. // https://www.iana.org/domains/root/db/lpl.html lpl // lplfinancial : LPL Holdings, Inc. // https://www.iana.org/domains/root/db/lplfinancial.html lplfinancial // ltd : Binky Moon, LLC // https://www.iana.org/domains/root/db/ltd.html ltd // ltda : InterNetX, Corp // https://www.iana.org/domains/root/db/ltda.html ltda // lundbeck : H. Lundbeck A/S // https://www.iana.org/domains/root/db/lundbeck.html lundbeck // luxe : Registry Services, LLC // https://www.iana.org/domains/root/db/luxe.html luxe // luxury : Luxury Partners, LLC // https://www.iana.org/domains/root/db/luxury.html luxury // madrid : Comunidad de Madrid // https://www.iana.org/domains/root/db/madrid.html madrid // maif : Mutuelle Assurance Instituteur France (MAIF) // https://www.iana.org/domains/root/db/maif.html maif // maison : Binky Moon, LLC // https://www.iana.org/domains/root/db/maison.html maison // makeup : XYZ.COM LLC // https://www.iana.org/domains/root/db/makeup.html makeup // man : MAN Truck & Bus SE // https://www.iana.org/domains/root/db/man.html man // management : Binky Moon, LLC // https://www.iana.org/domains/root/db/management.html management // mango : PUNTO FA S.L. // https://www.iana.org/domains/root/db/mango.html mango // map : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/map.html map // market : Dog Beach, LLC // https://www.iana.org/domains/root/db/market.html market // marketing : Binky Moon, LLC // https://www.iana.org/domains/root/db/marketing.html marketing // markets : Dog Beach, LLC // https://www.iana.org/domains/root/db/markets.html markets // marriott : Marriott Worldwide Corporation // https://www.iana.org/domains/root/db/marriott.html marriott // marshalls : The TJX Companies, Inc. // https://www.iana.org/domains/root/db/marshalls.html marshalls // mattel : Mattel IT Services, Inc. // https://www.iana.org/domains/root/db/mattel.html mattel // mba : Binky Moon, LLC // https://www.iana.org/domains/root/db/mba.html mba // mckinsey : McKinsey Holdings, Inc. // https://www.iana.org/domains/root/db/mckinsey.html mckinsey // med : Medistry LLC // https://www.iana.org/domains/root/db/med.html med // media : Binky Moon, LLC // https://www.iana.org/domains/root/db/media.html media // meet : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/meet.html meet // melbourne : The Crown in right of the State of Victoria, represented by its Department of State Development, Business and Innovation // https://www.iana.org/domains/root/db/melbourne.html melbourne // meme : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/meme.html meme // memorial : Dog Beach, LLC // https://www.iana.org/domains/root/db/memorial.html memorial // men : Exclusive Registry Limited // https://www.iana.org/domains/root/db/men.html men // menu : Dot Menu Registry, LLC // https://www.iana.org/domains/root/db/menu.html menu // merck : Merck Registry Holdings, Inc. // https://www.iana.org/domains/root/db/merck.html merck // merckmsd : MSD Registry Holdings, Inc. // https://www.iana.org/domains/root/db/merckmsd.html merckmsd // miami : Registry Services, LLC // https://www.iana.org/domains/root/db/miami.html miami // microsoft : Microsoft Corporation // https://www.iana.org/domains/root/db/microsoft.html microsoft // mini : Bayerische Motoren Werke Aktiengesellschaft // https://www.iana.org/domains/root/db/mini.html mini // mint : Intuit Administrative Services, Inc. // https://www.iana.org/domains/root/db/mint.html mint // mit : Massachusetts Institute of Technology // https://www.iana.org/domains/root/db/mit.html mit // mitsubishi : Mitsubishi Corporation // https://www.iana.org/domains/root/db/mitsubishi.html mitsubishi // mlb : MLB Advanced Media DH, LLC // https://www.iana.org/domains/root/db/mlb.html mlb // mls : The Canadian Real Estate Association // https://www.iana.org/domains/root/db/mls.html mls // mma : MMA IARD // https://www.iana.org/domains/root/db/mma.html mma // mobile : Dish DBS Corporation // https://www.iana.org/domains/root/db/mobile.html mobile // moda : Dog Beach, LLC // https://www.iana.org/domains/root/db/moda.html moda // moe : Interlink Systems Innovation Institute K.K. // https://www.iana.org/domains/root/db/moe.html moe // moi : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/moi.html moi // mom : XYZ.COM LLC // https://www.iana.org/domains/root/db/mom.html mom // monash : Monash University // https://www.iana.org/domains/root/db/monash.html monash // money : Binky Moon, LLC // https://www.iana.org/domains/root/db/money.html money // monster : XYZ.COM LLC // https://www.iana.org/domains/root/db/monster.html monster // mormon : IRI Domain Management, LLC // https://www.iana.org/domains/root/db/mormon.html mormon // mortgage : Dog Beach, LLC // https://www.iana.org/domains/root/db/mortgage.html mortgage // moscow : Foundation for Assistance for Internet Technologies and Infrastructure Development (FAITID) // https://www.iana.org/domains/root/db/moscow.html moscow // moto : Motorola Trademark Holdings, LLC // https://www.iana.org/domains/root/db/moto.html moto // motorcycles : XYZ.COM LLC // https://www.iana.org/domains/root/db/motorcycles.html motorcycles // mov : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/mov.html mov // movie : Binky Moon, LLC // https://www.iana.org/domains/root/db/movie.html movie // msd : MSD Registry Holdings, Inc. // https://www.iana.org/domains/root/db/msd.html msd // mtn : MTN Dubai Limited // https://www.iana.org/domains/root/db/mtn.html mtn // mtr : MTR Corporation Limited // https://www.iana.org/domains/root/db/mtr.html mtr // music : DotMusic Limited // https://www.iana.org/domains/root/db/music.html music // nab : National Australia Bank Limited // https://www.iana.org/domains/root/db/nab.html nab // nagoya : GMO Registry, Inc. // https://www.iana.org/domains/root/db/nagoya.html nagoya // navy : Dog Beach, LLC // https://www.iana.org/domains/root/db/navy.html navy // nba : NBA REGISTRY, LLC // https://www.iana.org/domains/root/db/nba.html nba // nec : NEC Corporation // https://www.iana.org/domains/root/db/nec.html nec // netbank : COMMONWEALTH BANK OF AUSTRALIA // https://www.iana.org/domains/root/db/netbank.html netbank // netflix : Netflix, Inc. // https://www.iana.org/domains/root/db/netflix.html netflix // network : Binky Moon, LLC // https://www.iana.org/domains/root/db/network.html network // neustar : NeuStar, Inc. // https://www.iana.org/domains/root/db/neustar.html neustar // new : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/new.html new // news : Dog Beach, LLC // https://www.iana.org/domains/root/db/news.html news // next : Next plc // https://www.iana.org/domains/root/db/next.html next // nextdirect : Next plc // https://www.iana.org/domains/root/db/nextdirect.html nextdirect // nexus : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/nexus.html nexus // nfl : NFL Reg Ops LLC // https://www.iana.org/domains/root/db/nfl.html nfl // ngo : Public Interest Registry // https://www.iana.org/domains/root/db/ngo.html ngo // nhk : Japan Broadcasting Corporation (NHK) // https://www.iana.org/domains/root/db/nhk.html nhk // nico : DWANGO Co., Ltd. // https://www.iana.org/domains/root/db/nico.html nico // nike : NIKE, Inc. // https://www.iana.org/domains/root/db/nike.html nike // nikon : NIKON CORPORATION // https://www.iana.org/domains/root/db/nikon.html nikon // ninja : Dog Beach, LLC // https://www.iana.org/domains/root/db/ninja.html ninja // nissan : NISSAN MOTOR CO., LTD. // https://www.iana.org/domains/root/db/nissan.html nissan // nissay : Nippon Life Insurance Company // https://www.iana.org/domains/root/db/nissay.html nissay // nokia : Nokia Corporation // https://www.iana.org/domains/root/db/nokia.html nokia // norton : Gen Digital Inc. // https://www.iana.org/domains/root/db/norton.html norton // now : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/now.html now // nowruz // https://www.iana.org/domains/root/db/nowruz.html nowruz // nowtv : Starbucks (HK) Limited // https://www.iana.org/domains/root/db/nowtv.html nowtv // nra : National Rifle Association of America // https://www.iana.org/domains/root/db/nra.html nra // nrw : Minds + Machines GmbH // https://www.iana.org/domains/root/db/nrw.html nrw // ntt : NIPPON TELEGRAPH AND TELEPHONE CORPORATION // https://www.iana.org/domains/root/db/ntt.html ntt // nyc : The City of New York by and through the New York City Department of Information Technology & Telecommunications // https://www.iana.org/domains/root/db/nyc.html nyc // obi : OBI Group Holding SE & Co. KGaA // https://www.iana.org/domains/root/db/obi.html obi // observer : Fegistry, LLC // https://www.iana.org/domains/root/db/observer.html observer // office : Microsoft Corporation // https://www.iana.org/domains/root/db/office.html office // okinawa : BRregistry, Inc. // https://www.iana.org/domains/root/db/okinawa.html okinawa // olayan : Competrol (Luxembourg) Sarl // https://www.iana.org/domains/root/db/olayan.html olayan // olayangroup : Competrol (Luxembourg) Sarl // https://www.iana.org/domains/root/db/olayangroup.html olayangroup // ollo : Dish DBS Corporation // https://www.iana.org/domains/root/db/ollo.html ollo // omega : The Swatch Group Ltd // https://www.iana.org/domains/root/db/omega.html omega // one : One.com A/S // https://www.iana.org/domains/root/db/one.html one // ong : Public Interest Registry // https://www.iana.org/domains/root/db/ong.html ong // onl : iRegistry GmbH // https://www.iana.org/domains/root/db/onl.html onl // online : Radix Technologies Inc SEZC // https://www.iana.org/domains/root/db/online.html online // ooo : INFIBEAM AVENUES LIMITED // https://www.iana.org/domains/root/db/ooo.html ooo // open : American Express Travel Related Services Company, Inc. // https://www.iana.org/domains/root/db/open.html open // oracle : Oracle Corporation // https://www.iana.org/domains/root/db/oracle.html oracle // orange : Orange Brand Services Limited // https://www.iana.org/domains/root/db/orange.html orange // organic : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/organic.html organic // origins : The Estée Lauder Companies Inc. // https://www.iana.org/domains/root/db/origins.html origins // osaka : Osaka Registry Co., Ltd. // https://www.iana.org/domains/root/db/osaka.html osaka // otsuka : Otsuka Holdings Co., Ltd. // https://www.iana.org/domains/root/db/otsuka.html otsuka // ott : Dish DBS Corporation // https://www.iana.org/domains/root/db/ott.html ott // ovh : MédiaBC // https://www.iana.org/domains/root/db/ovh.html ovh // page : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/page.html page // panasonic : Panasonic Holdings Corporation // https://www.iana.org/domains/root/db/panasonic.html panasonic // paris : City of Paris // https://www.iana.org/domains/root/db/paris.html paris // pars // https://www.iana.org/domains/root/db/pars.html pars // partners : Binky Moon, LLC // https://www.iana.org/domains/root/db/partners.html partners // parts : Binky Moon, LLC // https://www.iana.org/domains/root/db/parts.html parts // party : Blue Sky Registry Limited // https://www.iana.org/domains/root/db/party.html party // pay : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/pay.html pay // pccw : PCCW Enterprises Limited // https://www.iana.org/domains/root/db/pccw.html pccw // pet : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/pet.html pet // pfizer : Pfizer Inc. // https://www.iana.org/domains/root/db/pfizer.html pfizer // pharmacy : National Association of Boards of Pharmacy // https://www.iana.org/domains/root/db/pharmacy.html pharmacy // phd : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/phd.html phd // philips : Koninklijke Philips N.V. // https://www.iana.org/domains/root/db/philips.html philips // phone : Dish DBS Corporation // https://www.iana.org/domains/root/db/phone.html phone // photo : Registry Services, LLC // https://www.iana.org/domains/root/db/photo.html photo // photography : Binky Moon, LLC // https://www.iana.org/domains/root/db/photography.html photography // photos : Binky Moon, LLC // https://www.iana.org/domains/root/db/photos.html photos // physio : PhysBiz Pty Ltd // https://www.iana.org/domains/root/db/physio.html physio // pics : XYZ.COM LLC // https://www.iana.org/domains/root/db/pics.html pics // pictet : Banque Pictet & Cie SA // https://www.iana.org/domains/root/db/pictet.html pictet // pictures : Binky Moon, LLC // https://www.iana.org/domains/root/db/pictures.html pictures // pid : Top Level Spectrum, Inc. // https://www.iana.org/domains/root/db/pid.html pid // pin : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/pin.html pin // ping : Ping Registry Provider, Inc. // https://www.iana.org/domains/root/db/ping.html ping // pink : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/pink.html pink // pioneer : Pioneer Corporation // https://www.iana.org/domains/root/db/pioneer.html pioneer // pizza : Binky Moon, LLC // https://www.iana.org/domains/root/db/pizza.html pizza // place : Binky Moon, LLC // https://www.iana.org/domains/root/db/place.html place // play : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/play.html play // playstation : Sony Interactive Entertainment Inc. // https://www.iana.org/domains/root/db/playstation.html playstation // plumbing : Binky Moon, LLC // https://www.iana.org/domains/root/db/plumbing.html plumbing // plus : Binky Moon, LLC // https://www.iana.org/domains/root/db/plus.html plus // pnc : PNC Domain Co., LLC // https://www.iana.org/domains/root/db/pnc.html pnc // pohl : Deutsche Vermögensberatung Aktiengesellschaft DVAG // https://www.iana.org/domains/root/db/pohl.html pohl // poker : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/poker.html poker // politie : Politie Nederland // https://www.iana.org/domains/root/db/politie.html politie // porn : ICM Registry PN LLC // https://www.iana.org/domains/root/db/porn.html porn // praxi : Praxi S.p.A. // https://www.iana.org/domains/root/db/praxi.html praxi // press : Radix Technologies Inc SEZC // https://www.iana.org/domains/root/db/press.html press // prime : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/prime.html prime // prod : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/prod.html prod // productions : Binky Moon, LLC // https://www.iana.org/domains/root/db/productions.html productions // prof : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/prof.html prof // progressive : Progressive Casualty Insurance Company // https://www.iana.org/domains/root/db/progressive.html progressive // promo : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/promo.html promo // properties : Binky Moon, LLC // https://www.iana.org/domains/root/db/properties.html properties // property : Digital Property Infrastructure Limited // https://www.iana.org/domains/root/db/property.html property // protection : XYZ.COM LLC // https://www.iana.org/domains/root/db/protection.html protection // pru : Prudential Financial, Inc. // https://www.iana.org/domains/root/db/pru.html pru // prudential : Prudential Financial, Inc. // https://www.iana.org/domains/root/db/prudential.html prudential // pub : Dog Beach, LLC // https://www.iana.org/domains/root/db/pub.html pub // pwc : PricewaterhouseCoopers LLP // https://www.iana.org/domains/root/db/pwc.html pwc // qpon : dotQPON LLC // https://www.iana.org/domains/root/db/qpon.html qpon // quebec : PointQuébec Inc // https://www.iana.org/domains/root/db/quebec.html quebec // quest : XYZ.COM LLC // https://www.iana.org/domains/root/db/quest.html quest // racing : Premier Registry Limited // https://www.iana.org/domains/root/db/racing.html racing // radio : European Broadcasting Union (EBU) // https://www.iana.org/domains/root/db/radio.html radio // read : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/read.html read // realestate : dotRealEstate LLC // https://www.iana.org/domains/root/db/realestate.html realestate // realtor : Real Estate Domains LLC // https://www.iana.org/domains/root/db/realtor.html realtor // realty : Waterford Limited // https://www.iana.org/domains/root/db/realty.html realty // recipes : Binky Moon, LLC // https://www.iana.org/domains/root/db/recipes.html recipes // red : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/red.html red // redumbrella : Travelers TLD, LLC // https://www.iana.org/domains/root/db/redumbrella.html redumbrella // rehab : Dog Beach, LLC // https://www.iana.org/domains/root/db/rehab.html rehab // reise : Binky Moon, LLC // https://www.iana.org/domains/root/db/reise.html reise // reisen : Binky Moon, LLC // https://www.iana.org/domains/root/db/reisen.html reisen // reit : National Association of Real Estate Investment Trusts, Inc. // https://www.iana.org/domains/root/db/reit.html reit // reliance : Reliance Industries Limited // https://www.iana.org/domains/root/db/reliance.html reliance // ren : ZDNS International Limited // https://www.iana.org/domains/root/db/ren.html ren // rent : XYZ.COM LLC // https://www.iana.org/domains/root/db/rent.html rent // rentals : Binky Moon, LLC // https://www.iana.org/domains/root/db/rentals.html rentals // repair : Binky Moon, LLC // https://www.iana.org/domains/root/db/repair.html repair // report : Binky Moon, LLC // https://www.iana.org/domains/root/db/report.html report // republican : Dog Beach, LLC // https://www.iana.org/domains/root/db/republican.html republican // rest : Punto 2012 Sociedad Anonima Promotora de Inversion de Capital Variable // https://www.iana.org/domains/root/db/rest.html rest // restaurant : Binky Moon, LLC // https://www.iana.org/domains/root/db/restaurant.html restaurant // review : dot Review Limited // https://www.iana.org/domains/root/db/review.html review // reviews : Dog Beach, LLC // https://www.iana.org/domains/root/db/reviews.html reviews // rexroth : Robert Bosch GMBH // https://www.iana.org/domains/root/db/rexroth.html rexroth // rich : iRegistry GmbH // https://www.iana.org/domains/root/db/rich.html rich // richardli : Pacific Century Asset Management (HK) Limited // https://www.iana.org/domains/root/db/richardli.html richardli // ricoh : Ricoh Company, Ltd. // https://www.iana.org/domains/root/db/ricoh.html ricoh // ril : Reliance Industries Limited // https://www.iana.org/domains/root/db/ril.html ril // rio : Empresa Municipal de Informática SA - IPLANRIO // https://www.iana.org/domains/root/db/rio.html rio // rip : Dog Beach, LLC // https://www.iana.org/domains/root/db/rip.html rip // rocks : Dog Beach, LLC // https://www.iana.org/domains/root/db/rocks.html rocks // rodeo : Registry Services, LLC // https://www.iana.org/domains/root/db/rodeo.html rodeo // rogers : Rogers Communications Canada Inc. // https://www.iana.org/domains/root/db/rogers.html rogers // room : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/room.html room // rsvp : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/rsvp.html rsvp // rugby : World Rugby Strategic Developments Limited // https://www.iana.org/domains/root/db/rugby.html rugby // ruhr : dotSaarland GmbH // https://www.iana.org/domains/root/db/ruhr.html ruhr // run : Binky Moon, LLC // https://www.iana.org/domains/root/db/run.html run // rwe : RWE AG // https://www.iana.org/domains/root/db/rwe.html rwe // ryukyu : BRregistry, Inc. // https://www.iana.org/domains/root/db/ryukyu.html ryukyu // saarland : dotSaarland GmbH // https://www.iana.org/domains/root/db/saarland.html saarland // safe : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/safe.html safe // safety : Safety Registry Services, LLC. // https://www.iana.org/domains/root/db/safety.html safety // sakura : SAKURA Internet Inc. // https://www.iana.org/domains/root/db/sakura.html sakura // sale : Dog Beach, LLC // https://www.iana.org/domains/root/db/sale.html sale // salon : Binky Moon, LLC // https://www.iana.org/domains/root/db/salon.html salon // samsclub : Wal-Mart Stores, Inc. // https://www.iana.org/domains/root/db/samsclub.html samsclub // samsung : SAMSUNG SDS CO., LTD // https://www.iana.org/domains/root/db/samsung.html samsung // sandvik : Sandvik AB // https://www.iana.org/domains/root/db/sandvik.html sandvik // sandvikcoromant : Sandvik AB // https://www.iana.org/domains/root/db/sandvikcoromant.html sandvikcoromant // sanofi : Sanofi // https://www.iana.org/domains/root/db/sanofi.html sanofi // sap : SAP AG // https://www.iana.org/domains/root/db/sap.html sap // sarl : Binky Moon, LLC // https://www.iana.org/domains/root/db/sarl.html sarl // sas : Research IP LLC // https://www.iana.org/domains/root/db/sas.html sas // save : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/save.html save // saxo : Saxo Bank A/S // https://www.iana.org/domains/root/db/saxo.html saxo // sbi : STATE BANK OF INDIA // https://www.iana.org/domains/root/db/sbi.html sbi // sbs : ShortDot SA // https://www.iana.org/domains/root/db/sbs.html sbs // scb : The Siam Commercial Bank Public Company Limited ("SCB") // https://www.iana.org/domains/root/db/scb.html scb // schaeffler : Schaeffler Technologies AG & Co. KG // https://www.iana.org/domains/root/db/schaeffler.html schaeffler // schmidt : SCHMIDT GROUPE S.A.S. // https://www.iana.org/domains/root/db/schmidt.html schmidt // scholarships : Scholarships.com, LLC // https://www.iana.org/domains/root/db/scholarships.html scholarships // school : Binky Moon, LLC // https://www.iana.org/domains/root/db/school.html school // schule : Binky Moon, LLC // https://www.iana.org/domains/root/db/schule.html schule // schwarz : Schwarz Domains und Services GmbH & Co. KG // https://www.iana.org/domains/root/db/schwarz.html schwarz // science : dot Science Limited // https://www.iana.org/domains/root/db/science.html science // scot : Dot Scot Registry Limited // https://www.iana.org/domains/root/db/scot.html scot // search : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/search.html search // seat : SEAT, S.A. (Sociedad Unipersonal) // https://www.iana.org/domains/root/db/seat.html seat // secure : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/secure.html secure // security : XYZ.COM LLC // https://www.iana.org/domains/root/db/security.html security // seek : Seek Limited // https://www.iana.org/domains/root/db/seek.html seek // select : Registry Services, LLC // https://www.iana.org/domains/root/db/select.html select // sener : Sener Ingeniería y Sistemas, S.A. // https://www.iana.org/domains/root/db/sener.html sener // services : Binky Moon, LLC // https://www.iana.org/domains/root/db/services.html services // seven : Seven West Media Ltd // https://www.iana.org/domains/root/db/seven.html seven // sew : SEW-EURODRIVE GmbH & Co KG // https://www.iana.org/domains/root/db/sew.html sew // sex : ICM Registry SX LLC // https://www.iana.org/domains/root/db/sex.html sex // sexy : Internet Naming Company LLC // https://www.iana.org/domains/root/db/sexy.html sexy // sfr : Societe Francaise du Radiotelephone - SFR // https://www.iana.org/domains/root/db/sfr.html sfr // shangrila : Shangri‐La International Hotel Management Limited // https://www.iana.org/domains/root/db/shangrila.html shangrila // sharp : Sharp Corporation // https://www.iana.org/domains/root/db/sharp.html sharp // shell : Shell Information Technology International Inc // https://www.iana.org/domains/root/db/shell.html shell // shia // https://www.iana.org/domains/root/db/shia.html shia // shiksha : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/shiksha.html shiksha // shoes : Binky Moon, LLC // https://www.iana.org/domains/root/db/shoes.html shoes // shop : GMO Registry, Inc. // https://www.iana.org/domains/root/db/shop.html shop // shopping : Binky Moon, LLC // https://www.iana.org/domains/root/db/shopping.html shopping // shouji : Beijing Qihu Keji Co., Ltd. // https://www.iana.org/domains/root/db/shouji.html shouji // show : Binky Moon, LLC // https://www.iana.org/domains/root/db/show.html show // silk : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/silk.html silk // sina : Sina Corporation // https://www.iana.org/domains/root/db/sina.html sina // singles : Binky Moon, LLC // https://www.iana.org/domains/root/db/singles.html singles // site : Radix Technologies Inc SEZC // https://www.iana.org/domains/root/db/site.html site // ski : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/ski.html ski // skin : XYZ.COM LLC // https://www.iana.org/domains/root/db/skin.html skin // sky : Sky UK Limited // https://www.iana.org/domains/root/db/sky.html sky // skype : Microsoft Corporation // https://www.iana.org/domains/root/db/skype.html skype // sling : DISH Technologies L.L.C. // https://www.iana.org/domains/root/db/sling.html sling // smart : Smart Communications, Inc. (SMART) // https://www.iana.org/domains/root/db/smart.html smart // smile : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/smile.html smile // sncf : Société Nationale SNCF // https://www.iana.org/domains/root/db/sncf.html sncf // soccer : Binky Moon, LLC // https://www.iana.org/domains/root/db/soccer.html soccer // social : Dog Beach, LLC // https://www.iana.org/domains/root/db/social.html social // softbank : SoftBank Group Corp. // https://www.iana.org/domains/root/db/softbank.html softbank // software : Dog Beach, LLC // https://www.iana.org/domains/root/db/software.html software // sohu : Sohu.com Limited // https://www.iana.org/domains/root/db/sohu.html sohu // solar : Binky Moon, LLC // https://www.iana.org/domains/root/db/solar.html solar // solutions : Binky Moon, LLC // https://www.iana.org/domains/root/db/solutions.html solutions // song : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/song.html song // sony : Sony Corporation // https://www.iana.org/domains/root/db/sony.html sony // soy : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/soy.html soy // spa : Asia Spa and Wellness Promotion Council Limited // https://www.iana.org/domains/root/db/spa.html spa // space : Radix Technologies Inc SEZC // https://www.iana.org/domains/root/db/space.html space // sport : SportAccord // https://www.iana.org/domains/root/db/sport.html sport // spot : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/spot.html spot // srl : InterNetX, Corp // https://www.iana.org/domains/root/db/srl.html srl // stada : STADA Arzneimittel AG // https://www.iana.org/domains/root/db/stada.html stada // staples : Staples, Inc. // https://www.iana.org/domains/root/db/staples.html staples // star : Star India Private Limited // https://www.iana.org/domains/root/db/star.html star // statebank : STATE BANK OF INDIA // https://www.iana.org/domains/root/db/statebank.html statebank // statefarm : State Farm Mutual Automobile Insurance Company // https://www.iana.org/domains/root/db/statefarm.html statefarm // stc : Saudi Telecom Company // https://www.iana.org/domains/root/db/stc.html stc // stcgroup : Saudi Telecom Company // https://www.iana.org/domains/root/db/stcgroup.html stcgroup // stockholm : Stockholms kommun // https://www.iana.org/domains/root/db/stockholm.html stockholm // storage : XYZ.COM LLC // https://www.iana.org/domains/root/db/storage.html storage // store : Radix Technologies Inc SEZC // https://www.iana.org/domains/root/db/store.html store // stream : dot Stream Limited // https://www.iana.org/domains/root/db/stream.html stream // studio : Dog Beach, LLC // https://www.iana.org/domains/root/db/studio.html studio // study : Registry Services, LLC // https://www.iana.org/domains/root/db/study.html study // style : Binky Moon, LLC // https://www.iana.org/domains/root/db/style.html style // sucks : Vox Populi Registry Ltd. // https://www.iana.org/domains/root/db/sucks.html sucks // supplies : Binky Moon, LLC // https://www.iana.org/domains/root/db/supplies.html supplies // supply : Binky Moon, LLC // https://www.iana.org/domains/root/db/supply.html supply // support : Binky Moon, LLC // https://www.iana.org/domains/root/db/support.html support // surf : Registry Services, LLC // https://www.iana.org/domains/root/db/surf.html surf // surgery : Binky Moon, LLC // https://www.iana.org/domains/root/db/surgery.html surgery // suzuki : SUZUKI MOTOR CORPORATION // https://www.iana.org/domains/root/db/suzuki.html suzuki // swatch : The Swatch Group Ltd // https://www.iana.org/domains/root/db/swatch.html swatch // swiss : Swiss Confederation // https://www.iana.org/domains/root/db/swiss.html swiss // sydney : State of New South Wales, Department of Premier and Cabinet // https://www.iana.org/domains/root/db/sydney.html sydney // systems : Binky Moon, LLC // https://www.iana.org/domains/root/db/systems.html systems // tab : Tabcorp Holdings Limited // https://www.iana.org/domains/root/db/tab.html tab // taipei : Taipei City Government // https://www.iana.org/domains/root/db/taipei.html taipei // talk : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/talk.html talk // taobao : Alibaba Group Holding Limited // https://www.iana.org/domains/root/db/taobao.html taobao // target : Target Domain Holdings, LLC // https://www.iana.org/domains/root/db/target.html target // tatamotors : Tata Motors Ltd // https://www.iana.org/domains/root/db/tatamotors.html tatamotors // tatar : Limited Liability Company "Coordination Center of Regional Domain of Tatarstan Republic" // https://www.iana.org/domains/root/db/tatar.html tatar // tattoo : Registry Services, LLC // https://www.iana.org/domains/root/db/tattoo.html tattoo // tax : Binky Moon, LLC // https://www.iana.org/domains/root/db/tax.html tax // taxi : Binky Moon, LLC // https://www.iana.org/domains/root/db/taxi.html taxi // tci // https://www.iana.org/domains/root/db/tci.html tci // tdk : TDK Corporation // https://www.iana.org/domains/root/db/tdk.html tdk // team : Binky Moon, LLC // https://www.iana.org/domains/root/db/team.html team // tech : Radix Technologies Inc SEZC // https://www.iana.org/domains/root/db/tech.html tech // technology : Binky Moon, LLC // https://www.iana.org/domains/root/db/technology.html technology // temasek : Temasek Holdings (Private) Limited // https://www.iana.org/domains/root/db/temasek.html temasek // tennis : Binky Moon, LLC // https://www.iana.org/domains/root/db/tennis.html tennis // teva : Teva Pharmaceutical Industries Limited // https://www.iana.org/domains/root/db/teva.html teva // thd : Home Depot Product Authority, LLC // https://www.iana.org/domains/root/db/thd.html thd // theater : Binky Moon, LLC // https://www.iana.org/domains/root/db/theater.html theater // theatre : XYZ.COM LLC // https://www.iana.org/domains/root/db/theatre.html theatre // tiaa : Teachers Insurance and Annuity Association of America // https://www.iana.org/domains/root/db/tiaa.html tiaa // tickets : XYZ.COM LLC // https://www.iana.org/domains/root/db/tickets.html tickets // tienda : Binky Moon, LLC // https://www.iana.org/domains/root/db/tienda.html tienda // tips : Binky Moon, LLC // https://www.iana.org/domains/root/db/tips.html tips // tires : Binky Moon, LLC // https://www.iana.org/domains/root/db/tires.html tires // tirol : punkt Tirol GmbH // https://www.iana.org/domains/root/db/tirol.html tirol // tjmaxx : The TJX Companies, Inc. // https://www.iana.org/domains/root/db/tjmaxx.html tjmaxx // tjx : The TJX Companies, Inc. // https://www.iana.org/domains/root/db/tjx.html tjx // tkmaxx : The TJX Companies, Inc. // https://www.iana.org/domains/root/db/tkmaxx.html tkmaxx // tmall : Alibaba Group Holding Limited // https://www.iana.org/domains/root/db/tmall.html tmall // today : Binky Moon, LLC // https://www.iana.org/domains/root/db/today.html today // tokyo : GMO Registry, Inc. // https://www.iana.org/domains/root/db/tokyo.html tokyo // tools : Binky Moon, LLC // https://www.iana.org/domains/root/db/tools.html tools // top : .TOP Registry // https://www.iana.org/domains/root/db/top.html top // toray : Toray Industries, Inc. // https://www.iana.org/domains/root/db/toray.html toray // toshiba : TOSHIBA Corporation // https://www.iana.org/domains/root/db/toshiba.html toshiba // total : TotalEnergies SE // https://www.iana.org/domains/root/db/total.html total // tours : Binky Moon, LLC // https://www.iana.org/domains/root/db/tours.html tours // town : Binky Moon, LLC // https://www.iana.org/domains/root/db/town.html town // toyota : TOYOTA MOTOR CORPORATION // https://www.iana.org/domains/root/db/toyota.html toyota // toys : Binky Moon, LLC // https://www.iana.org/domains/root/db/toys.html toys // trade : Elite Registry Limited // https://www.iana.org/domains/root/db/trade.html trade // trading : Dog Beach, LLC // https://www.iana.org/domains/root/db/trading.html trading // training : Binky Moon, LLC // https://www.iana.org/domains/root/db/training.html training // travel : Dog Beach, LLC // https://www.iana.org/domains/root/db/travel.html travel // travelers : Travelers TLD, LLC // https://www.iana.org/domains/root/db/travelers.html travelers // travelersinsurance : Travelers TLD, LLC // https://www.iana.org/domains/root/db/travelersinsurance.html travelersinsurance // trust : Internet Naming Company LLC // https://www.iana.org/domains/root/db/trust.html trust // trv : Travelers TLD, LLC // https://www.iana.org/domains/root/db/trv.html trv // tube : Latin American Telecom LLC // https://www.iana.org/domains/root/db/tube.html tube // tui : TUI AG // https://www.iana.org/domains/root/db/tui.html tui // tunes : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/tunes.html tunes // tushu : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/tushu.html tushu // tvs : T V SUNDRAM IYENGAR & SONS LIMITED // https://www.iana.org/domains/root/db/tvs.html tvs // ubank : National Australia Bank Limited // https://www.iana.org/domains/root/db/ubank.html ubank // ubs : UBS AG // https://www.iana.org/domains/root/db/ubs.html ubs // unicom : China United Network Communications Corporation Limited // https://www.iana.org/domains/root/db/unicom.html unicom // university : Binky Moon, LLC // https://www.iana.org/domains/root/db/university.html university // uno : Radix Technologies Inc SEZC // https://www.iana.org/domains/root/db/uno.html uno // uol : UBN INTERNET LTDA. // https://www.iana.org/domains/root/db/uol.html uol // ups : UPS Market Driver, Inc. // https://www.iana.org/domains/root/db/ups.html ups // vacations : Binky Moon, LLC // https://www.iana.org/domains/root/db/vacations.html vacations // vana : D3 Registry LLC // https://www.iana.org/domains/root/db/vana.html vana // vanguard : The Vanguard Group, Inc. // https://www.iana.org/domains/root/db/vanguard.html vanguard // vegas : Dot Vegas, Inc. // https://www.iana.org/domains/root/db/vegas.html vegas // ventures : Binky Moon, LLC // https://www.iana.org/domains/root/db/ventures.html ventures // verisign : VeriSign, Inc. // https://www.iana.org/domains/root/db/verisign.html verisign // versicherung : tldbox GmbH // https://www.iana.org/domains/root/db/versicherung.html versicherung // vet : Dog Beach, LLC // https://www.iana.org/domains/root/db/vet.html vet // viajes : Binky Moon, LLC // https://www.iana.org/domains/root/db/viajes.html viajes // video : Dog Beach, LLC // https://www.iana.org/domains/root/db/video.html video // vig : VIENNA INSURANCE GROUP AG Wiener Versicherung Gruppe // https://www.iana.org/domains/root/db/vig.html vig // viking : Viking River Cruises (Bermuda) Ltd. // https://www.iana.org/domains/root/db/viking.html viking // villas : Binky Moon, LLC // https://www.iana.org/domains/root/db/villas.html villas // vin : Binky Moon, LLC // https://www.iana.org/domains/root/db/vin.html vin // vip : Registry Services, LLC // https://www.iana.org/domains/root/db/vip.html vip // virgin : Virgin Enterprises Limited // https://www.iana.org/domains/root/db/virgin.html virgin // visa : Visa Worldwide Pte. Limited // https://www.iana.org/domains/root/db/visa.html visa // vision : Binky Moon, LLC // https://www.iana.org/domains/root/db/vision.html vision // viva : Saudi Telecom Company // https://www.iana.org/domains/root/db/viva.html viva // vivo : Telefonica Brasil S.A. // https://www.iana.org/domains/root/db/vivo.html vivo // vlaanderen : DNS.be vzw // https://www.iana.org/domains/root/db/vlaanderen.html vlaanderen // vodka : Registry Services, LLC // https://www.iana.org/domains/root/db/vodka.html vodka // volvo : Volvo Holding Sverige Aktiebolag // https://www.iana.org/domains/root/db/volvo.html volvo // vote : Monolith Registry LLC // https://www.iana.org/domains/root/db/vote.html vote // voting : Valuetainment Corp. // https://www.iana.org/domains/root/db/voting.html voting // voto : Monolith Registry LLC // https://www.iana.org/domains/root/db/voto.html voto // voyage : Binky Moon, LLC // https://www.iana.org/domains/root/db/voyage.html voyage // wales : Nominet UK // https://www.iana.org/domains/root/db/wales.html wales // walmart : Wal-Mart Stores, Inc. // https://www.iana.org/domains/root/db/walmart.html walmart // walter : Sandvik AB // https://www.iana.org/domains/root/db/walter.html walter // wang : Zodiac Wang Limited // https://www.iana.org/domains/root/db/wang.html wang // wanggou : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/wanggou.html wanggou // watch : Binky Moon, LLC // https://www.iana.org/domains/root/db/watch.html watch // watches : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/watches.html watches // weather : International Business Machines Corporation // https://www.iana.org/domains/root/db/weather.html weather // weatherchannel : International Business Machines Corporation // https://www.iana.org/domains/root/db/weatherchannel.html weatherchannel // webcam : dot Webcam Limited // https://www.iana.org/domains/root/db/webcam.html webcam // weber : Saint-Gobain Weber SA // https://www.iana.org/domains/root/db/weber.html weber // website : Radix Technologies Inc SEZC // https://www.iana.org/domains/root/db/website.html website // wed // https://www.iana.org/domains/root/db/wed.html wed // wedding : Registry Services, LLC // https://www.iana.org/domains/root/db/wedding.html wedding // weibo : Sina Corporation // https://www.iana.org/domains/root/db/weibo.html weibo // weir : Weir Group IP Limited // https://www.iana.org/domains/root/db/weir.html weir // whoswho : Who's Who Registry // https://www.iana.org/domains/root/db/whoswho.html whoswho // wien : punkt.wien GmbH // https://www.iana.org/domains/root/db/wien.html wien // wiki : Registry Services, LLC // https://www.iana.org/domains/root/db/wiki.html wiki // williamhill : William Hill Organization Limited // https://www.iana.org/domains/root/db/williamhill.html williamhill // win : First Registry Limited // https://www.iana.org/domains/root/db/win.html win // windows : Microsoft Corporation // https://www.iana.org/domains/root/db/windows.html windows // wine : Binky Moon, LLC // https://www.iana.org/domains/root/db/wine.html wine // winners : The TJX Companies, Inc. // https://www.iana.org/domains/root/db/winners.html winners // wme : William Morris Endeavor Entertainment, LLC // https://www.iana.org/domains/root/db/wme.html wme // wolterskluwer : Wolters Kluwer N.V. // https://www.iana.org/domains/root/db/wolterskluwer.html wolterskluwer // woodside : Woodside Petroleum Limited // https://www.iana.org/domains/root/db/woodside.html woodside // work : Registry Services, LLC // https://www.iana.org/domains/root/db/work.html work // works : Binky Moon, LLC // https://www.iana.org/domains/root/db/works.html works // world : Binky Moon, LLC // https://www.iana.org/domains/root/db/world.html world // wow : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/wow.html wow // wtc : World Trade Centers Association, Inc. // https://www.iana.org/domains/root/db/wtc.html wtc // wtf : Binky Moon, LLC // https://www.iana.org/domains/root/db/wtf.html wtf // xbox : Microsoft Corporation // https://www.iana.org/domains/root/db/xbox.html xbox // xerox : Xerox DNHC LLC // https://www.iana.org/domains/root/db/xerox.html xerox // xihuan : Beijing Qihu Keji Co., Ltd. // https://www.iana.org/domains/root/db/xihuan.html xihuan // xin : Elegant Leader Limited // https://www.iana.org/domains/root/db/xin.html xin // xn--11b4c3d : VeriSign Sarl // https://www.iana.org/domains/root/db/xn--11b4c3d.html कॉम // xn--1ck2e1b : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/xn--1ck2e1b.html セール // xn--1qqw23a : Guangzhou YU Wei Information Technology Co., Ltd. // https://www.iana.org/domains/root/db/xn--1qqw23a.html 佛山 // xn--30rr7y : Excellent First Limited // https://www.iana.org/domains/root/db/xn--30rr7y.html 慈善 // xn--3bst00m : Eagle Horizon Limited // https://www.iana.org/domains/root/db/xn--3bst00m.html 集团 // xn--3ds443g : Beijing TLD Registry Technology Limited // https://www.iana.org/domains/root/db/xn--3ds443g.html 在线 // xn--3pxu8k : VeriSign Sarl // https://www.iana.org/domains/root/db/xn--3pxu8k.html 点看 // xn--42c2d9a : VeriSign Sarl // https://www.iana.org/domains/root/db/xn--42c2d9a.html คอม // xn--45q11c : Zodiac Gemini Ltd // https://www.iana.org/domains/root/db/xn--45q11c.html 八卦 // xn--4gbrim : Helium TLDs Ltd // https://www.iana.org/domains/root/db/xn--4gbrim.html موقع // xn--55qw42g : China Organizational Name Administration Center // https://www.iana.org/domains/root/db/xn--55qw42g.html 公益 // xn--55qx5d : China Internet Network Information Center (CNNIC) // https://www.iana.org/domains/root/db/xn--55qx5d.html 公司 // xn--5su34j936bgsg : Shangri‐La International Hotel Management Limited // https://www.iana.org/domains/root/db/xn--5su34j936bgsg.html 香格里拉 // xn--5tzm5g : Global Website TLD Asia Limited // https://www.iana.org/domains/root/db/xn--5tzm5g.html 网站 // xn--6frz82g : Identity Digital Domains Limited // https://www.iana.org/domains/root/db/xn--6frz82g.html 移动 // xn--6qq986b3xl : Tycoon Treasure Limited // https://www.iana.org/domains/root/db/xn--6qq986b3xl.html 我爱你 // xn--80adxhks : Foundation for Assistance for Internet Technologies and Infrastructure Development (FAITID) // https://www.iana.org/domains/root/db/xn--80adxhks.html москва // xn--80aqecdr1a : Pontificium Consilium de Comunicationibus Socialibus (PCCS) (Pontifical Council for Social Communication) // https://www.iana.org/domains/root/db/xn--80aqecdr1a.html католик // xn--80asehdb : CORE Association // https://www.iana.org/domains/root/db/xn--80asehdb.html онлайн // xn--80aswg : CORE Association // https://www.iana.org/domains/root/db/xn--80aswg.html сайт // xn--8y0a063a : China United Network Communications Corporation Limited // https://www.iana.org/domains/root/db/xn--8y0a063a.html 联通 // xn--9dbq2a : VeriSign Sarl // https://www.iana.org/domains/root/db/xn--9dbq2a.html קום // xn--9et52u : RISE VICTORY LIMITED // https://www.iana.org/domains/root/db/xn--9et52u.html 时尚 // xn--9krt00a : Sina Corporation // https://www.iana.org/domains/root/db/xn--9krt00a.html 微博 // xn--b4w605ferd : Temasek Holdings (Private) Limited // https://www.iana.org/domains/root/db/xn--b4w605ferd.html 淡马锡 // xn--bck1b9a5dre4c : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/xn--bck1b9a5dre4c.html ファッション // xn--c1avg : Public Interest Registry // https://www.iana.org/domains/root/db/xn--c1avg.html орг // xn--c2br7g : VeriSign Sarl // https://www.iana.org/domains/root/db/xn--c2br7g.html नेट // xn--cck2b3b : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/xn--cck2b3b.html ストア // xn--cckwcxetd : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/xn--cckwcxetd.html アマゾン // xn--cg4bki : SAMSUNG SDS CO., LTD // https://www.iana.org/domains/root/db/xn--cg4bki.html 삼성 // xn--czr694b : Internet DotTrademark Organisation Limited // https://www.iana.org/domains/root/db/xn--czr694b.html 商标 // xn--czrs0t : Binky Moon, LLC // https://www.iana.org/domains/root/db/xn--czrs0t.html 商店 // xn--czru2d : Zodiac Aquarius Limited // https://www.iana.org/domains/root/db/xn--czru2d.html 商城 // xn--d1acj3b : The Foundation for Network Initiatives “The Smart Internet” // https://www.iana.org/domains/root/db/xn--d1acj3b.html дети // xn--eckvdtc9d : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/xn--eckvdtc9d.html ポイント // xn--efvy88h : Guangzhou YU Wei Information Technology Co., Ltd. // https://www.iana.org/domains/root/db/xn--efvy88h.html 新闻 // xn--fct429k : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/xn--fct429k.html 家電 // xn--fhbei : VeriSign Sarl // https://www.iana.org/domains/root/db/xn--fhbei.html كوم // xn--fiq228c5hs : TLD REGISTRY LIMITED OY // https://www.iana.org/domains/root/db/xn--fiq228c5hs.html 中文网 // xn--fiq64b : CITIC Group Corporation // https://www.iana.org/domains/root/db/xn--fiq64b.html 中信 // xn--fjq720a : Binky Moon, LLC // https://www.iana.org/domains/root/db/xn--fjq720a.html 娱乐 // xn--flw351e : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/xn--flw351e.html 谷歌 // xn--fzys8d69uvgm : PCCW Enterprises Limited // https://www.iana.org/domains/root/db/xn--fzys8d69uvgm.html 電訊盈科 // xn--g2xx48c : Nawang Heli(Xiamen) Network Service Co., LTD. // https://www.iana.org/domains/root/db/xn--g2xx48c.html 购物 // xn--gckr3f0f : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/xn--gckr3f0f.html クラウド // xn--gk3at1e : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/xn--gk3at1e.html 通販 // xn--hxt814e : Zodiac Taurus Limited // https://www.iana.org/domains/root/db/xn--hxt814e.html 网店 // xn--i1b6b1a6a2e : Public Interest Registry // https://www.iana.org/domains/root/db/xn--i1b6b1a6a2e.html संगठन // xn--imr513n : Internet DotTrademark Organisation Limited // https://www.iana.org/domains/root/db/xn--imr513n.html 餐厅 // xn--io0a7i : China Internet Network Information Center (CNNIC) // https://www.iana.org/domains/root/db/xn--io0a7i.html 网络 // xn--j1aef : VeriSign Sarl // https://www.iana.org/domains/root/db/xn--j1aef.html ком // xn--jlq480n2rg : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/xn--jlq480n2rg.html 亚马逊 // xn--jvr189m : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/xn--jvr189m.html 食品 // xn--kcrx77d1x4a : Koninklijke Philips N.V. // https://www.iana.org/domains/root/db/xn--kcrx77d1x4a.html 飞利浦 // xn--kput3i : Beijing RITT-Net Technology Development Co., Ltd // https://www.iana.org/domains/root/db/xn--kput3i.html 手机 // xn--mgba3a3ejt : Aramco Services Company // https://www.iana.org/domains/root/db/xn--mgba3a3ejt.html ارامكو // xn--mgba7c0bbn0a : Competrol (Luxembourg) Sarl // https://www.iana.org/domains/root/db/xn--mgba7c0bbn0a.html العليان // xn--mgbab2bd : CORE Association // https://www.iana.org/domains/root/db/xn--mgbab2bd.html بازار // xn--mgbca7dzdo : Abu Dhabi Systems and Information Centre // https://www.iana.org/domains/root/db/xn--mgbca7dzdo.html ابوظبي // xn--mgbi4ecexp : Pontificium Consilium de Comunicationibus Socialibus (PCCS) (Pontifical Council for Social Communication) // https://www.iana.org/domains/root/db/xn--mgbi4ecexp.html كاثوليك // xn--mgbt3dhd // https://www.iana.org/domains/root/db/xn--mgbt3dhd.html همراه // xn--mk1bu44c : VeriSign Sarl // https://www.iana.org/domains/root/db/xn--mk1bu44c.html 닷컴 // xn--mxtq1m : Net-Chinese Co., Ltd. // https://www.iana.org/domains/root/db/xn--mxtq1m.html 政府 // xn--ngbc5azd : International Domain Registry Pty. Ltd. // https://www.iana.org/domains/root/db/xn--ngbc5azd.html شبكة // xn--ngbe9e0a : Kuwait Finance House // https://www.iana.org/domains/root/db/xn--ngbe9e0a.html بيتك // xn--ngbrx : League of Arab States // https://www.iana.org/domains/root/db/xn--ngbrx.html عرب // xn--nqv7f : Public Interest Registry // https://www.iana.org/domains/root/db/xn--nqv7f.html 机构 // xn--nqv7fs00ema : Public Interest Registry // https://www.iana.org/domains/root/db/xn--nqv7fs00ema.html 组织机构 // xn--nyqy26a : Stable Tone Limited // https://www.iana.org/domains/root/db/xn--nyqy26a.html 健康 // xn--otu796d : Jiang Yu Liang Cai Technology Company Limited // https://www.iana.org/domains/root/db/xn--otu796d.html 招聘 // xn--p1acf : Rusnames Limited // https://www.iana.org/domains/root/db/xn--p1acf.html рус // xn--pssy2u : VeriSign Sarl // https://www.iana.org/domains/root/db/xn--pssy2u.html 大拿 // xn--q9jyb4c : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/xn--q9jyb4c.html みんな // xn--qcka1pmc : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/xn--qcka1pmc.html グーグル // xn--rhqv96g : Stable Tone Limited // https://www.iana.org/domains/root/db/xn--rhqv96g.html 世界 // xn--rovu88b : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/xn--rovu88b.html 書籍 // xn--ses554g : KNET Co., Ltd. // https://www.iana.org/domains/root/db/xn--ses554g.html 网址 // xn--t60b56a : VeriSign Sarl // https://www.iana.org/domains/root/db/xn--t60b56a.html 닷넷 // xn--tckwe : VeriSign Sarl // https://www.iana.org/domains/root/db/xn--tckwe.html コム // xn--tiq49xqyj : Pontificium Consilium de Comunicationibus Socialibus (PCCS) (Pontifical Council for Social Communication) // https://www.iana.org/domains/root/db/xn--tiq49xqyj.html 天主教 // xn--unup4y : Binky Moon, LLC // https://www.iana.org/domains/root/db/xn--unup4y.html 游戏 // xn--vermgensberater-ctb : Deutsche Vermögensberatung Aktiengesellschaft DVAG // https://www.iana.org/domains/root/db/xn--vermgensberater-ctb.html vermögensberater // xn--vermgensberatung-pwb : Deutsche Vermögensberatung Aktiengesellschaft DVAG // https://www.iana.org/domains/root/db/xn--vermgensberatung-pwb.html vermögensberatung // xn--vhquv : Binky Moon, LLC // https://www.iana.org/domains/root/db/xn--vhquv.html 企业 // xn--vuq861b : Beijing Tele-info Technology Co., Ltd. // https://www.iana.org/domains/root/db/xn--vuq861b.html 信息 // xn--w4r85el8fhu5dnra : Kerry Trading Co. Limited // https://www.iana.org/domains/root/db/xn--w4r85el8fhu5dnra.html 嘉里大酒店 // xn--w4rs40l : Kerry Trading Co. Limited // https://www.iana.org/domains/root/db/xn--w4rs40l.html 嘉里 // xn--xhq521b : Guangzhou YU Wei Information Technology Co., Ltd. // https://www.iana.org/domains/root/db/xn--xhq521b.html 广东 // xn--zfr164b : China Organizational Name Administration Center // https://www.iana.org/domains/root/db/xn--zfr164b.html 政务 // xyz : XYZ.COM LLC // https://www.iana.org/domains/root/db/xyz.html xyz // yachts : XYZ.COM LLC // https://www.iana.org/domains/root/db/yachts.html yachts // yahoo : Yahoo Inc. // https://www.iana.org/domains/root/db/yahoo.html yahoo // yamaxun : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/yamaxun.html yamaxun // yandex : YANDEX, LLC // https://www.iana.org/domains/root/db/yandex.html yandex // yodobashi : YODOBASHI CAMERA CO.,LTD. // https://www.iana.org/domains/root/db/yodobashi.html yodobashi // yoga : Registry Services, LLC // https://www.iana.org/domains/root/db/yoga.html yoga // yokohama : GMO Registry, Inc. // https://www.iana.org/domains/root/db/yokohama.html yokohama // you : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/you.html you // youtube : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/youtube.html youtube // yun : Beijing Qihu Keji Co., Ltd. // https://www.iana.org/domains/root/db/yun.html yun // zappos : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/zappos.html zappos // zara : Industria de Diseño Textil, S.A. (INDITEX, S.A.) // https://www.iana.org/domains/root/db/zara.html zara // zero : Amazon Registry Services, Inc. // https://www.iana.org/domains/root/db/zero.html zero // zip : Charleston Road Registry Inc. // https://www.iana.org/domains/root/db/zip.html zip // zone : Binky Moon, LLC // https://www.iana.org/domains/root/db/zone.html zone // zuerich : Kanton Zürich (Canton of Zurich) // https://www.iana.org/domains/root/db/zuerich.html zuerich // ===END ICANN DOMAINS=== // ===BEGIN PRIVATE DOMAINS=== // (Note: these are in alphabetical order by company name) // .KRD : https://nic.krd co.krd edu.krd // .pl domains (grandfathered) art.pl gliwice.pl krakow.pl poznan.pl wroc.pl zakopane.pl // 12CHARS : https://12chars.com // Submitted by Kenny Niehage 12chars.dev 12chars.it 12chars.pro // 1GB LLC : https://www.1gb.ua/ // Submitted by 1GB LLC cc.ua inf.ua ltd.ua // 611 blockchain domain name system : https://sixone.one/ 611.to // A2 Hosting // Submitted by Tyler Hall a2hosted.com cpserver.com // Acorn Labs : https://acorn.io // Submitted by Craig Jellick *.on-acorn.io // ActiveTrail : https://www.activetrail.biz/ // Submitted by Ofer Kalaora activetrail.biz // Adaptable.io : https://adaptable.io // Submitted by Mark Terrel adaptable.app // addr.tools : https://addr.tools/ // Submitted by Brian Shea myaddr.dev myaddr.io dyn.addr.tools myaddr.tools // Adobe : https://www.adobe.com/ // Submitted by Ian Boston and Lars Trieloff adobeaemcloud.com *.dev.adobeaemcloud.com aem.live hlx.live adobeaemcloud.net aem.network aem.page hlx.page aem.reviews // Adobe Developer Platform : https://developer.adobe.com // Submitted by Jesse MacFadyen adobeio-static.net adobeioruntime.net // Africa.com Web Solutions Ltd : https://registry.africa.com // Submitted by Gavin Brown africa.com // Agnat sp. z o.o. : https://domena.pl // Submitted by Przemyslaw Plewa beep.pl // Aiven : https://aiven.io/ // Submitted by Aiven Security Team aiven.app aivencloud.com // Akamai : https://www.akamai.com/ // Submitted by Akamai Team akadns.net akamai.net akamai-staging.net akamaiedge.net akamaiedge-staging.net akamaihd.net akamaihd-staging.net akamaiorigin.net akamaiorigin-staging.net akamaized.net akamaized-staging.net edgekey.net edgekey-staging.net edgesuite.net edgesuite-staging.net // alboto.ca : http://alboto.ca // Submitted by Anton Avramov barsy.ca // Alces Software Ltd : http://alces-software.com // Submitted by Mark J. Titorenko *.compute.estate *.alces.network // Alibaba Cloud API Gateway // Submitted by Alibaba Cloud Security alibabacloudcs.com // all-inkl.com : https://all-inkl.com // Submitted by Werner Kaltofen kasserver.com // Altervista : https://www.altervista.org // Submitted by Carlo Cannas altervista.org // alwaysdata : https://www.alwaysdata.com // Submitted by Cyril alwaysdata.net // Amaze Software : https://amaze.co // Submitted by Domain Admin myamaze.net // Amazon : https://www.amazon.com/ // Submitted by AWS Security // Subsections of Amazon/subsidiaries will appear until "concludes" tag // Amazon API Gateway // Submitted by AWS Security // Reference: 6a4f5a95-8c7d-4077-a7af-9cf1abec0a53 execute-api.cn-north-1.amazonaws.com.cn execute-api.cn-northwest-1.amazonaws.com.cn execute-api.af-south-1.amazonaws.com execute-api.ap-east-1.amazonaws.com execute-api.ap-northeast-1.amazonaws.com execute-api.ap-northeast-2.amazonaws.com execute-api.ap-northeast-3.amazonaws.com execute-api.ap-south-1.amazonaws.com execute-api.ap-south-2.amazonaws.com execute-api.ap-southeast-1.amazonaws.com execute-api.ap-southeast-2.amazonaws.com execute-api.ap-southeast-3.amazonaws.com execute-api.ap-southeast-4.amazonaws.com execute-api.ap-southeast-5.amazonaws.com execute-api.ca-central-1.amazonaws.com execute-api.ca-west-1.amazonaws.com execute-api.eu-central-1.amazonaws.com execute-api.eu-central-2.amazonaws.com execute-api.eu-north-1.amazonaws.com execute-api.eu-south-1.amazonaws.com execute-api.eu-south-2.amazonaws.com execute-api.eu-west-1.amazonaws.com execute-api.eu-west-2.amazonaws.com execute-api.eu-west-3.amazonaws.com execute-api.il-central-1.amazonaws.com execute-api.me-central-1.amazonaws.com execute-api.me-south-1.amazonaws.com execute-api.sa-east-1.amazonaws.com execute-api.us-east-1.amazonaws.com execute-api.us-east-2.amazonaws.com execute-api.us-gov-east-1.amazonaws.com execute-api.us-gov-west-1.amazonaws.com execute-api.us-west-1.amazonaws.com execute-api.us-west-2.amazonaws.com // Amazon CloudFront // Submitted by Donavan Miller // Reference: 54144616-fd49-4435-8535-19c6a601bdb3 cloudfront.net // Amazon Cognito // Submitted by AWS Security // Reference: e7c02dc1-02f4-4a23-bde3-a8527c830127 auth.af-south-1.amazoncognito.com auth.ap-east-1.amazoncognito.com auth.ap-northeast-1.amazoncognito.com auth.ap-northeast-2.amazoncognito.com auth.ap-northeast-3.amazoncognito.com auth.ap-south-1.amazoncognito.com auth.ap-south-2.amazoncognito.com auth.ap-southeast-1.amazoncognito.com auth.ap-southeast-2.amazoncognito.com auth.ap-southeast-3.amazoncognito.com auth.ap-southeast-4.amazoncognito.com auth.ap-southeast-5.amazoncognito.com auth.ap-southeast-7.amazoncognito.com auth.ca-central-1.amazoncognito.com auth.ca-west-1.amazoncognito.com auth.eu-central-1.amazoncognito.com auth.eu-central-2.amazoncognito.com auth.eu-north-1.amazoncognito.com auth.eu-south-1.amazoncognito.com auth.eu-south-2.amazoncognito.com auth.eu-west-1.amazoncognito.com auth.eu-west-2.amazoncognito.com auth.eu-west-3.amazoncognito.com auth.il-central-1.amazoncognito.com auth.me-central-1.amazoncognito.com auth.me-south-1.amazoncognito.com auth.mx-central-1.amazoncognito.com auth.sa-east-1.amazoncognito.com auth.us-east-1.amazoncognito.com auth-fips.us-east-1.amazoncognito.com auth.us-east-2.amazoncognito.com auth-fips.us-east-2.amazoncognito.com auth-fips.us-gov-east-1.amazoncognito.com auth-fips.us-gov-west-1.amazoncognito.com auth.us-west-1.amazoncognito.com auth-fips.us-west-1.amazoncognito.com auth.us-west-2.amazoncognito.com auth-fips.us-west-2.amazoncognito.com // Amazon EC2 // Submitted by Luke Wells // Reference: 4c38fa71-58ac-4768-99e5-689c1767e537 *.compute.amazonaws.com.cn *.compute.amazonaws.com *.compute-1.amazonaws.com us-east-1.amazonaws.com // Amazon EMR // Submitted by AWS Security // Reference: 82f43f9f-bbb8-400e-8349-854f5a62f20d emrappui-prod.cn-north-1.amazonaws.com.cn emrnotebooks-prod.cn-north-1.amazonaws.com.cn emrstudio-prod.cn-north-1.amazonaws.com.cn emrappui-prod.cn-northwest-1.amazonaws.com.cn emrnotebooks-prod.cn-northwest-1.amazonaws.com.cn emrstudio-prod.cn-northwest-1.amazonaws.com.cn emrappui-prod.af-south-1.amazonaws.com emrnotebooks-prod.af-south-1.amazonaws.com emrstudio-prod.af-south-1.amazonaws.com emrappui-prod.ap-east-1.amazonaws.com emrnotebooks-prod.ap-east-1.amazonaws.com emrstudio-prod.ap-east-1.amazonaws.com emrappui-prod.ap-northeast-1.amazonaws.com emrnotebooks-prod.ap-northeast-1.amazonaws.com emrstudio-prod.ap-northeast-1.amazonaws.com emrappui-prod.ap-northeast-2.amazonaws.com emrnotebooks-prod.ap-northeast-2.amazonaws.com emrstudio-prod.ap-northeast-2.amazonaws.com emrappui-prod.ap-northeast-3.amazonaws.com emrnotebooks-prod.ap-northeast-3.amazonaws.com emrstudio-prod.ap-northeast-3.amazonaws.com emrappui-prod.ap-south-1.amazonaws.com emrnotebooks-prod.ap-south-1.amazonaws.com emrstudio-prod.ap-south-1.amazonaws.com emrappui-prod.ap-south-2.amazonaws.com emrnotebooks-prod.ap-south-2.amazonaws.com emrstudio-prod.ap-south-2.amazonaws.com emrappui-prod.ap-southeast-1.amazonaws.com emrnotebooks-prod.ap-southeast-1.amazonaws.com emrstudio-prod.ap-southeast-1.amazonaws.com emrappui-prod.ap-southeast-2.amazonaws.com emrnotebooks-prod.ap-southeast-2.amazonaws.com emrstudio-prod.ap-southeast-2.amazonaws.com emrappui-prod.ap-southeast-3.amazonaws.com emrnotebooks-prod.ap-southeast-3.amazonaws.com emrstudio-prod.ap-southeast-3.amazonaws.com emrappui-prod.ap-southeast-4.amazonaws.com emrnotebooks-prod.ap-southeast-4.amazonaws.com emrstudio-prod.ap-southeast-4.amazonaws.com emrappui-prod.ca-central-1.amazonaws.com emrnotebooks-prod.ca-central-1.amazonaws.com emrstudio-prod.ca-central-1.amazonaws.com emrappui-prod.ca-west-1.amazonaws.com emrnotebooks-prod.ca-west-1.amazonaws.com emrstudio-prod.ca-west-1.amazonaws.com emrappui-prod.eu-central-1.amazonaws.com emrnotebooks-prod.eu-central-1.amazonaws.com emrstudio-prod.eu-central-1.amazonaws.com emrappui-prod.eu-central-2.amazonaws.com emrnotebooks-prod.eu-central-2.amazonaws.com emrstudio-prod.eu-central-2.amazonaws.com emrappui-prod.eu-north-1.amazonaws.com emrnotebooks-prod.eu-north-1.amazonaws.com emrstudio-prod.eu-north-1.amazonaws.com emrappui-prod.eu-south-1.amazonaws.com emrnotebooks-prod.eu-south-1.amazonaws.com emrstudio-prod.eu-south-1.amazonaws.com emrappui-prod.eu-south-2.amazonaws.com emrnotebooks-prod.eu-south-2.amazonaws.com emrstudio-prod.eu-south-2.amazonaws.com emrappui-prod.eu-west-1.amazonaws.com emrnotebooks-prod.eu-west-1.amazonaws.com emrstudio-prod.eu-west-1.amazonaws.com emrappui-prod.eu-west-2.amazonaws.com emrnotebooks-prod.eu-west-2.amazonaws.com emrstudio-prod.eu-west-2.amazonaws.com emrappui-prod.eu-west-3.amazonaws.com emrnotebooks-prod.eu-west-3.amazonaws.com emrstudio-prod.eu-west-3.amazonaws.com emrappui-prod.il-central-1.amazonaws.com emrnotebooks-prod.il-central-1.amazonaws.com emrstudio-prod.il-central-1.amazonaws.com emrappui-prod.me-central-1.amazonaws.com emrnotebooks-prod.me-central-1.amazonaws.com emrstudio-prod.me-central-1.amazonaws.com emrappui-prod.me-south-1.amazonaws.com emrnotebooks-prod.me-south-1.amazonaws.com emrstudio-prod.me-south-1.amazonaws.com emrappui-prod.sa-east-1.amazonaws.com emrnotebooks-prod.sa-east-1.amazonaws.com emrstudio-prod.sa-east-1.amazonaws.com emrappui-prod.us-east-1.amazonaws.com emrnotebooks-prod.us-east-1.amazonaws.com emrstudio-prod.us-east-1.amazonaws.com emrappui-prod.us-east-2.amazonaws.com emrnotebooks-prod.us-east-2.amazonaws.com emrstudio-prod.us-east-2.amazonaws.com emrappui-prod.us-gov-east-1.amazonaws.com emrnotebooks-prod.us-gov-east-1.amazonaws.com emrstudio-prod.us-gov-east-1.amazonaws.com emrappui-prod.us-gov-west-1.amazonaws.com emrnotebooks-prod.us-gov-west-1.amazonaws.com emrstudio-prod.us-gov-west-1.amazonaws.com emrappui-prod.us-west-1.amazonaws.com emrnotebooks-prod.us-west-1.amazonaws.com emrstudio-prod.us-west-1.amazonaws.com emrappui-prod.us-west-2.amazonaws.com emrnotebooks-prod.us-west-2.amazonaws.com emrstudio-prod.us-west-2.amazonaws.com // Amazon Managed Workflows for Apache Airflow // Submitted by AWS Security // Reference: 2f697e23-58d6-4b97-be6b-77a26e811dad *.airflow.af-south-1.on.aws *.airflow.ap-east-1.on.aws *.airflow.ap-northeast-1.on.aws *.airflow.ap-northeast-2.on.aws *.airflow.ap-northeast-3.on.aws *.airflow.ap-south-1.on.aws *.airflow.ap-south-2.on.aws *.airflow.ap-southeast-1.on.aws *.airflow.ap-southeast-2.on.aws *.airflow.ap-southeast-3.on.aws *.airflow.ap-southeast-4.on.aws *.airflow.ap-southeast-5.on.aws *.airflow.ca-central-1.on.aws *.airflow.ca-west-1.on.aws *.airflow.eu-central-1.on.aws *.airflow.eu-central-2.on.aws *.airflow.eu-north-1.on.aws *.airflow.eu-south-1.on.aws *.airflow.eu-south-2.on.aws *.airflow.eu-west-1.on.aws *.airflow.eu-west-2.on.aws *.airflow.eu-west-3.on.aws *.airflow.il-central-1.on.aws *.airflow.me-central-1.on.aws *.airflow.me-south-1.on.aws *.airflow.sa-east-1.on.aws *.airflow.us-east-1.on.aws *.airflow.us-east-2.on.aws *.airflow.us-west-1.on.aws *.airflow.us-west-2.on.aws *.cn-north-1.airflow.amazonaws.com.cn *.cn-northwest-1.airflow.amazonaws.com.cn *.airflow.cn-north-1.on.amazonwebservices.com.cn *.airflow.cn-northwest-1.on.amazonwebservices.com.cn *.af-south-1.airflow.amazonaws.com *.ap-east-1.airflow.amazonaws.com *.ap-northeast-1.airflow.amazonaws.com *.ap-northeast-2.airflow.amazonaws.com *.ap-northeast-3.airflow.amazonaws.com *.ap-south-1.airflow.amazonaws.com *.ap-south-2.airflow.amazonaws.com *.ap-southeast-1.airflow.amazonaws.com *.ap-southeast-2.airflow.amazonaws.com *.ap-southeast-3.airflow.amazonaws.com *.ap-southeast-4.airflow.amazonaws.com *.ap-southeast-5.airflow.amazonaws.com *.ca-central-1.airflow.amazonaws.com *.ca-west-1.airflow.amazonaws.com *.eu-central-1.airflow.amazonaws.com *.eu-central-2.airflow.amazonaws.com *.eu-north-1.airflow.amazonaws.com *.eu-south-1.airflow.amazonaws.com *.eu-south-2.airflow.amazonaws.com *.eu-west-1.airflow.amazonaws.com *.eu-west-2.airflow.amazonaws.com *.eu-west-3.airflow.amazonaws.com *.il-central-1.airflow.amazonaws.com *.me-central-1.airflow.amazonaws.com *.me-south-1.airflow.amazonaws.com *.sa-east-1.airflow.amazonaws.com *.us-east-1.airflow.amazonaws.com *.us-east-2.airflow.amazonaws.com *.us-west-1.airflow.amazonaws.com *.us-west-2.airflow.amazonaws.com // Amazon S3 // Submitted by AWS Security // Reference: ada5c9df-55e1-4195-a1ce-732d6c81e357 s3.dualstack.cn-north-1.amazonaws.com.cn s3-accesspoint.dualstack.cn-north-1.amazonaws.com.cn s3-website.dualstack.cn-north-1.amazonaws.com.cn s3.cn-north-1.amazonaws.com.cn s3-accesspoint.cn-north-1.amazonaws.com.cn s3-deprecated.cn-north-1.amazonaws.com.cn s3-object-lambda.cn-north-1.amazonaws.com.cn s3-website.cn-north-1.amazonaws.com.cn s3.dualstack.cn-northwest-1.amazonaws.com.cn s3-accesspoint.dualstack.cn-northwest-1.amazonaws.com.cn s3.cn-northwest-1.amazonaws.com.cn s3-accesspoint.cn-northwest-1.amazonaws.com.cn s3-object-lambda.cn-northwest-1.amazonaws.com.cn s3-website.cn-northwest-1.amazonaws.com.cn s3.dualstack.af-south-1.amazonaws.com s3-accesspoint.dualstack.af-south-1.amazonaws.com s3-website.dualstack.af-south-1.amazonaws.com s3.af-south-1.amazonaws.com s3-accesspoint.af-south-1.amazonaws.com s3-object-lambda.af-south-1.amazonaws.com s3-website.af-south-1.amazonaws.com s3.dualstack.ap-east-1.amazonaws.com s3-accesspoint.dualstack.ap-east-1.amazonaws.com s3.ap-east-1.amazonaws.com s3-accesspoint.ap-east-1.amazonaws.com s3-object-lambda.ap-east-1.amazonaws.com s3-website.ap-east-1.amazonaws.com s3.dualstack.ap-northeast-1.amazonaws.com s3-accesspoint.dualstack.ap-northeast-1.amazonaws.com s3-website.dualstack.ap-northeast-1.amazonaws.com s3.ap-northeast-1.amazonaws.com s3-accesspoint.ap-northeast-1.amazonaws.com s3-object-lambda.ap-northeast-1.amazonaws.com s3-website.ap-northeast-1.amazonaws.com s3.dualstack.ap-northeast-2.amazonaws.com s3-accesspoint.dualstack.ap-northeast-2.amazonaws.com s3-website.dualstack.ap-northeast-2.amazonaws.com s3.ap-northeast-2.amazonaws.com s3-accesspoint.ap-northeast-2.amazonaws.com s3-object-lambda.ap-northeast-2.amazonaws.com s3-website.ap-northeast-2.amazonaws.com s3.dualstack.ap-northeast-3.amazonaws.com s3-accesspoint.dualstack.ap-northeast-3.amazonaws.com s3-website.dualstack.ap-northeast-3.amazonaws.com s3.ap-northeast-3.amazonaws.com s3-accesspoint.ap-northeast-3.amazonaws.com s3-object-lambda.ap-northeast-3.amazonaws.com s3-website.ap-northeast-3.amazonaws.com s3.dualstack.ap-south-1.amazonaws.com s3-accesspoint.dualstack.ap-south-1.amazonaws.com s3-website.dualstack.ap-south-1.amazonaws.com s3.ap-south-1.amazonaws.com s3-accesspoint.ap-south-1.amazonaws.com s3-object-lambda.ap-south-1.amazonaws.com s3-website.ap-south-1.amazonaws.com s3.dualstack.ap-south-2.amazonaws.com s3-accesspoint.dualstack.ap-south-2.amazonaws.com s3-website.dualstack.ap-south-2.amazonaws.com s3.ap-south-2.amazonaws.com s3-accesspoint.ap-south-2.amazonaws.com s3-object-lambda.ap-south-2.amazonaws.com s3-website.ap-south-2.amazonaws.com s3.dualstack.ap-southeast-1.amazonaws.com s3-accesspoint.dualstack.ap-southeast-1.amazonaws.com s3-website.dualstack.ap-southeast-1.amazonaws.com s3.ap-southeast-1.amazonaws.com s3-accesspoint.ap-southeast-1.amazonaws.com s3-object-lambda.ap-southeast-1.amazonaws.com s3-website.ap-southeast-1.amazonaws.com s3.dualstack.ap-southeast-2.amazonaws.com s3-accesspoint.dualstack.ap-southeast-2.amazonaws.com s3-website.dualstack.ap-southeast-2.amazonaws.com s3.ap-southeast-2.amazonaws.com s3-accesspoint.ap-southeast-2.amazonaws.com s3-object-lambda.ap-southeast-2.amazonaws.com s3-website.ap-southeast-2.amazonaws.com s3.dualstack.ap-southeast-3.amazonaws.com s3-accesspoint.dualstack.ap-southeast-3.amazonaws.com s3-website.dualstack.ap-southeast-3.amazonaws.com s3.ap-southeast-3.amazonaws.com s3-accesspoint.ap-southeast-3.amazonaws.com s3-object-lambda.ap-southeast-3.amazonaws.com s3-website.ap-southeast-3.amazonaws.com s3.dualstack.ap-southeast-4.amazonaws.com s3-accesspoint.dualstack.ap-southeast-4.amazonaws.com s3-website.dualstack.ap-southeast-4.amazonaws.com s3.ap-southeast-4.amazonaws.com s3-accesspoint.ap-southeast-4.amazonaws.com s3-object-lambda.ap-southeast-4.amazonaws.com s3-website.ap-southeast-4.amazonaws.com s3.dualstack.ap-southeast-5.amazonaws.com s3-accesspoint.dualstack.ap-southeast-5.amazonaws.com s3-website.dualstack.ap-southeast-5.amazonaws.com s3.ap-southeast-5.amazonaws.com s3-accesspoint.ap-southeast-5.amazonaws.com s3-deprecated.ap-southeast-5.amazonaws.com s3-object-lambda.ap-southeast-5.amazonaws.com s3-website.ap-southeast-5.amazonaws.com s3.dualstack.ca-central-1.amazonaws.com s3-accesspoint.dualstack.ca-central-1.amazonaws.com s3-accesspoint-fips.dualstack.ca-central-1.amazonaws.com s3-fips.dualstack.ca-central-1.amazonaws.com s3-website.dualstack.ca-central-1.amazonaws.com s3.ca-central-1.amazonaws.com s3-accesspoint.ca-central-1.amazonaws.com s3-accesspoint-fips.ca-central-1.amazonaws.com s3-fips.ca-central-1.amazonaws.com s3-object-lambda.ca-central-1.amazonaws.com s3-website.ca-central-1.amazonaws.com s3.dualstack.ca-west-1.amazonaws.com s3-accesspoint.dualstack.ca-west-1.amazonaws.com s3-accesspoint-fips.dualstack.ca-west-1.amazonaws.com s3-fips.dualstack.ca-west-1.amazonaws.com s3-website.dualstack.ca-west-1.amazonaws.com s3.ca-west-1.amazonaws.com s3-accesspoint.ca-west-1.amazonaws.com s3-accesspoint-fips.ca-west-1.amazonaws.com s3-fips.ca-west-1.amazonaws.com s3-object-lambda.ca-west-1.amazonaws.com s3-website.ca-west-1.amazonaws.com s3.dualstack.eu-central-1.amazonaws.com s3-accesspoint.dualstack.eu-central-1.amazonaws.com s3-website.dualstack.eu-central-1.amazonaws.com s3.eu-central-1.amazonaws.com s3-accesspoint.eu-central-1.amazonaws.com s3-object-lambda.eu-central-1.amazonaws.com s3-website.eu-central-1.amazonaws.com s3.dualstack.eu-central-2.amazonaws.com s3-accesspoint.dualstack.eu-central-2.amazonaws.com s3-website.dualstack.eu-central-2.amazonaws.com s3.eu-central-2.amazonaws.com s3-accesspoint.eu-central-2.amazonaws.com s3-object-lambda.eu-central-2.amazonaws.com s3-website.eu-central-2.amazonaws.com s3.dualstack.eu-north-1.amazonaws.com s3-accesspoint.dualstack.eu-north-1.amazonaws.com s3.eu-north-1.amazonaws.com s3-accesspoint.eu-north-1.amazonaws.com s3-object-lambda.eu-north-1.amazonaws.com s3-website.eu-north-1.amazonaws.com s3.dualstack.eu-south-1.amazonaws.com s3-accesspoint.dualstack.eu-south-1.amazonaws.com s3-website.dualstack.eu-south-1.amazonaws.com s3.eu-south-1.amazonaws.com s3-accesspoint.eu-south-1.amazonaws.com s3-object-lambda.eu-south-1.amazonaws.com s3-website.eu-south-1.amazonaws.com s3.dualstack.eu-south-2.amazonaws.com s3-accesspoint.dualstack.eu-south-2.amazonaws.com s3-website.dualstack.eu-south-2.amazonaws.com s3.eu-south-2.amazonaws.com s3-accesspoint.eu-south-2.amazonaws.com s3-object-lambda.eu-south-2.amazonaws.com s3-website.eu-south-2.amazonaws.com s3.dualstack.eu-west-1.amazonaws.com s3-accesspoint.dualstack.eu-west-1.amazonaws.com s3-website.dualstack.eu-west-1.amazonaws.com s3.eu-west-1.amazonaws.com s3-accesspoint.eu-west-1.amazonaws.com s3-deprecated.eu-west-1.amazonaws.com s3-object-lambda.eu-west-1.amazonaws.com s3-website.eu-west-1.amazonaws.com s3.dualstack.eu-west-2.amazonaws.com s3-accesspoint.dualstack.eu-west-2.amazonaws.com s3.eu-west-2.amazonaws.com s3-accesspoint.eu-west-2.amazonaws.com s3-object-lambda.eu-west-2.amazonaws.com s3-website.eu-west-2.amazonaws.com s3.dualstack.eu-west-3.amazonaws.com s3-accesspoint.dualstack.eu-west-3.amazonaws.com s3-website.dualstack.eu-west-3.amazonaws.com s3.eu-west-3.amazonaws.com s3-accesspoint.eu-west-3.amazonaws.com s3-object-lambda.eu-west-3.amazonaws.com s3-website.eu-west-3.amazonaws.com s3.dualstack.il-central-1.amazonaws.com s3-accesspoint.dualstack.il-central-1.amazonaws.com s3-website.dualstack.il-central-1.amazonaws.com s3.il-central-1.amazonaws.com s3-accesspoint.il-central-1.amazonaws.com s3-object-lambda.il-central-1.amazonaws.com s3-website.il-central-1.amazonaws.com s3.dualstack.me-central-1.amazonaws.com s3-accesspoint.dualstack.me-central-1.amazonaws.com s3-website.dualstack.me-central-1.amazonaws.com s3.me-central-1.amazonaws.com s3-accesspoint.me-central-1.amazonaws.com s3-object-lambda.me-central-1.amazonaws.com s3-website.me-central-1.amazonaws.com s3.dualstack.me-south-1.amazonaws.com s3-accesspoint.dualstack.me-south-1.amazonaws.com s3.me-south-1.amazonaws.com s3-accesspoint.me-south-1.amazonaws.com s3-object-lambda.me-south-1.amazonaws.com s3-website.me-south-1.amazonaws.com s3.amazonaws.com s3-1.amazonaws.com s3-ap-east-1.amazonaws.com s3-ap-northeast-1.amazonaws.com s3-ap-northeast-2.amazonaws.com s3-ap-northeast-3.amazonaws.com s3-ap-south-1.amazonaws.com s3-ap-southeast-1.amazonaws.com s3-ap-southeast-2.amazonaws.com s3-ca-central-1.amazonaws.com s3-eu-central-1.amazonaws.com s3-eu-north-1.amazonaws.com s3-eu-west-1.amazonaws.com s3-eu-west-2.amazonaws.com s3-eu-west-3.amazonaws.com s3-external-1.amazonaws.com s3-fips-us-gov-east-1.amazonaws.com s3-fips-us-gov-west-1.amazonaws.com mrap.accesspoint.s3-global.amazonaws.com s3-me-south-1.amazonaws.com s3-sa-east-1.amazonaws.com s3-us-east-2.amazonaws.com s3-us-gov-east-1.amazonaws.com s3-us-gov-west-1.amazonaws.com s3-us-west-1.amazonaws.com s3-us-west-2.amazonaws.com s3-website-ap-northeast-1.amazonaws.com s3-website-ap-southeast-1.amazonaws.com s3-website-ap-southeast-2.amazonaws.com s3-website-eu-west-1.amazonaws.com s3-website-sa-east-1.amazonaws.com s3-website-us-east-1.amazonaws.com s3-website-us-gov-west-1.amazonaws.com s3-website-us-west-1.amazonaws.com s3-website-us-west-2.amazonaws.com s3.dualstack.sa-east-1.amazonaws.com s3-accesspoint.dualstack.sa-east-1.amazonaws.com s3-website.dualstack.sa-east-1.amazonaws.com s3.sa-east-1.amazonaws.com s3-accesspoint.sa-east-1.amazonaws.com s3-object-lambda.sa-east-1.amazonaws.com s3-website.sa-east-1.amazonaws.com s3.dualstack.us-east-1.amazonaws.com s3-accesspoint.dualstack.us-east-1.amazonaws.com s3-accesspoint-fips.dualstack.us-east-1.amazonaws.com s3-fips.dualstack.us-east-1.amazonaws.com s3-website.dualstack.us-east-1.amazonaws.com s3.us-east-1.amazonaws.com s3-accesspoint.us-east-1.amazonaws.com s3-accesspoint-fips.us-east-1.amazonaws.com s3-deprecated.us-east-1.amazonaws.com s3-fips.us-east-1.amazonaws.com s3-object-lambda.us-east-1.amazonaws.com s3-website.us-east-1.amazonaws.com s3.dualstack.us-east-2.amazonaws.com s3-accesspoint.dualstack.us-east-2.amazonaws.com s3-accesspoint-fips.dualstack.us-east-2.amazonaws.com s3-fips.dualstack.us-east-2.amazonaws.com s3-website.dualstack.us-east-2.amazonaws.com s3.us-east-2.amazonaws.com s3-accesspoint.us-east-2.amazonaws.com s3-accesspoint-fips.us-east-2.amazonaws.com s3-deprecated.us-east-2.amazonaws.com s3-fips.us-east-2.amazonaws.com s3-object-lambda.us-east-2.amazonaws.com s3-website.us-east-2.amazonaws.com s3.dualstack.us-gov-east-1.amazonaws.com s3-accesspoint.dualstack.us-gov-east-1.amazonaws.com s3-accesspoint-fips.dualstack.us-gov-east-1.amazonaws.com s3-fips.dualstack.us-gov-east-1.amazonaws.com s3.us-gov-east-1.amazonaws.com s3-accesspoint.us-gov-east-1.amazonaws.com s3-accesspoint-fips.us-gov-east-1.amazonaws.com s3-fips.us-gov-east-1.amazonaws.com s3-object-lambda.us-gov-east-1.amazonaws.com s3-website.us-gov-east-1.amazonaws.com s3.dualstack.us-gov-west-1.amazonaws.com s3-accesspoint.dualstack.us-gov-west-1.amazonaws.com s3-accesspoint-fips.dualstack.us-gov-west-1.amazonaws.com s3-fips.dualstack.us-gov-west-1.amazonaws.com s3.us-gov-west-1.amazonaws.com s3-accesspoint.us-gov-west-1.amazonaws.com s3-accesspoint-fips.us-gov-west-1.amazonaws.com s3-fips.us-gov-west-1.amazonaws.com s3-object-lambda.us-gov-west-1.amazonaws.com s3-website.us-gov-west-1.amazonaws.com s3.dualstack.us-west-1.amazonaws.com s3-accesspoint.dualstack.us-west-1.amazonaws.com s3-accesspoint-fips.dualstack.us-west-1.amazonaws.com s3-fips.dualstack.us-west-1.amazonaws.com s3-website.dualstack.us-west-1.amazonaws.com s3.us-west-1.amazonaws.com s3-accesspoint.us-west-1.amazonaws.com s3-accesspoint-fips.us-west-1.amazonaws.com s3-fips.us-west-1.amazonaws.com s3-object-lambda.us-west-1.amazonaws.com s3-website.us-west-1.amazonaws.com s3.dualstack.us-west-2.amazonaws.com s3-accesspoint.dualstack.us-west-2.amazonaws.com s3-accesspoint-fips.dualstack.us-west-2.amazonaws.com s3-fips.dualstack.us-west-2.amazonaws.com s3-website.dualstack.us-west-2.amazonaws.com s3.us-west-2.amazonaws.com s3-accesspoint.us-west-2.amazonaws.com s3-accesspoint-fips.us-west-2.amazonaws.com s3-deprecated.us-west-2.amazonaws.com s3-fips.us-west-2.amazonaws.com s3-object-lambda.us-west-2.amazonaws.com s3-website.us-west-2.amazonaws.com // Amazon SageMaker Ground Truth // Submitted by AWS Security // Reference: 98dbfde4-7802-48c3-8751-b60f204e0d9c labeling.ap-northeast-1.sagemaker.aws labeling.ap-northeast-2.sagemaker.aws labeling.ap-south-1.sagemaker.aws labeling.ap-southeast-1.sagemaker.aws labeling.ap-southeast-2.sagemaker.aws labeling.ca-central-1.sagemaker.aws labeling.eu-central-1.sagemaker.aws labeling.eu-west-1.sagemaker.aws labeling.eu-west-2.sagemaker.aws labeling.us-east-1.sagemaker.aws labeling.us-east-2.sagemaker.aws labeling.us-west-2.sagemaker.aws // Amazon SageMaker Notebook Instances // Submitted by AWS Security // Reference: b5ea56df-669e-43cc-9537-14aa172f5dfc notebook.af-south-1.sagemaker.aws notebook.ap-east-1.sagemaker.aws notebook.ap-northeast-1.sagemaker.aws notebook.ap-northeast-2.sagemaker.aws notebook.ap-northeast-3.sagemaker.aws notebook.ap-south-1.sagemaker.aws notebook.ap-south-2.sagemaker.aws notebook.ap-southeast-1.sagemaker.aws notebook.ap-southeast-2.sagemaker.aws notebook.ap-southeast-3.sagemaker.aws notebook.ap-southeast-4.sagemaker.aws notebook.ca-central-1.sagemaker.aws notebook-fips.ca-central-1.sagemaker.aws notebook.ca-west-1.sagemaker.aws notebook-fips.ca-west-1.sagemaker.aws notebook.eu-central-1.sagemaker.aws notebook.eu-central-2.sagemaker.aws notebook.eu-north-1.sagemaker.aws notebook.eu-south-1.sagemaker.aws notebook.eu-south-2.sagemaker.aws notebook.eu-west-1.sagemaker.aws notebook.eu-west-2.sagemaker.aws notebook.eu-west-3.sagemaker.aws notebook.il-central-1.sagemaker.aws notebook.me-central-1.sagemaker.aws notebook.me-south-1.sagemaker.aws notebook.sa-east-1.sagemaker.aws notebook.us-east-1.sagemaker.aws notebook-fips.us-east-1.sagemaker.aws notebook.us-east-2.sagemaker.aws notebook-fips.us-east-2.sagemaker.aws notebook.us-gov-east-1.sagemaker.aws notebook-fips.us-gov-east-1.sagemaker.aws notebook.us-gov-west-1.sagemaker.aws notebook-fips.us-gov-west-1.sagemaker.aws notebook.us-west-1.sagemaker.aws notebook-fips.us-west-1.sagemaker.aws notebook.us-west-2.sagemaker.aws notebook-fips.us-west-2.sagemaker.aws notebook.cn-north-1.sagemaker.com.cn notebook.cn-northwest-1.sagemaker.com.cn // Amazon SageMaker Studio // Submitted by AWS Security // Reference: 475f237e-ab88-4041-9f41-7cfccdf66aeb studio.af-south-1.sagemaker.aws studio.ap-east-1.sagemaker.aws studio.ap-northeast-1.sagemaker.aws studio.ap-northeast-2.sagemaker.aws studio.ap-northeast-3.sagemaker.aws studio.ap-south-1.sagemaker.aws studio.ap-southeast-1.sagemaker.aws studio.ap-southeast-2.sagemaker.aws studio.ap-southeast-3.sagemaker.aws studio.ca-central-1.sagemaker.aws studio.eu-central-1.sagemaker.aws studio.eu-central-2.sagemaker.aws studio.eu-north-1.sagemaker.aws studio.eu-south-1.sagemaker.aws studio.eu-south-2.sagemaker.aws studio.eu-west-1.sagemaker.aws studio.eu-west-2.sagemaker.aws studio.eu-west-3.sagemaker.aws studio.il-central-1.sagemaker.aws studio.me-central-1.sagemaker.aws studio.me-south-1.sagemaker.aws studio.sa-east-1.sagemaker.aws studio.us-east-1.sagemaker.aws studio.us-east-2.sagemaker.aws studio.us-gov-east-1.sagemaker.aws studio-fips.us-gov-east-1.sagemaker.aws studio.us-gov-west-1.sagemaker.aws studio-fips.us-gov-west-1.sagemaker.aws studio.us-west-1.sagemaker.aws studio.us-west-2.sagemaker.aws studio.cn-north-1.sagemaker.com.cn studio.cn-northwest-1.sagemaker.com.cn // Amazon SageMaker with MLflow // Submited by: AWS Security // Reference: c19f92b3-a82a-452d-8189-831b572eea7e *.experiments.sagemaker.aws // Analytics on AWS // Submitted by AWS Security // Reference: 955f9f40-a495-4e73-ae85-67b77ac9cadd analytics-gateway.ap-northeast-1.amazonaws.com analytics-gateway.ap-northeast-2.amazonaws.com analytics-gateway.ap-south-1.amazonaws.com analytics-gateway.ap-southeast-1.amazonaws.com analytics-gateway.ap-southeast-2.amazonaws.com analytics-gateway.eu-central-1.amazonaws.com analytics-gateway.eu-west-1.amazonaws.com analytics-gateway.us-east-1.amazonaws.com analytics-gateway.us-east-2.amazonaws.com analytics-gateway.us-west-2.amazonaws.com // AWS Amplify // Submitted by AWS Security // Reference: c35bed18-6f4f-424f-9298-5756f2f7d72b amplifyapp.com // AWS App Runner // Submitted by AWS Security // Reference: 6828c008-ba5d-442f-ade5-48da4e7c2316 *.awsapprunner.com // AWS Cloud9 // Submitted by: AWS Security // Reference: 30717f72-4007-4f0f-8ed4-864c6f2efec9 webview-assets.aws-cloud9.af-south-1.amazonaws.com vfs.cloud9.af-south-1.amazonaws.com webview-assets.cloud9.af-south-1.amazonaws.com webview-assets.aws-cloud9.ap-east-1.amazonaws.com vfs.cloud9.ap-east-1.amazonaws.com webview-assets.cloud9.ap-east-1.amazonaws.com webview-assets.aws-cloud9.ap-northeast-1.amazonaws.com vfs.cloud9.ap-northeast-1.amazonaws.com webview-assets.cloud9.ap-northeast-1.amazonaws.com webview-assets.aws-cloud9.ap-northeast-2.amazonaws.com vfs.cloud9.ap-northeast-2.amazonaws.com webview-assets.cloud9.ap-northeast-2.amazonaws.com webview-assets.aws-cloud9.ap-northeast-3.amazonaws.com vfs.cloud9.ap-northeast-3.amazonaws.com webview-assets.cloud9.ap-northeast-3.amazonaws.com webview-assets.aws-cloud9.ap-south-1.amazonaws.com vfs.cloud9.ap-south-1.amazonaws.com webview-assets.cloud9.ap-south-1.amazonaws.com webview-assets.aws-cloud9.ap-southeast-1.amazonaws.com vfs.cloud9.ap-southeast-1.amazonaws.com webview-assets.cloud9.ap-southeast-1.amazonaws.com webview-assets.aws-cloud9.ap-southeast-2.amazonaws.com vfs.cloud9.ap-southeast-2.amazonaws.com webview-assets.cloud9.ap-southeast-2.amazonaws.com webview-assets.aws-cloud9.ca-central-1.amazonaws.com vfs.cloud9.ca-central-1.amazonaws.com webview-assets.cloud9.ca-central-1.amazonaws.com webview-assets.aws-cloud9.eu-central-1.amazonaws.com vfs.cloud9.eu-central-1.amazonaws.com webview-assets.cloud9.eu-central-1.amazonaws.com webview-assets.aws-cloud9.eu-north-1.amazonaws.com vfs.cloud9.eu-north-1.amazonaws.com webview-assets.cloud9.eu-north-1.amazonaws.com webview-assets.aws-cloud9.eu-south-1.amazonaws.com vfs.cloud9.eu-south-1.amazonaws.com webview-assets.cloud9.eu-south-1.amazonaws.com webview-assets.aws-cloud9.eu-west-1.amazonaws.com vfs.cloud9.eu-west-1.amazonaws.com webview-assets.cloud9.eu-west-1.amazonaws.com webview-assets.aws-cloud9.eu-west-2.amazonaws.com vfs.cloud9.eu-west-2.amazonaws.com webview-assets.cloud9.eu-west-2.amazonaws.com webview-assets.aws-cloud9.eu-west-3.amazonaws.com vfs.cloud9.eu-west-3.amazonaws.com webview-assets.cloud9.eu-west-3.amazonaws.com webview-assets.aws-cloud9.il-central-1.amazonaws.com vfs.cloud9.il-central-1.amazonaws.com webview-assets.aws-cloud9.me-south-1.amazonaws.com vfs.cloud9.me-south-1.amazonaws.com webview-assets.cloud9.me-south-1.amazonaws.com webview-assets.aws-cloud9.sa-east-1.amazonaws.com vfs.cloud9.sa-east-1.amazonaws.com webview-assets.cloud9.sa-east-1.amazonaws.com webview-assets.aws-cloud9.us-east-1.amazonaws.com vfs.cloud9.us-east-1.amazonaws.com webview-assets.cloud9.us-east-1.amazonaws.com webview-assets.aws-cloud9.us-east-2.amazonaws.com vfs.cloud9.us-east-2.amazonaws.com webview-assets.cloud9.us-east-2.amazonaws.com webview-assets.aws-cloud9.us-west-1.amazonaws.com vfs.cloud9.us-west-1.amazonaws.com webview-assets.cloud9.us-west-1.amazonaws.com webview-assets.aws-cloud9.us-west-2.amazonaws.com vfs.cloud9.us-west-2.amazonaws.com webview-assets.cloud9.us-west-2.amazonaws.com // AWS Directory Service // Submitted by AWS Security // Reference: a13203e8-42dc-4045-a0d2-2ee67bed1068 awsapps.com // AWS Elastic Beanstalk // Submitted by AWS Security // Reference: bb5a965c-dec3-4967-aa22-e306ad064797 cn-north-1.eb.amazonaws.com.cn cn-northwest-1.eb.amazonaws.com.cn elasticbeanstalk.com af-south-1.elasticbeanstalk.com ap-east-1.elasticbeanstalk.com ap-northeast-1.elasticbeanstalk.com ap-northeast-2.elasticbeanstalk.com ap-northeast-3.elasticbeanstalk.com ap-south-1.elasticbeanstalk.com ap-southeast-1.elasticbeanstalk.com ap-southeast-2.elasticbeanstalk.com ap-southeast-3.elasticbeanstalk.com ca-central-1.elasticbeanstalk.com eu-central-1.elasticbeanstalk.com eu-north-1.elasticbeanstalk.com eu-south-1.elasticbeanstalk.com eu-west-1.elasticbeanstalk.com eu-west-2.elasticbeanstalk.com eu-west-3.elasticbeanstalk.com il-central-1.elasticbeanstalk.com me-south-1.elasticbeanstalk.com sa-east-1.elasticbeanstalk.com us-east-1.elasticbeanstalk.com us-east-2.elasticbeanstalk.com us-gov-east-1.elasticbeanstalk.com us-gov-west-1.elasticbeanstalk.com us-west-1.elasticbeanstalk.com us-west-2.elasticbeanstalk.com // (AWS) Elastic Load Balancing // Submitted by Luke Wells // Reference: 12a3d528-1bac-4433-a359-a395867ffed2 *.elb.amazonaws.com.cn *.elb.amazonaws.com // AWS Global Accelerator // Submitted by Daniel Massaguer // Reference: d916759d-a08b-4241-b536-4db887383a6a awsglobalaccelerator.com // AWS re:Post Private // Submitted by AWS Security // Reference: 83385945-225f-416e-9aa0-ad0632bfdcee *.private.repost.aws // AWS Transfer Family web apps // Submitted by AWS Security // Reference: 57a658c4-8899-410c-aa24-5b01e4a178d2 transfer-webapp.af-south-1.on.aws transfer-webapp.ap-east-1.on.aws transfer-webapp.ap-northeast-1.on.aws transfer-webapp.ap-northeast-2.on.aws transfer-webapp.ap-northeast-3.on.aws transfer-webapp.ap-south-1.on.aws transfer-webapp.ap-south-2.on.aws transfer-webapp.ap-southeast-1.on.aws transfer-webapp.ap-southeast-2.on.aws transfer-webapp.ap-southeast-3.on.aws transfer-webapp.ap-southeast-4.on.aws transfer-webapp.ap-southeast-5.on.aws transfer-webapp.ca-central-1.on.aws transfer-webapp.ca-west-1.on.aws transfer-webapp.eu-central-1.on.aws transfer-webapp.eu-central-2.on.aws transfer-webapp.eu-north-1.on.aws transfer-webapp.eu-south-1.on.aws transfer-webapp.eu-south-2.on.aws transfer-webapp.eu-west-1.on.aws transfer-webapp.eu-west-2.on.aws transfer-webapp.eu-west-3.on.aws transfer-webapp.il-central-1.on.aws transfer-webapp.me-central-1.on.aws transfer-webapp.me-south-1.on.aws transfer-webapp.sa-east-1.on.aws transfer-webapp.us-east-1.on.aws transfer-webapp.us-east-2.on.aws transfer-webapp.us-gov-east-1.on.aws transfer-webapp-fips.us-gov-east-1.on.aws transfer-webapp.us-gov-west-1.on.aws transfer-webapp-fips.us-gov-west-1.on.aws transfer-webapp.us-west-1.on.aws transfer-webapp.us-west-2.on.aws transfer-webapp.cn-north-1.on.amazonwebservices.com.cn transfer-webapp.cn-northwest-1.on.amazonwebservices.com.cn // eero // Submitted by Yue Kang // Reference: 264afe70-f62c-4c02-8ab9-b5281ed24461 eero.online eero-stage.online // concludes Amazon // Apigee : https://apigee.com/ // Submitted by Apigee Security Team apigee.io // Apis Networks : https://apisnetworks.com // Submitted by Matt Saladna panel.dev // Apphud : https://apphud.com // Submitted by Alexander Selivanov siiites.com // Appspace : https://www.appspace.com // Submitted by Appspace Security Team appspacehosted.com appspaceusercontent.com // Appudo UG (haftungsbeschränkt) : https://www.appudo.com // Submitted by Alexander Hochbaum appudo.net // Appwrite : https://appwrite.io // Submitted by Steven Nguyen appwrite.global *.appwrite.run // Aptible : https://www.aptible.com/ // Submitted by Thomas Orozco on-aptible.com // Aquapal : https://aquapal.net/ // Submitted by Aki Ueno f5.si // ArvanCloud EdgeCompute // Submitted by ArvanCloud CDN arvanedge.ir // ASEINet : https://www.aseinet.com/ // Submitted by Asei SEKIGUCHI user.aseinet.ne.jp gv.vc d.gv.vc // Asociación Amigos de la Informática "Euskalamiga" : http://encounter.eus/ // Submitted by Hector Martin user.party.eus // Association potager.org : https://potager.org/ // Submitted by Lunar pimienta.org poivron.org potager.org sweetpepper.org // ASUSTOR Inc. : http://www.asustor.com // Submitted by Vincent Tseng myasustor.com // Atlassian : https://atlassian.com // Submitted by Sam Smyth cdn.prod.atlassian-dev.net // Authentick UG (haftungsbeschränkt) : https://authentick.net // Submitted by Lukas Reschke translated.page // AVM : https://avm.de // Submitted by Andreas Weise myfritz.link myfritz.net // AVStack Pte. Ltd. : https://avstack.io // Submitted by Jasper Hugo onavstack.net // AW AdvisorWebsites.com Software Inc : https://advisorwebsites.com // Submitted by James Kennedy *.awdev.ca *.advisor.ws // AZ.pl sp. z.o.o : https://az.pl // Submitted by Krzysztof Wolski ecommerce-shop.pl // b-data GmbH : https://www.b-data.io // Submitted by Olivier Benz b-data.io // Balena : https://www.balena.io // Submitted by Petros Angelatos balena-devices.com // BASE, Inc. : https://binc.jp // Submitted by Yuya NAGASAWA base.ec official.ec buyshop.jp fashionstore.jp handcrafted.jp kawaiishop.jp supersale.jp theshop.jp shopselect.net base.shop // BeagleBoard.org Foundation : https://beagleboard.org // Submitted by Jason Kridner beagleboard.io // Beget Ltd // Submitted by Lev Nekrasov *.beget.app // Besties : https://besties.house // Submitted by Hazel Cora pages.gay // BinaryLane : http://www.binarylane.com // Submitted by Nathan O'Sullivan bnr.la // Bitbucket : http://bitbucket.org // Submitted by Andy Ortlieb bitbucket.io // Blackbaud, Inc. : https://www.blackbaud.com // Submitted by Paul Crowder blackbaudcdn.net // Blatech : http://www.blatech.net // Submitted by Luke Bratch of.je // Block, Inc. : https://block.xyz // Submitted by Jonathan Boice square.site // Blue Bite, LLC : https://bluebite.com // Submitted by Joshua Weiss bluebite.io // Boomla : https://boomla.com // Submitted by Tibor Halter boomla.net // Boutir : https://www.boutir.com // Submitted by Eric Ng Ka Ka boutir.com // Boxfuse : https://boxfuse.com // Submitted by Axel Fontaine boxfuse.io // bplaced : https://www.bplaced.net/ // Submitted by Miroslav Bozic square7.ch bplaced.com bplaced.de square7.de bplaced.net square7.net // Brave : https://brave.com // Submitted by Andrea Brancaleoni brave.app *.s.brave.app brave.io *.s.brave.io // Brendly : https://brendly.rs // Submitted by Dusan Radovanovic shop.brendly.ba shop.brendly.hr shop.brendly.rs // BrowserSafetyMark // Submitted by Dave Tharp browsersafetymark.io // BRS Media : https://brsmedia.com/ // Submitted by Gavin Brown radio.am radio.fm // Bubble : https://bubble.io/ // Submitted by Merlin Zhao cdn.bubble.io bubbleapps.io // Bytemark Hosting : https://www.bytemark.co.uk // Submitted by Paul Cammish uk0.bigv.io dh.bytemark.co.uk vm.bytemark.co.uk // Caf.js Labs LLC : https://www.cafjs.com // Submitted by Antonio Lain cafjs.com // Canva Pty Ltd : https://canva.com/ // Submitted by Joel Aquilina canva-apps.cn my.canvasite.cn canva-apps.com my.canva.site // Carrd : https://carrd.co // Submitted by AJ drr.ac uwu.ai carrd.co crd.co ju.mp // CDDO : https://www.gov.uk/guidance/get-an-api-domain-on-govuk // Submitted by Jamie Tanna api.gov.uk // CDN77.com : http://www.cdn77.com // Submitted by Jan Krpes cdn77-storage.com rsc.contentproxy9.cz r.cdn77.net cdn77-ssl.net c.cdn77.org rsc.cdn77.org ssl.origin.cdn77-secure.org // CentralNic : https://teaminternet.com/ // Submitted by registry za.bz br.com cn.com de.com eu.com jpn.com mex.com ru.com sa.com uk.com us.com za.com com.de gb.net hu.net jp.net se.net uk.net ae.org com.se // Cityhost LLC : https://cityhost.ua // Submitted by Maksym Rivtin cx.ua // Civilized Discourse Construction Kit, Inc. : https://www.discourse.org/ // Submitted by Rishabh Nambiar & Michael Brown discourse.group discourse.team // Clerk : https://www.clerk.dev // Submitted by Colin Sidoti clerk.app clerkstage.app *.lcl.dev *.lclstage.dev *.stg.dev *.stgstage.dev // Clever Cloud : https://www.clever-cloud.com/ // Submitted by Quentin Adam cleverapps.cc *.services.clever-cloud.com cleverapps.io cleverapps.tech // ClickRising : https://clickrising.com/ // Submitted by Umut Gumeli clickrising.net // Cloud DNS Ltd : http://www.cloudns.net // Submitted by Aleksander Hristov & Boyan Peychev cloudns.asia cloudns.be cloud-ip.biz cloudns.biz cloudns.cc cloudns.ch cloudns.cl cloudns.club dnsabr.com ip-ddns.com cloudns.cx cloudns.eu cloudns.in cloudns.info ddns-ip.net dns-cloud.net dns-dynamic.net cloudns.nz cloudns.org ip-dynamic.org cloudns.ph cloudns.pro cloudns.pw cloudns.us // Cloud66 : https://www.cloud66.com/ // Submitted by Khash Sajadi c66.me cloud66.ws // CloudAccess.net : https://www.cloudaccess.net/ // Submitted by Pawel Panek jdevcloud.com wpdevcloud.com cloudaccess.host freesite.host cloudaccess.net // Cloudbees, Inc. : https://www.cloudbees.com/ // Submitted by Mohideen Shajith cloudbeesusercontent.io // Cloudera, Inc. : https://www.cloudera.com/ // Submitted by Kedarnath Waikar *.cloudera.site // Cloudflare, Inc. : https://www.cloudflare.com/ // Submitted by Cloudflare Team cf-ipfs.com cloudflare-ipfs.com trycloudflare.com pages.dev r2.dev workers.dev cloudflare.net cdn.cloudflare.net cdn.cloudflareanycast.net cdn.cloudflarecn.net cdn.cloudflareglobal.net // cloudscale.ch AG : https://www.cloudscale.ch/ // Submitted by Gaudenz Steinlin cust.cloudscale.ch objects.lpg.cloudscale.ch objects.rma.cloudscale.ch lpg.objectstorage.ch rma.objectstorage.ch // Clovyr : https://clovyr.io // Submitted by Patrick Nielsen wnext.app // CNPY : https://cnpy.gdn // Submitted by Angelo Gladding cnpy.gdn // Co & Co : https://co-co.nl/ // Submitted by Govert Versluis *.otap.co // co.ca : http://registry.co.ca/ co.ca // co.com Registry, LLC : https://registry.co.com // Submitted by Gavin Brown co.com // Codeberg e. V. : https://codeberg.org // Submitted by Moritz Marquardt codeberg.page // CodeSandbox B.V. : https://codesandbox.io // Submitted by Ives van Hoorne csb.app preview.csb.app // CoDNS B.V. co.nl co.no // Cognition AI, Inc. : https://cognition.ai // Submitted by Philip Papurt *.devinapps.com // Combell.com : https://www.combell.com // Submitted by Thomas Wouters webhosting.be hosting-cluster.nl // Contentful GmbH : https://www.contentful.com // Submitted by Contentful Developer Experience Team ctfcloud.net // Convex : https://convex.dev/ // Submitted by James Cowling convex.app convex.cloud convex.site // Coordination Center for TLD RU and XN--P1AI : https://cctld.ru/en/domains/domens_ru/reserved/ // Submitted by George Georgievsky ac.ru edu.ru gov.ru int.ru mil.ru // COSIMO GmbH : http://www.cosimo.de // Submitted by Rene Marticke dyn.cosidns.de dnsupdater.de dynamisches-dns.de internet-dns.de l-o-g-i-n.de dynamic-dns.info feste-ip.net knx-server.net static-access.net // Craft Docs Ltd : https://www.craft.do/ // Submitted by Zsombor Fuszenecker craft.me // Craynic, s.r.o. : http://www.craynic.com/ // Submitted by Ales Krajnik realm.cz // Crisp IM SAS : https://crisp.chat/ // Submitted by Baptiste Jamin on.crisp.email // Cryptonomic : https://cryptonomic.net/ // Submitted by Andrew Cady *.cryptonomic.net // cyber_Folks S.A. : https://cyberfolks.pl // Submitted by Bartlomiej Kida cfolks.pl // cyon GmbH : https://www.cyon.ch/ // Submitted by Dominic Luechinger cyon.link cyon.site // Dansk.net : http://www.dansk.net/ // Submitted by Anani Voule biz.dk co.dk firm.dk reg.dk store.dk // dappnode.io : https://dappnode.io/ // Submitted by Abel Boldu / DAppNode Team dyndns.dappnode.io // Dark, Inc. : https://darklang.com // Submitted by Paul Biggar builtwithdark.com darklang.io // DataDetect, LLC. : https://datadetect.com // Submitted by Andrew Banchich demo.datadetect.com instance.datadetect.com // Datawire, Inc : https://www.datawire.io // Submitted by Richard Li edgestack.me // Datto, Inc. : https://www.datto.com/ // Submitted by Philipp Heckel dattolocal.com dattorelay.com dattoweb.com mydatto.com dattolocal.net mydatto.net // ddnss.de : https://www.ddnss.de/ // Submitted by Robert Niedziela ddnss.de dyn.ddnss.de dyndns.ddnss.de dyn-ip24.de dyndns1.de home-webserver.de dyn.home-webserver.de myhome-server.de ddnss.org // Debian : https://www.debian.org/ // Submitted by Peter Palfrader / Debian Sysadmin Team debian.net // Definima : http://www.definima.com/ // Submitted by Maxence Bitterli definima.io definima.net // Deno Land Inc : https://deno.com/ // Submitted by Luca Casonato deno.dev deno-staging.dev deno.net // deSEC : https://desec.io/ // Submitted by Peter Thomassen dedyn.io // Deta : https://www.deta.sh/ // Submitted by Aavash Shrestha deta.app deta.dev // Dfinity Foundation: https://dfinity.org/ // Submitted by Dfinity Team icp0.io *.raw.icp0.io icp1.io *.raw.icp1.io *.icp.net caffeine.site // dhosting.pl Sp. z o.o. : https://dhosting.pl/ // Submitted by Michal Kokoszkiewicz dfirma.pl dkonto.pl you2.pl // DigitalOcean App Platform : https://www.digitalocean.com/products/app-platform/ // Submitted by Braxton Huggins ondigitalocean.app // DigitalOcean Spaces : https://www.digitalocean.com/products/spaces/ // Submitted by Robin H. Johnson *.digitaloceanspaces.com // DigitalPlat : https://www.digitalplat.org/ // Submitted by Edward Hsing qzz.io us.kg xx.kg dpdns.org // Discord Inc : https://discord.com // Submitted by Sahn Lam discordsays.com discordsez.com // DNS Africa Ltd : https://dns.business // Submitted by Calvin Browne jozi.biz // DNShome : https://www.dnshome.de/ // Submitted by Norbert Auler dnshome.de // DotArai : https://www.dotarai.com/ // Submitted by Atsadawat Netcharadsang online.th shop.th // DrayTek Corp. : https://www.draytek.com/ // Submitted by Paul Fang drayddns.com // DreamCommerce : https://shoper.pl/ // Submitted by Konrad Kotarba shoparena.pl // DreamHost : http://www.dreamhost.com/ // Submitted by Andrew Farmer dreamhosters.com // Dreamyoungs, Inc. : https://durumis.com // Submitted by Infra Team durumis.com // DuckDNS : http://www.duckdns.org/ // Submitted by Richard Harper duckdns.org // dy.fi : http://dy.fi/ // Submitted by Heikki Hannikainen dy.fi tunk.org // DynDNS.com : http://www.dyndns.com/services/dns/dyndns/ dyndns.biz for-better.biz for-more.biz for-some.biz for-the.biz selfip.biz webhop.biz ftpaccess.cc game-server.cc myphotos.cc scrapping.cc blogdns.com cechire.com dnsalias.com dnsdojo.com doesntexist.com dontexist.com doomdns.com dyn-o-saur.com dynalias.com dyndns-at-home.com dyndns-at-work.com dyndns-blog.com dyndns-free.com dyndns-home.com dyndns-ip.com dyndns-mail.com dyndns-office.com dyndns-pics.com dyndns-remote.com dyndns-server.com dyndns-web.com dyndns-wiki.com dyndns-work.com est-a-la-maison.com est-a-la-masion.com est-le-patron.com est-mon-blogueur.com from-ak.com from-al.com from-ar.com from-ca.com from-ct.com from-dc.com from-de.com from-fl.com from-ga.com from-hi.com from-ia.com from-id.com from-il.com from-in.com from-ks.com from-ky.com from-ma.com from-md.com from-mi.com from-mn.com from-mo.com from-ms.com from-mt.com from-nc.com from-nd.com from-ne.com from-nh.com from-nj.com from-nm.com from-nv.com from-oh.com from-ok.com from-or.com from-pa.com from-pr.com from-ri.com from-sc.com from-sd.com from-tn.com from-tx.com from-ut.com from-va.com from-vt.com from-wa.com from-wi.com from-wv.com from-wy.com getmyip.com gotdns.com hobby-site.com homelinux.com homeunix.com iamallama.com is-a-anarchist.com is-a-blogger.com is-a-bookkeeper.com is-a-bulls-fan.com is-a-caterer.com is-a-chef.com is-a-conservative.com is-a-cpa.com is-a-cubicle-slave.com is-a-democrat.com is-a-designer.com is-a-doctor.com is-a-financialadvisor.com is-a-geek.com is-a-green.com is-a-guru.com is-a-hard-worker.com is-a-hunter.com is-a-landscaper.com is-a-lawyer.com is-a-liberal.com is-a-libertarian.com is-a-llama.com is-a-musician.com is-a-nascarfan.com is-a-nurse.com is-a-painter.com is-a-personaltrainer.com is-a-photographer.com is-a-player.com is-a-republican.com is-a-rockstar.com is-a-socialist.com is-a-student.com is-a-teacher.com is-a-techie.com is-a-therapist.com is-an-accountant.com is-an-actor.com is-an-actress.com is-an-anarchist.com is-an-artist.com is-an-engineer.com is-an-entertainer.com is-certified.com is-gone.com is-into-anime.com is-into-cars.com is-into-cartoons.com is-into-games.com is-leet.com is-not-certified.com is-slick.com is-uberleet.com is-with-theband.com isa-geek.com isa-hockeynut.com issmarterthanyou.com likes-pie.com likescandy.com neat-url.com saves-the-whales.com selfip.com sells-for-less.com sells-for-u.com servebbs.com simple-url.com space-to-rent.com teaches-yoga.com writesthisblog.com ath.cx fuettertdasnetz.de isteingeek.de istmein.de lebtimnetz.de leitungsen.de traeumtgerade.de barrel-of-knowledge.info barrell-of-knowledge.info dyndns.info for-our.info groks-the.info groks-this.info here-for-more.info knowsitall.info selfip.info webhop.info forgot.her.name forgot.his.name at-band-camp.net blogdns.net broke-it.net buyshouses.net dnsalias.net dnsdojo.net does-it.net dontexist.net dynalias.net dynathome.net endofinternet.net from-az.net from-co.net from-la.net from-ny.net gets-it.net ham-radio-op.net homeftp.net homeip.net homelinux.net homeunix.net in-the-band.net is-a-chef.net is-a-geek.net isa-geek.net kicks-ass.net office-on-the.net podzone.net scrapper-site.net selfip.net sells-it.net servebbs.net serveftp.net thruhere.net webhop.net merseine.nu mine.nu shacknet.nu blogdns.org blogsite.org boldlygoingnowhere.org dnsalias.org dnsdojo.org doesntexist.org dontexist.org doomdns.org dvrdns.org dynalias.org dyndns.org go.dyndns.org home.dyndns.org endofinternet.org endoftheinternet.org from-me.org game-host.org gotdns.org hobby-site.org homedns.org homeftp.org homelinux.org homeunix.org is-a-bruinsfan.org is-a-candidate.org is-a-celticsfan.org is-a-chef.org is-a-geek.org is-a-knight.org is-a-linux-user.org is-a-patsfan.org is-a-soxfan.org is-found.org is-lost.org is-saved.org is-very-bad.org is-very-evil.org is-very-good.org is-very-nice.org is-very-sweet.org isa-geek.org kicks-ass.org misconfused.org podzone.org readmyblog.org selfip.org sellsyourhome.org servebbs.org serveftp.org servegame.org stuff-4-sale.org webhop.org better-than.tv dyndns.tv on-the-web.tv worse-than.tv is-by.us land-4-sale.us stuff-4-sale.us dyndns.ws mypets.ws // Dynu.com : https://www.dynu.com/ // Submitted by Sue Ye ddnsfree.com ddnsgeek.com giize.com gleeze.com kozow.com loseyourip.com ooguy.com theworkpc.com casacam.net dynu.net accesscam.org camdvr.org freeddns.org mywire.org webredirect.org myddns.rocks // dynv6 : https://dynv6.com // Submitted by Dominik Menke dynv6.net // E4YOU spol. s.r.o. : https://e4you.cz/ // Submitted by Vladimir Dudr e4.cz // Easypanel : https://easypanel.io // Submitted by Andrei Canta easypanel.app easypanel.host // EasyWP : https://www.easywp.com // Submitted by *.ewp.live // eDirect Corp. : https://hosting.url.com.tw/ // Submitted by C.S. chang twmail.cc twmail.net twmail.org mymailer.com.tw url.tw // Electromagnetic Field : https://www.emfcamp.org // Submitted by at.emf.camp // Elefunc, Inc. : https://elefunc.com // Submitted by Cetin Sert rt.ht // Elementor : Elementor Ltd. // Submitted by Anton Barkan elementor.cloud elementor.cool // En root‽ : https://en-root.org // Submitted by Emmanuel Raviart en-root.fr // Enalean SAS : https://www.enalean.com // Submitted by Enalean Security Team mytuleap.com tuleap-partners.com // Encoretivity AB : https://encore.cloud // Submitted by André Eriksson encr.app frontend.encr.app encoreapi.com lp.dev api.lp.dev objects.lp.dev // encoway GmbH : https://www.encoway.de // Submitted by Marcel Daus eu.encoway.cloud // EU.org : https://eu.org/ // Submitted by Pierre Beyssac eu.org al.eu.org asso.eu.org at.eu.org au.eu.org be.eu.org bg.eu.org ca.eu.org cd.eu.org ch.eu.org cn.eu.org cy.eu.org cz.eu.org de.eu.org dk.eu.org edu.eu.org ee.eu.org es.eu.org fi.eu.org fr.eu.org gr.eu.org hr.eu.org hu.eu.org ie.eu.org il.eu.org in.eu.org int.eu.org is.eu.org it.eu.org jp.eu.org kr.eu.org lt.eu.org lu.eu.org lv.eu.org me.eu.org mk.eu.org mt.eu.org my.eu.org net.eu.org ng.eu.org nl.eu.org no.eu.org nz.eu.org pl.eu.org pt.eu.org ro.eu.org ru.eu.org se.eu.org si.eu.org sk.eu.org tr.eu.org uk.eu.org us.eu.org // Eurobyte : https://eurobyte.ru // Submitted by Evgeniy Subbotin eurodir.ru // Evennode : http://www.evennode.com/ // Submitted by Michal Kralik eu-1.evennode.com eu-2.evennode.com eu-3.evennode.com eu-4.evennode.com us-1.evennode.com us-2.evennode.com us-3.evennode.com us-4.evennode.com // Evervault : https://evervault.com // Submitted by Hannah Neary relay.evervault.app relay.evervault.dev // Expo : https://expo.dev/ // Submitted by James Ide expo.app staging.expo.app // Fabrica Technologies, Inc. : https://www.fabrica.dev/ // Submitted by Eric Jiang onfabrica.com // FAITID : https://faitid.org/ // Submitted by Maxim Alzoba // https://www.flexireg.net/stat_info ru.net adygeya.ru bashkiria.ru bir.ru cbg.ru com.ru dagestan.ru grozny.ru kalmykia.ru kustanai.ru marine.ru mordovia.ru msk.ru mytis.ru nalchik.ru nov.ru pyatigorsk.ru spb.ru vladikavkaz.ru vladimir.ru abkhazia.su adygeya.su aktyubinsk.su arkhangelsk.su armenia.su ashgabad.su azerbaijan.su balashov.su bashkiria.su bryansk.su bukhara.su chimkent.su dagestan.su east-kazakhstan.su exnet.su georgia.su grozny.su ivanovo.su jambyl.su kalmykia.su kaluga.su karacol.su karaganda.su karelia.su khakassia.su krasnodar.su kurgan.su kustanai.su lenug.su mangyshlak.su mordovia.su msk.su murmansk.su nalchik.su navoi.su north-kazakhstan.su nov.su obninsk.su penza.su pokrovsk.su sochi.su spb.su tashkent.su termez.su togliatti.su troitsk.su tselinograd.su tula.su tuva.su vladikavkaz.su vladimir.su vologda.su // Fancy Bits, LLC : http://getchannels.com // Submitted by Aman Gupta channelsdvr.net u.channelsdvr.net // Fastly Inc. : http://www.fastly.com/ // Submitted by Fastly Security edgecompute.app fastly-edge.com fastly-terrarium.com freetls.fastly.net map.fastly.net a.prod.fastly.net global.prod.fastly.net a.ssl.fastly.net b.ssl.fastly.net global.ssl.fastly.net fastlylb.net map.fastlylb.net // Fastmail : https://www.fastmail.com/ // Submitted by Marc Bradshaw *.user.fm // FASTVPS EESTI OU : https://fastvps.ru/ // Submitted by Likhachev Vasiliy fastvps-server.com fastvps.host myfast.host fastvps.site myfast.space // FearWorks Media Ltd. : https://fearworksmedia.co.uk // Submitted by Keith Fairley conn.uk copro.uk hosp.uk // Fedora : https://fedoraproject.org/ // Submitted by Patrick Uiterwijk fedorainfracloud.org fedorapeople.org cloud.fedoraproject.org app.os.fedoraproject.org app.os.stg.fedoraproject.org // Fermax : https://fermax.com/ // Submitted by Koen Van Isterdael mydobiss.com // FH Muenster : https://www.fh-muenster.de // Submitted by Robin Naundorf fh-muenster.io // Figma : https://www.figma.com // Submitted by Nick Frost figma.site preview.site // Filegear Inc. : https://www.filegear.com // Submitted by Jason Zhu filegear.me // Firebase, Inc. // Submitted by Chris Raynor firebaseapp.com // FlashDrive : https://flashdrive.io // Submitted by Eric Chan fldrv.com // Fleek Labs Inc : https://fleek.xyz // Submitted by Parsa Ghadimi on-fleek.app // FlutterFlow : https://flutterflow.io // Submitted by Anton Emelyanov flutterflow.app // fly.io : https://fly.io // Submitted by Kurt Mackey fly.dev shw.io edgeapp.net // Forgerock : https://www.forgerock.com // Submitted by Roderick Parr forgeblocks.com id.forgerock.io // FoundryLabs, Inc : https://e2b.dev/ // Submitted by Jiri Sveceny e2b.app // Framer : https://www.framer.com // Submitted by Koen Rouwhorst framer.ai framer.app framercanvas.com framer.media framer.photos framer.website framer.wiki // Frederik Braun : https://frederik-braun.com // Submitted by Frederik Braun *.0e.vc // Freebox : http://www.freebox.fr // Submitted by Romain Fliedel freebox-os.com freeboxos.com fbx-os.fr fbxos.fr freebox-os.fr freeboxos.fr // freedesktop.org : https://www.freedesktop.org // Submitted by Daniel Stone freedesktop.org // freemyip.com : https://freemyip.com // Submitted by Cadence freemyip.com // Frusky MEDIA&PR : https://www.frusky.de // Submitted by Victor Pupynin *.frusky.de // FunkFeuer - Verein zur Förderung freier Netze : https://www.funkfeuer.at // Submitted by Daniel A. Maierhofer wien.funkfeuer.at // Future Versatile Group. : https://www.fvg-on.net/ // T.Kabu daemon.asia dix.asia mydns.bz 0am.jp 0g0.jp 0j0.jp 0t0.jp mydns.jp pgw.jp wjg.jp keyword-on.net live-on.net server-on.net mydns.tw mydns.vc // Futureweb GmbH : https://www.futureweb.at // Submitted by Andreas Schnederle-Wagner *.futurecms.at *.ex.futurecms.at *.in.futurecms.at futurehosting.at futuremailing.at *.ex.ortsinfo.at *.kunden.ortsinfo.at *.statics.cloud // GCom Internet : https://www.gcom.net.au // Submitted by Leo Julius aliases121.com // GDS : https://www.gov.uk/service-manual/technology/managing-domain-names // Submitted by Stephen Ford campaign.gov.uk service.gov.uk independent-commission.uk independent-inquest.uk independent-inquiry.uk independent-panel.uk independent-review.uk public-inquiry.uk royal-commission.uk // Gehirn Inc. : https://www.gehirn.co.jp/ // Submitted by Kohei YOSHIDA gehirn.ne.jp usercontent.jp // Gentlent, Inc. : https://www.gentlent.com // Submitted by Tom Klein gentapps.com gentlentapis.com cdn-edges.net // GignoSystemJapan : http://gsj.bz // Submitted by GignoSystemJapan gsj.bz // GitHub, Inc. // Submitted by Patrick Toomey github.app githubusercontent.com githubpreview.dev github.io // GitLab, Inc. : https://about.gitlab.com/ // Submitted by Alex Hanselka gitlab.io // Gitplac.si : https://gitplac.si // Submitted by Aljaž Starc gitapp.si gitpage.si // Global NOG Alliance : https://nogalliance.org/ // Submitted by Sander Steffann nog.community // Globe Hosting SRL : https://www.globehosting.com/ // Submitted by Gavin Brown co.ro shop.ro // GMO Pepabo, Inc. : https://pepabo.com/ // Submitted by Hosting Div lolipop.io angry.jp babyblue.jp babymilk.jp backdrop.jp bambina.jp bitter.jp blush.jp boo.jp boy.jp boyfriend.jp but.jp candypop.jp capoo.jp catfood.jp cheap.jp chicappa.jp chillout.jp chips.jp chowder.jp chu.jp ciao.jp cocotte.jp coolblog.jp cranky.jp cutegirl.jp daa.jp deca.jp deci.jp digick.jp egoism.jp fakefur.jp fem.jp flier.jp floppy.jp fool.jp frenchkiss.jp girlfriend.jp girly.jp gloomy.jp gonna.jp greater.jp hacca.jp heavy.jp her.jp hiho.jp hippy.jp holy.jp hungry.jp icurus.jp itigo.jp jellybean.jp kikirara.jp kill.jp kilo.jp kuron.jp littlestar.jp lolipopmc.jp lolitapunk.jp lomo.jp lovepop.jp lovesick.jp main.jp mods.jp mond.jp mongolian.jp moo.jp namaste.jp nikita.jp nobushi.jp noor.jp oops.jp parallel.jp parasite.jp pecori.jp peewee.jp penne.jp pepper.jp perma.jp pigboat.jp pinoko.jp punyu.jp pupu.jp pussycat.jp pya.jp raindrop.jp readymade.jp sadist.jp schoolbus.jp secret.jp staba.jp stripper.jp sub.jp sunnyday.jp thick.jp tonkotsu.jp under.jp upper.jp velvet.jp verse.jp versus.jp vivian.jp watson.jp weblike.jp whitesnow.jp zombie.jp heteml.net // GoDaddy Registry : https://registry.godaddy // Submitted by Rohan Durrant graphic.design // GoIP DNS Services : http://www.goip.de // Submitted by Christian Poulter goip.de // Google, Inc. // Submitted by Shannon McCabe *.hosted.app *.run.app *.mtls.run.app web.app *.0emm.com appspot.com *.r.appspot.com blogspot.com codespot.com googleapis.com googlecode.com pagespeedmobilizer.com withgoogle.com withyoutube.com *.gateway.dev cloud.goog translate.goog *.usercontent.goog cloudfunctions.net // Goupile : https://goupile.fr // Submitted by Niels Martignene goupile.fr // GOV.UK Pay : https://www.payments.service.gov.uk/ // Submitted by Richard Baker pymnt.uk // GOV.UK Platform as a Service : https://www.cloud.service.gov.uk/ // Submitted by Tom Whitwell cloudapps.digital london.cloudapps.digital // Government of the Netherlands : https://www.government.nl // Submitted by gov.nl // Grafana Labs : https://grafana.com/ // Submitted by Platform Engineering grafana-dev.net // GrayJay Web Solutions Inc. : https://grayjaysports.ca // Submitted by Matt Yamkowy grayjayleagues.com // GünstigBestellen : https://günstigbestellen.de // Submitted by Furkan Akkoc günstigbestellen.de günstigliefern.de // Hackclub Nest : https://hackclub.app // Submitted by Cyteon hackclub.app // Häkkinen.fi : https://www.häkkinen.fi/ // Submitted by Eero Häkkinen häkkinen.fi // Hashbang : https://hashbang.sh hashbang.sh // Hasura : https://hasura.io // Submitted by Shahidh K Muhammed hasura.app hasura-app.io // Hatena Co., Ltd. : https://hatena.co.jp // Submitted by Masato Nakamura hatenablog.com hatenadiary.com hateblo.jp hatenablog.jp hatenadiary.jp hatenadiary.org // Heilbronn University of Applied Sciences - Faculty Informatics (GitLab Pages) : https://www.hs-heilbronn.de // Submitted by Richard Zowalla pages.it.hs-heilbronn.de pages-research.it.hs-heilbronn.de // HeiyuSpace : https://lazycat.cloud // Submitted by Xia Bin heiyu.space // Helio Networks : https://heliohost.org // Submitted by Ben Frede helioho.st heliohost.us // Hepforge : https://www.hepforge.org // Submitted by David Grellscheid hepforge.org // Heroku : https://www.heroku.com/ // Submitted by Shumon Huque herokuapp.com // Heyflow : https://www.heyflow.com // Submitted by Mirko Nitschke heyflow.page heyflow.site // Hibernating Rhinos // Submitted by Oren Eini ravendb.cloud ravendb.community development.run ravendb.run // HiDNS : https://www.hidoha.net // Submitted by ifeng hidns.co hidns.vip // home.pl S.A. : https://home.pl // Submitted by Krzysztof Wolski homesklep.pl // Homebase : https://homebase.id/ // Submitted by Jason Babo *.kin.one *.id.pub *.kin.pub // Hoplix : https://www.hoplix.com // Submitted by Danilo De Franco hoplix.shop // HOSTBIP REGISTRY : https://www.hostbip.com/ // Submitted by Atanunu Igbunuroghene orx.biz biz.ng co.biz.ng dl.biz.ng go.biz.ng lg.biz.ng on.biz.ng col.ng firm.ng gen.ng ltd.ng ngo.ng plc.ng // HostyHosting : https://hostyhosting.com hostyhosting.io // Hugging Face : https://huggingface.co // Submitted by Eliott Coyac hf.space static.hf.space // Hypernode B.V. : https://www.hypernode.com/ // Submitted by Cipriano Groenendal hypernode.io // I-O DATA DEVICE, INC. : http://www.iodata.com/ // Submitted by Yuji Minagawa iobb.net // i-registry s.r.o. : http://www.i-registry.cz/ // Submitted by Martin Semrad co.cz // Ici la Lune : http://www.icilalune.com/ // Submitted by Simon Morvan *.moonscale.io moonscale.net // iDOT Services Limited : http://www.domain.gr.com // Submitted by Gavin Brown gr.com // iki.fi // Submitted by Hannu Aronsson iki.fi // iliad italia : https://www.iliad.it // Submitted by Marios Makassikis ibxos.it iliadboxos.it // Incsub, LLC : https://incsub.com/ // Submitted by Aaron Edwards smushcdn.com wphostedmail.com wpmucdn.com tempurl.host wpmudev.host // Individual Network Berlin e.V. : https://www.in-berlin.de/ // Submitted by Christian Seitz dyn-berlin.de in-berlin.de in-brb.de in-butter.de in-dsl.de in-vpn.de in-dsl.net in-vpn.net in-dsl.org in-vpn.org // Inferno Communications : https://inferno.co.uk // Submitted by Connor McFarlane oninferno.net // info.at : http://www.info.at/ biz.at info.at // info.cx : http://info.cx // Submitted by June Slater info.cx // Interlegis : http://www.interlegis.leg.br // Submitted by Gabriel Ferreira ac.leg.br al.leg.br am.leg.br ap.leg.br ba.leg.br ce.leg.br df.leg.br es.leg.br go.leg.br ma.leg.br mg.leg.br ms.leg.br mt.leg.br pa.leg.br pb.leg.br pe.leg.br pi.leg.br pr.leg.br rj.leg.br rn.leg.br ro.leg.br rr.leg.br rs.leg.br sc.leg.br se.leg.br sp.leg.br to.leg.br // intermetrics GmbH : https://pixolino.com/ // Submitted by Wolfgang Schwarz pixolino.com // Internet-Pro, LLP : https://netangels.ru/ // Submitted by Vasiliy Sheredeko na4u.ru // Inventor Services : https://inventor.gg/ // Submitted by Inventor Team botdash.app botdash.dev botdash.gg botdash.net botda.sh botdash.xyz // IONOS SE : https://www.ionos.com/ // IONOS Group SE : https://www.ionos-group.com/ // Submitted by Henrik Willert apps-1and1.com live-website.com webspace-host.com apps-1and1.net websitebuilder.online app-ionos.space // iopsys software solutions AB : https://iopsys.eu/ // Submitted by Roman Azarenko iopsys.se // IPFS Project : https://ipfs.tech/ // Submitted by Interplanetary Shipyard *.inbrowser.dev *.dweb.link *.inbrowser.link // IPiFony Systems, Inc. : https://www.ipifony.com/ // Submitted by Matthew Hardeman ipifony.net // ir.md : https://nic.ir.md // Submitted by Ali Soizi ir.md // is-a-good.dev : https://is-a-good.dev // Submitted by William Harrison is-a-good.dev // is-a.dev : https://is-a.dev // Submitted by William Harrison is-a.dev // IServ GmbH : https://iserv.de // Submitted by Kim Brodowski iservschule.de mein-iserv.de schuldock.de schulplattform.de schulserver.de test-iserv.de iserv.dev iserv.host // Jelastic, Inc. : https://jelastic.com/ // Submitted by Ihor Kolodyuk mel.cloudlets.com.au cloud.interhostsolutions.be alp1.ae.flow.ch appengine.flow.ch es-1.axarnet.cloud diadem.cloud vip.jelastic.cloud jele.cloud it1.eur.aruba.jenv-aruba.cloud it1.jenv-aruba.cloud keliweb.cloud cs.keliweb.cloud oxa.cloud tn.oxa.cloud uk.oxa.cloud primetel.cloud uk.primetel.cloud ca.reclaim.cloud uk.reclaim.cloud us.reclaim.cloud ch.trendhosting.cloud de.trendhosting.cloud jele.club dopaas.com paas.hosted-by-previder.com rag-cloud.hosteur.com rag-cloud-ch.hosteur.com jcloud.ik-server.com jcloud-ver-jpc.ik-server.com demo.jelastic.com paas.massivegrid.com jed.wafaicloud.com ryd.wafaicloud.com j.scaleforce.com.cy jelastic.dogado.eu fi.cloudplatform.fi demo.datacenter.fi paas.datacenter.fi jele.host mircloud.host paas.beebyte.io sekd1.beebyteapp.io jele.io jc.neen.it jcloud.kz cloudjiffy.net fra1-de.cloudjiffy.net west1-us.cloudjiffy.net jls-sto1.elastx.net jls-sto2.elastx.net jls-sto3.elastx.net fr-1.paas.massivegrid.net lon-1.paas.massivegrid.net lon-2.paas.massivegrid.net ny-1.paas.massivegrid.net ny-2.paas.massivegrid.net sg-1.paas.massivegrid.net jelastic.saveincloud.net nordeste-idc.saveincloud.net j.scaleforce.net sdscloud.pl unicloud.pl mircloud.ru enscaled.sg jele.site jelastic.team orangecloud.tn j.layershift.co.uk phx.enscaled.us mircloud.us // Jino : https://www.jino.ru // Submitted by Sergey Ulyashin myjino.ru *.hosting.myjino.ru *.landing.myjino.ru *.spectrum.myjino.ru *.vps.myjino.ru // Jotelulu S.L. : https://jotelulu.com // Submitted by Daniel Fariña jote.cloud jotelulu.cloud jote-dr-lt1.com jote-rd-lt1.com // JouwWeb B.V. : https://www.jouwweb.nl // Submitted by Camilo Sperberg webadorsite.com jouwweb.site // Joyent : https://www.joyent.com/ // Submitted by Brian Bennett *.cns.joyent.com *.triton.zone // JS.ORG : http://dns.js.org // Submitted by Stefan Keim js.org // KaasHosting : http://www.kaashosting.nl/ // Submitted by Wouter Bakker kaas.gg khplay.nl // Kapsi : https://kapsi.fi // Submitted by Tomi Juntunen kapsi.fi // Katholieke Universiteit Leuven : https://www.kuleuven.be // Submitted by Abuse KU Leuven ezproxy.kuleuven.be kuleuven.cloud // Keyweb AG : https://www.keyweb.de // Submitted by Martin Dannehl keymachine.de // KingHost : https://king.host // Submitted by Felipe Keller Braz kinghost.net uni5.net // KnightPoint Systems, LLC : http://www.knightpoint.com/ // Submitted by Roy Keene knightpoint.systems // KoobinEvent, SL : https://www.koobin.com // Submitted by Iván Oliva koobin.events // Krellian Ltd. : https://krellian.com // Submitted by Ben Francis webthings.io krellian.net // KUROKU LTD : https://kuroku.ltd/ // Submitted by DisposaBoy oya.to // KV GmbH : https://www.nic.co.de // Submitted by KV GmbH // Abuse reports to co.de // Laravel Holdings, Inc. : https://laravel.com // Submitted by André Valentin & James Brooks laravel.cloud on-forge.com on-vapor.com // LCube - Professional hosting e.K. : https://www.lcube-webhosting.de // Submitted by Lars Laehn git-repos.de lcube-server.de svn-repos.de // Leadpages : https://www.leadpages.net // Submitted by Greg Dallavalle leadpages.co lpages.co lpusercontent.com // Liara : https://liara.ir // Submitted by Amirhossein Badinloo liara.run iran.liara.run // libp2p project : https://libp2p.io // Submitted by Interplanetary Shipyard libp2p.direct // Libre IT Ltd : https://libre.nz // Submitted by Tomas Maggio runcontainers.dev // Lifetime Hosting : https://Lifetime.Hosting/ // Submitted by Mike Fillator co.business co.education co.events co.financial co.network co.place co.technology // linkyard ldt : https://www.linkyard.ch/ // Submitted by Mario Siegenthaler linkyard-cloud.ch linkyard.cloud // Linode : https://linode.com // Submitted by members.linode.com *.nodebalancer.linode.com *.linodeobjects.com ip.linodeusercontent.com // LiquidNet Ltd : http://www.liquidnetlimited.com/ // Submitted by Victor Velchev we.bs // Listen53 : https://www.l53.net // Submitted by Gerry Keh filegear-sg.me ggff.net // Localcert : https://localcert.dev // Submitted by Lann Martin *.user.localcert.dev // LocalCert : https://localcert.net // Submitted by William Harrison localcert.net // Localtonet : https://localtonet.com/ // Submitted by Burak Isleyici localtonet.com *.localto.net // Lodz University of Technology LODMAN regional domains : https://www.man.lodz.pl/dns // Submitted by Piotr Wilk lodz.pl pabianice.pl plock.pl sieradz.pl skierniewice.pl zgierz.pl // Log'in Line : https://www.loginline.com/ // Submitted by Rémi Mach loginline.app loginline.dev loginline.io loginline.services loginline.site // Lõhmus Family, The : https://lohmus.me/ // Submitted by Heiki Lõhmus lohmus.me // Lovable : https://lovable.dev // Submitted by Fabian Hedin lovable.app lovableproject.com lovable.run lovable.sh // LubMAN UMCS Sp. z o.o : https://lubman.pl/ // Submitted by Ireneusz Maliszewski krasnik.pl leczna.pl lubartow.pl lublin.pl poniatowa.pl swidnik.pl // Lug.org.uk : https://lug.org.uk // Submitted by Jon Spriggs glug.org.uk lug.org.uk lugs.org.uk // Lukanet Ltd : https://lukanet.com // Submitted by Anton Avramov barsy.bg barsy.club barsycenter.com barsyonline.com barsy.de barsy.dev barsy.eu barsy.gr barsy.in barsy.info barsy.io barsy.me barsy.menu barsyonline.menu barsy.mobi barsy.net barsy.online barsy.org barsy.pro barsy.pub barsy.ro barsy.rs barsy.shop barsyonline.shop barsy.site barsy.store barsy.support barsy.uk barsy.co.uk barsyonline.co.uk // Lutra : https://lutra.ai // Submitted by Joshua Newman *.lutrausercontent.com // Luyani Inc. : https://luyani.com/ // Submitted by Umut Gumeli luyani.app luyani.net // Magento Commerce // Submitted by Damien Tournoud *.magentosite.cloud // Mail.Ru Group : https://hb.cldmail.ru // Submitted by Ilya Zaretskiy hb.cldmail.ru // MathWorks : https://www.mathworks.com/ // Submitted by Emily Reed matlab.cloud modelscape.com mwcloudnonprod.com polyspace.com // May First - People Link : https://mayfirst.org/ // Submitted by Jamie McClelland mayfirst.info mayfirst.org // Maze Play : https://www.mazeplay.com // Submitted by Adam Humpherys mazeplay.com // McHost : https://mchost.ru // Submitted by Evgeniy Subbotin mcdir.me mcdir.ru vps.mcdir.ru mcpre.ru // Mediatech : https://mediatech.by // Submitted by Evgeniy Kozhuhovskiy mediatech.by mediatech.dev // Medicom Health : https://medicomhealth.com // Submitted by Michael Olson hra.health // MedusaJS, Inc : https://medusajs.com/ // Submitted by Stevche Radevski medusajs.app // Memset hosting : https://www.memset.com // Submitted by Tom Whitwell miniserver.com memset.net // Messerli Informatik AG : https://www.messerli.ch/ // Submitted by Ruben Schmidmeister messerli.app // Meta Platforms, Inc. : https://meta.com/ // Submitted by Jacob Cordero atmeta.com apps.fbsbx.com // MetaCentrum, CESNET z.s.p.o. : https://www.metacentrum.cz/en/ // Submitted by Zdeněk Šustr and Radim Janča *.cloud.metacentrum.cz custom.metacentrum.cz flt.cloud.muni.cz usr.cloud.muni.cz // Meteor Development Group : https://www.meteor.com/hosting // Submitted by Pierre Carrier meteorapp.com eu.meteorapp.com // Michau Enterprises Limited : http://www.co.pl/ co.pl // Microsoft Corporation : http://microsoft.com // Submitted by Public Suffix List Admin // Managed by Corporate Domains // Microsoft Azure : https://home.azure *.azurecontainer.io azure-api.net azure-mobile.net azureedge.net azurefd.net azurestaticapps.net 1.azurestaticapps.net 2.azurestaticapps.net 3.azurestaticapps.net 4.azurestaticapps.net 5.azurestaticapps.net 6.azurestaticapps.net 7.azurestaticapps.net centralus.azurestaticapps.net eastasia.azurestaticapps.net eastus2.azurestaticapps.net westeurope.azurestaticapps.net westus2.azurestaticapps.net azurewebsites.net cloudapp.net trafficmanager.net blob.core.windows.net servicebus.windows.net // MikroTik : https://mikrotik.com // Submitted by MikroTik SysAdmin Team routingthecloud.com sn.mynetname.net routingthecloud.net routingthecloud.org // Million Software, Inc : https://million.dev/ // Submitted by Rayhan Noufal Arayilakath same-app.com same-preview.com // minion.systems : http://minion.systems // Submitted by Robert Böttinger csx.cc // Mittwald CM Service GmbH & Co. KG : https://mittwald.de // Submitted by Marco Rieger mydbserver.com webspaceconfig.de mittwald.info mittwaldserver.info typo3server.info project.space // MODX Systems LLC : https://modx.com // Submitted by Elizabeth Southwell modx.dev // Mozilla Foundation : https://mozilla.org/ // Submitted by glob bmoattachments.org // MSK-IX : https://www.msk-ix.ru/ // Submitted by Khannanov Roman net.ru org.ru pp.ru // Mythic Beasts : https://www.mythic-beasts.com // Submitted by Paul Cammish hostedpi.com caracal.mythic-beasts.com customer.mythic-beasts.com fentiger.mythic-beasts.com lynx.mythic-beasts.com ocelot.mythic-beasts.com oncilla.mythic-beasts.com onza.mythic-beasts.com sphinx.mythic-beasts.com vs.mythic-beasts.com x.mythic-beasts.com yali.mythic-beasts.com cust.retrosnub.co.uk // Nabu Casa : https://www.nabucasa.com // Submitted by Paulus Schoutsen ui.nabu.casa // Net at Work Gmbh : https://www.netatwork.de // Submitted by Jan Jaeschke cloud.nospamproxy.com o365.cloud.nospamproxy.com // Net libre : https://www.netlib.re // Submitted by Philippe PITTOLI netlib.re // Netfy Domains : https://netfy.domains // Submitted by Suranga Ranasinghe netfy.app // Netlify : https://www.netlify.com // Submitted by Jessica Parsons netlify.app // Neustar Inc. // Submitted by Trung Tran 4u.com // NFSN, Inc. : https://www.NearlyFreeSpeech.NET/ // Submitted by Jeff Wheelhouse nfshost.com // NFT.Storage : https://nft.storage/ // Submitted by Vasco Santos or ipfs.nftstorage.link // NGO.US Registry : https://nic.ngo.us // Submitted by Alstra Solutions Ltd. Networking Team ngo.us // ngrok : https://ngrok.com/ // Submitted by Alan Shreve ngrok.app ngrok-free.app ngrok.dev ngrok-free.dev ngrok.io ap.ngrok.io au.ngrok.io eu.ngrok.io in.ngrok.io jp.ngrok.io sa.ngrok.io us.ngrok.io ngrok.pizza ngrok.pro // Nicolaus Copernicus University in Torun - MSK TORMAN : https://www.man.torun.pl torun.pl // Nimbus Hosting Ltd. : https://www.nimbushosting.co.uk/ // Submitted by Nicholas Ford nh-serv.co.uk nimsite.uk // No-IP.com : https://noip.com/ // Submitted by Deven Reza mmafan.biz myftp.biz no-ip.biz no-ip.ca fantasyleague.cc gotdns.ch 3utilities.com blogsyte.com ciscofreak.com damnserver.com ddnsking.com ditchyourip.com dnsiskinky.com dynns.com geekgalaxy.com health-carereform.com homesecuritymac.com homesecuritypc.com myactivedirectory.com mysecuritycamera.com myvnc.com net-freaks.com onthewifi.com point2this.com quicksytes.com securitytactics.com servebeer.com servecounterstrike.com serveexchange.com serveftp.com servegame.com servehalflife.com servehttp.com servehumour.com serveirc.com servemp3.com servep2p.com servepics.com servequake.com servesarcasm.com stufftoread.com unusualperson.com workisboring.com dvrcam.info ilovecollege.info no-ip.info brasilia.me ddns.me dnsfor.me hopto.me loginto.me noip.me webhop.me bounceme.net ddns.net eating-organic.net mydissent.net myeffect.net mymediapc.net mypsx.net mysecuritycamera.net nhlfan.net no-ip.net pgafan.net privatizehealthinsurance.net redirectme.net serveblog.net serveminecraft.net sytes.net cable-modem.org collegefan.org couchpotatofries.org hopto.org mlbfan.org myftp.org mysecuritycamera.org nflfan.org no-ip.org read-books.org ufcfan.org zapto.org no-ip.co.uk golffan.us noip.us pointto.us // NodeArt : https://nodeart.io // Submitted by Konstantin Nosov stage.nodeart.io // Noop : https://noop.app // Submitted by Nathaniel Schweinberg *.developer.app noop.app // Northflank Ltd. : https://northflank.com/ // Submitted by Marco Suter *.northflank.app *.build.run *.code.run *.database.run *.migration.run // Noticeable : https://noticeable.io // Submitted by Laurent Pellegrino noticeable.news // Notion Labs, Inc : https://www.notion.so/ // Submitted by Jess Yao notion.site // Now-DNS : https://now-dns.com // Submitted by Steve Russell dnsking.ch mypi.co myiphost.com forumz.info soundcast.me tcp4.me dnsup.net hicam.net now-dns.net ownip.net vpndns.net dynserv.org now-dns.org x443.pw ntdll.top freeddns.us // nsupdate.info : https://www.nsupdate.info/ // Submitted by Thomas Waldmann nsupdate.info nerdpol.ovh // NYC.mn : https://dot.nyc.mn/ // Submitted by NYC.mn Subdomain Service nyc.mn // O3O.Foundation : https://o3o.foundation/ // Submitted by the prvcy.page Registry Team prvcy.page // Obl.ong : https://obl.ong // Submitted by Reese Armstrong obl.ong // Observable, Inc. : https://observablehq.com // Submitted by Mike Bostock observablehq.cloud static.observableusercontent.com // OMG.LOL : https://omg.lol // Submitted by Adam Newbold omg.lol // Omnibond Systems, LLC. : https://www.omnibond.com // Submitted by Cole Estep cloudycluster.net // OmniWe Limited : https://omniwe.com // Submitted by Vicary Archangel omniwe.site // One.com : https://www.one.com/ // Submitted by Jacob Bunk Nielsen 123webseite.at 123website.be simplesite.com.br 123website.ch simplesite.com 123webseite.de 123hjemmeside.dk 123miweb.es 123kotisivu.fi 123siteweb.fr simplesite.gr 123homepage.it 123website.lu 123website.nl 123hjemmeside.no service.one simplesite.pl 123paginaweb.pt 123minsida.se // ONID : https://get.onid.ca // Submitted by ONID Engineering Team onid.ca // Open Domains : https://open-domains.net // Submitted by William Harrison is-a-fullstack.dev is-cool.dev is-not-a.dev localplayer.dev is-local.org // Open Social : https://www.getopensocial.com/ // Submitted by Alexander Varwijk opensocial.site // OpenAI : https://openai.com // Submitted by Thomas Shadwell *.oaiusercontent.com // OpenCraft GmbH : http://opencraft.com/ // Submitted by Sven Marnach opencraft.hosting // OpenHost : https://registry.openhost.uk // Submitted by OpenHost Registry Team 16-b.it 32-b.it 64-b.it // OpenResearch GmbH : https://openresearch.com/ // Submitted by Philipp Schmid orsites.com // Opera Software, A.S.A. // Submitted by Yngve Pettersen operaunite.com // Oracle Dyn : https://cloud.oracle.com/home https://dyn.com/dns/ // Submitted by Gregory Drake // Note: This is intended to also include customer-oci.com due to wildcards implicitly including the current label *.customer-oci.com *.oci.customer-oci.com *.ocp.customer-oci.com *.ocs.customer-oci.com *.oraclecloudapps.com *.oraclegovcloudapps.com *.oraclegovcloudapps.uk // Orange : https://www.orange.com // Submitted by Alexandre Linte tech.orange // OsSav Technology Ltd. : https://ossav.com/ // Submitted by OsSav Technology Ltd. // https://nic.can.re can.re // Oursky Limited : https://authgear.com/ // Submitted by Authgear Team & Skygear Developer authgear-staging.com authgearapps.com skygearapp.com // OutSystems // Submitted by Duarte Santos outsystemscloud.com // OVHcloud : https://ovhcloud.com // Submitted by Vincent Cassé *.hosting.ovh.net *.webpaas.ovh.net // OwnProvider GmbH : http://www.ownprovider.com // Submitted by Jan Moennich ownprovider.com own.pm // OwO : https://whats-th.is/ // Submitted by Dean Sheather *.owo.codes // OX : http://www.ox.rs // Submitted by Adam Grand ox.rs // oy.lc // Submitted by Charly Coste oy.lc // Pagefog : https://pagefog.com/ // Submitted by Derek Myers pgfog.com // PageXL : https://pagexl.com // Submitted by Yann Guichard pagexl.com // Pantheon Systems, Inc. : https://pantheon.io/ // Submitted by Gary Dylina gotpantheon.com pantheonsite.io // Paywhirl, Inc : https://paywhirl.com/ // Submitted by Daniel Netzer *.paywhirl.com // pcarrier.ca Software Inc : https://pcarrier.ca/ // Submitted by Pierre Carrier *.xmit.co xmit.dev madethis.site srv.us gh.srv.us gl.srv.us // PE Ulyanov Kirill Sergeevich : https://airy.host // Submitted by Kirill Ulyanov lk3.ru // Peplink | Pepwave : http://peplink.com/ // Submitted by Steve Leung mypep.link // Perspecta : https://perspecta.com/ // Submitted by Kenneth Van Alstyne perspecta.cloud // Plain : https://www.plain.com/ // Submitted by Jesús Hernández support.site // Planet-Work : https://www.planet-work.com/ // Submitted by Frédéric VANNIÈRE on-web.fr // Platform.sh : https://platform.sh // Submitted by Nikola Kotur *.upsun.app upsunapp.com ent.platform.sh eu.platform.sh us.platform.sh *.platformsh.site *.tst.site // Platter : https://platter.dev // Submitted by Patrick Flor platter-app.dev platterp.us // Pley AB : https://www.pley.com/ // Submitted by Henning Pohl pley.games // Porter : https://porter.run/ // Submitted by Rudraksh MK onporter.run // Positive Codes Technology Company : http://co.bn/faq.html // Submitted by Zulfais co.bn // Postman, Inc : https://postman.com // Submitted by Rahul Dhawan postman-echo.com pstmn.io mock.pstmn.io httpbin.org // prequalifyme.today : https://prequalifyme.today // Submitted by DeepakTiwari deepak@ivylead.io prequalifyme.today // prgmr.com : https://prgmr.com/ // Submitted by Sarah Newman xen.prgmr.com // priv.at : http://www.nic.priv.at/ // Submitted by registry priv.at // PROJECT ELIV : https://eliv.kr/ // Submitted by PROJECT ELIV Domain Team c01.kr eliv-cdn.kr eliv-dns.kr mmv.kr vki.kr // project-study : https://project-study.com // Submitted by yumenewa dev.project-study.com // Protonet GmbH : http://protonet.io // Submitted by Martin Meier protonet.io // PT Ekossistim Indo Digital : https://e.id // Submitted by Eid Team e.id // Publication Presse Communication SARL : https://ppcom.fr // Submitted by Yaacov Akiba Slama chirurgiens-dentistes-en-france.fr byen.site // pubtls.org : https://www.pubtls.org // Submitted by Kor Nielsen pubtls.org // PythonAnywhere LLP : https://www.pythonanywhere.com // Submitted by Giles Thomas pythonanywhere.com eu.pythonanywhere.com // QA2 // Submitted by Daniel Dent : https://www.danieldent.com/ qa2.com // QCX // Submitted by Cassandra Beelen qcx.io *.sys.qcx.io // QNAP System Inc : https://www.qnap.com // Submitted by Nick Chang myqnapcloud.cn alpha-myqnapcloud.com dev-myqnapcloud.com mycloudnas.com mynascloud.com myqnapcloud.com // QOTO, Org. // Submitted by Jeffrey Phillips Freeman qoto.io // Qualifio : https://qualifio.com/ // Submitted by Xavier De Cock qualifioapp.com // Quality Unit : https://qualityunit.com // Submitted by Vasyl Tsalko ladesk.com // Qualy : https://qualyhq.com // Submitted by Raphael Arias *.qualyhqpartner.com *.qualyhqportal.com // QuickBackend : https://www.quickbackend.com // Submitted by Dani Biro qbuser.com // Quip : https://quip.com // Submitted by Patrick Linehan *.quipelements.com // Qutheory LLC : http://qutheory.io // Submitted by Jonas Schwartz vapor.cloud vaporcloud.io // Rackmaze LLC : https://www.rackmaze.com // Submitted by Kirill Pertsev rackmaze.com rackmaze.net // Rad Web Hosting : https://radwebhosting.com // Submitted by Scott Claeys cloudsite.builders myradweb.net servername.us // Radix FZC : http://domains.in.net // Submitted by Gavin Brown web.in in.net // Raidboxes GmbH : https://raidboxes.de // Submitted by Auke Tembrink myrdbx.io site.rb-hosting.io // Railway Corporation : https://railway.com // Submitted by Phineas Walton up.railway.app // Rancher Labs, Inc : https://rancher.com // Submitted by Vincent Fiduccia *.on-rancher.cloud *.on-k3s.io *.on-rio.io // RavPage : https://www.ravpage.co.il // Submitted by Roni Horowitz ravpage.co.il // Read The Docs, Inc : https://www.readthedocs.org // Submitted by David Fischer readthedocs-hosted.com readthedocs.io // Red Hat, Inc. OpenShift : https://openshift.redhat.com/ // Submitted by Tim Kramer rhcloud.com // Redgate Software : https://red-gate.com // Submitted by Andrew Farries instances.spawn.cc // Render : https://render.com // Submitted by Anurag Goel onrender.com app.render.com // Repl.it : https://repl.it // Submitted by Lincoln Bergeson replit.app id.replit.app firewalledreplit.co id.firewalledreplit.co repl.co id.repl.co replit.dev archer.replit.dev bones.replit.dev canary.replit.dev global.replit.dev hacker.replit.dev id.replit.dev janeway.replit.dev kim.replit.dev kira.replit.dev kirk.replit.dev odo.replit.dev paris.replit.dev picard.replit.dev pike.replit.dev prerelease.replit.dev reed.replit.dev riker.replit.dev sisko.replit.dev spock.replit.dev staging.replit.dev sulu.replit.dev tarpit.replit.dev teams.replit.dev tucker.replit.dev wesley.replit.dev worf.replit.dev repl.run // Resin.io : https://resin.io // Submitted by Tim Perry resindevice.io devices.resinstaging.io // RethinkDB : https://www.rethinkdb.com/ // Submitted by Chris Kastorff hzc.io // Rico Developments Limited : https://adimo.co // Submitted by Colin Brown adimo.co.uk // Riseup Networks : https://riseup.net // Submitted by Micah Anderson itcouldbewor.se // Roar Domains LLC : https://roar.basketball/ // Submitted by Gavin Brown aus.basketball nz.basketball // ROBOT PAYMENT INC. : https://www.robotpayment.co.jp/ // Submitted by Kentaro Takamori subsc-pay.com subsc-pay.net // Rochester Institute of Technology : http://www.rit.edu/ // Submitted by Jennifer Herting git-pages.rit.edu // Rocky Enterprise Software Foundation : https://resf.org // Submitted by Neil Hanlon rocky.page // Ruhr University Bochum : https://www.ruhr-uni-bochum.de/ // Submitted by Andreas Jobs rub.de ruhr-uni-bochum.de io.noc.ruhr-uni-bochum.de // Rusnames Limited : http://rusnames.ru/ // Submitted by Sergey Zotov биз.рус ком.рус крым.рус мир.рус мск.рус орг.рус самара.рус сочи.рус спб.рус я.рус // Russian Academy of Sciences // Submitted by Tech Support ras.ru // Sakura Frp : https://www.natfrp.com // Submitted by Bobo Liu nyat.app // SAKURA Internet Inc. : https://www.sakura.ad.jp/ // Submitted by Internet Service Department 180r.com dojin.com sakuratan.com sakuraweb.com x0.com 2-d.jp bona.jp crap.jp daynight.jp eek.jp flop.jp halfmoon.jp jeez.jp matrix.jp mimoza.jp ivory.ne.jp mail-box.ne.jp mints.ne.jp mokuren.ne.jp opal.ne.jp sakura.ne.jp sumomo.ne.jp topaz.ne.jp netgamers.jp nyanta.jp o0o0.jp rdy.jp rgr.jp rulez.jp s3.isk01.sakurastorage.jp s3.isk02.sakurastorage.jp saloon.jp sblo.jp skr.jp tank.jp uh-oh.jp undo.jp rs.webaccel.jp user.webaccel.jp websozai.jp xii.jp squares.net jpn.org kirara.st x0.to from.tv sakura.tv // Salesforce.com, Inc. : https://salesforce.com/ // Submitted by Salesforce Public Suffix List Team *.builder.code.com *.dev-builder.code.com *.stg-builder.code.com *.001.test.code-builder-stg.platform.salesforce.com *.d.crm.dev *.w.crm.dev *.wa.crm.dev *.wb.crm.dev *.wc.crm.dev *.wd.crm.dev *.we.crm.dev *.wf.crm.dev // Sandstorm Development Group, Inc. : https://sandcats.io/ // Submitted by Asheesh Laroia sandcats.io // SBE network solutions GmbH : https://www.sbe.de/ // Submitted by Norman Meilick logoip.com logoip.de // Scaleway : https://www.scaleway.com/ // Submitted by Scaleway PSL Maintainer fr-par-1.baremetal.scw.cloud fr-par-2.baremetal.scw.cloud nl-ams-1.baremetal.scw.cloud cockpit.fr-par.scw.cloud ddl.fr-par.scw.cloud dtwh.fr-par.scw.cloud fnc.fr-par.scw.cloud functions.fnc.fr-par.scw.cloud ifr.fr-par.scw.cloud k8s.fr-par.scw.cloud nodes.k8s.fr-par.scw.cloud kafk.fr-par.scw.cloud mgdb.fr-par.scw.cloud rdb.fr-par.scw.cloud s3.fr-par.scw.cloud s3-website.fr-par.scw.cloud scbl.fr-par.scw.cloud whm.fr-par.scw.cloud priv.instances.scw.cloud pub.instances.scw.cloud k8s.scw.cloud cockpit.nl-ams.scw.cloud ddl.nl-ams.scw.cloud dtwh.nl-ams.scw.cloud ifr.nl-ams.scw.cloud k8s.nl-ams.scw.cloud nodes.k8s.nl-ams.scw.cloud kafk.nl-ams.scw.cloud mgdb.nl-ams.scw.cloud rdb.nl-ams.scw.cloud s3.nl-ams.scw.cloud s3-website.nl-ams.scw.cloud scbl.nl-ams.scw.cloud whm.nl-ams.scw.cloud cockpit.pl-waw.scw.cloud ddl.pl-waw.scw.cloud dtwh.pl-waw.scw.cloud ifr.pl-waw.scw.cloud k8s.pl-waw.scw.cloud nodes.k8s.pl-waw.scw.cloud kafk.pl-waw.scw.cloud mgdb.pl-waw.scw.cloud rdb.pl-waw.scw.cloud s3.pl-waw.scw.cloud s3-website.pl-waw.scw.cloud scbl.pl-waw.scw.cloud scalebook.scw.cloud smartlabeling.scw.cloud dedibox.fr // schokokeks.org GbR : https://schokokeks.org/ // Submitted by Hanno Böck schokokeks.net // Scottish Government : https://www.gov.scot // Submitted by Martin Ellis gov.scot service.gov.scot // Scry Security : http://www.scrysec.com // Submitted by Shante Adam scrysec.com // Scrypted : https://scrypted.app // Submitted by Koushik Dutta client.scrypted.io // Securepoint GmbH : https://www.securepoint.de // Submitted by Erik Anders firewall-gateway.com firewall-gateway.de my-gateway.de my-router.de spdns.de spdns.eu firewall-gateway.net my-firewall.org myfirewall.org spdns.org // Seidat : https://www.seidat.com // Submitted by Artem Kondratev seidat.net // Sellfy : https://sellfy.com // Submitted by Yuriy Romadin sellfy.store // Sendmsg : https://www.sendmsg.co.il // Submitted by Assaf Stern minisite.ms // Senseering GmbH : https://www.senseering.de // Submitted by Felix Mönckemeyer senseering.net // Servebolt AS : https://servebolt.com // Submitted by Daniel Kjeserud servebolt.cloud // Service Online LLC : http://drs.ua/ // Submitted by Serhii Bulakh biz.ua co.ua pp.ua // Shanghai Accounting Society : https://www.sasf.org.cn // Submitted by Information Administration as.sh.cn // Sheezy.Art : https://sheezy.art // Submitted by Nyoom sheezy.games // Shopblocks : http://www.shopblocks.com/ // Submitted by Alex Bowers myshopblocks.com // Shopify : https://www.shopify.com // Submitted by Alex Richter myshopify.com // Shopit : https://www.shopitcommerce.com/ // Submitted by Craig McMahon shopitsite.com // shopware AG : https://shopware.com // Submitted by Jens Küper shopware.shop shopware.store // Siemens Mobility GmbH // Submitted by Oliver Graebner mo-siemens.io // SinaAppEngine : http://sae.sina.com.cn/ // Submitted by SinaAppEngine 1kapp.com appchizi.com applinzi.com sinaapp.com vipsinaapp.com // Siteleaf : https://www.siteleaf.com/ // Submitted by Skylar Challand siteleaf.net // Small Technology Foundation : https://small-tech.org // Submitted by Aral Balkan small-web.org // Smallregistry by Promopixel SARL : https://www.smallregistry.net // Former AFNIC's SLDs // Submitted by Jérôme Lipowicz aeroport.fr avocat.fr chambagri.fr chirurgiens-dentistes.fr experts-comptables.fr medecin.fr notaires.fr pharmacien.fr port.fr veterinaire.fr // Smoove.io : https://www.smoove.io/ // Submitted by Dan Kozak vp4.me // Snowflake Inc : https://www.snowflake.com/ // Submitted by Sam Haar *.snowflake.app *.privatelink.snowflake.app streamlit.app streamlitapp.com // Snowplow Analytics : https://snowplowanalytics.com/ // Submitted by Ian Streeter try-snowplow.com // Software Consulting Michal Zalewski : https://www.mafelo.com // Submitted by Michal Zalewski mafelo.net // Sony Interactive Entertainment LLC : https://sie.com/ // Submitted by David Coles playstation-cloud.com // SourceHut : https://sourcehut.org // Submitted by Drew DeVault srht.site // SourceLair PC : https://www.sourcelair.com // Submitted by Antonis Kalipetis apps.lair.io *.stolos.io // sourceWAY GmbH : https://sourceway.de // Submitted by Richard Reiber 4.at my.at my.de *.nxa.eu nx.gw // SpeedPartner GmbH : https://www.speedpartner.de/ // Submitted by Stefan Neufeind customer.speedpartner.de // Spreadshop (sprd.net AG) : https://www.spreadshop.com/ // Submitted by Martin Breest myspreadshop.at myspreadshop.com.au myspreadshop.be myspreadshop.ca myspreadshop.ch myspreadshop.com myspreadshop.de myspreadshop.dk myspreadshop.es myspreadshop.fi myspreadshop.fr myspreadshop.ie myspreadshop.it myspreadshop.net myspreadshop.nl myspreadshop.no myspreadshop.pl myspreadshop.se myspreadshop.co.uk // StackBlitz : https://stackblitz.com // Submitted by Dominic Elm w-corp-staticblitz.com w-credentialless-staticblitz.com w-staticblitz.com // Stackhero : https://www.stackhero.io // Submitted by Adrien Gillon stackhero-network.com // STACKIT GmbH & Co. KG : https://www.stackit.de/en/ // Submitted by STACKIT-DNS Team (Simon Stier) runs.onstackit.cloud stackit.gg stackit.rocks stackit.run stackit.zone // Staclar : https://staclar.com // Submitted by Q Misell // Submitted by Matthias Merkel musician.io novecore.site // Standard Library : https://stdlib.com // Submitted by Jacob Lee api.stdlib.com // stereosense GmbH : https://www.involve.me // Submitted by Florian Burmann feedback.ac forms.ac assessments.cx calculators.cx funnels.cx paynow.cx quizzes.cx researched.cx tests.cx surveys.so // Storacha Network : https://storacha.network // Submitted by Alan Shaw ipfs.storacha.link ipfs.w3s.link // Storebase : https://www.storebase.io // Submitted by Tony Schirmer storebase.store // Storipress : https://storipress.com // Submitted by Benno Liu storipress.app // Storj Labs Inc. : https://storj.io/ // Submitted by Philip Hutchins storj.farm // Strapi : https://strapi.io/ // Submitted by Florent Baldino strapiapp.com media.strapiapp.com // Strategic System Consulting (eApps Hosting) : https://www.eapps.com/ // Submitted by Alex Oancea vps-host.net atl.jelastic.vps-host.net njs.jelastic.vps-host.net ric.jelastic.vps-host.net // Streak : https://streak.com // Submitted by Blake Kadatz streak-link.com streaklinks.com streakusercontent.com // Student-Run Computing Facility : https://www.srcf.net/ // Submitted by Edwin Balani soc.srcf.net user.srcf.net // Studenten Net Twente : http://www.snt.utwente.nl/ // Submitted by Silke Hofstra utwente.io // Sub 6 Limited : http://www.sub6.com // Submitted by Dan Miller temp-dns.com // Supabase : https://supabase.io // Submitted by Supabase Security supabase.co realtime.supabase.co storage.supabase.co supabase.in supabase.net // Syncloud : https://syncloud.org // Submitted by Boris Rybalkin syncloud.it // Synology, Inc. : https://www.synology.com/ // Submitted by Rony Weng dscloud.biz direct.quickconnect.cn dsmynas.com familyds.com diskstation.me dscloud.me i234.me myds.me synology.me dscloud.mobi dsmynas.net familyds.net dsmynas.org familyds.org direct.quickconnect.to vpnplus.to // Tabit Technologies Ltd. : https://tabit.cloud/ // Submitted by Oren Agiv mytabit.com mytabit.co.il tabitorder.co.il // TAIFUN Software AG : http://taifun-software.de // Submitted by Bjoern Henke taifun-dns.de // Tailor Inc. : https://www.tailor.tech // Submitted by Ryuzo Yamamoto erp.dev web.erp.dev // Tailscale Inc. : https://www.tailscale.com // Submitted by David Anderson ts.net *.c.ts.net // TASK geographical domains : https://task.gda.pl/en/services/for-entrepreneurs/ gda.pl gdansk.pl gdynia.pl med.pl sopot.pl // Tave Creative Corp : https://tave.com/ // Submitted by Adrian Ziemkowski taveusercontent.com // tawk.to, Inc : https://www.tawk.to // Submitted by tawk.to developer team p.tawk.email p.tawkto.email // Tche.br : https://tche.br // Submitted by Bruno Lorensi tche.br // team.blue : https://team.blue // Submitted by Cedric Dubois site.tb-hosting.com // Teckids e.V. : https://www.teckids.org // Submitted by Dominik George edugit.io s3.teckids.org // Telebit : https://telebit.cloud // Submitted by AJ ONeal telebit.app telebit.io *.telebit.xyz // Teleport : https://goteleport.com // Submitted by Rob Picard teleport.sh // Thingdust AG : https://thingdust.com/ // Submitted by Adrian Imboden *.firenet.ch *.svc.firenet.ch reservd.com thingdustdata.com cust.dev.thingdust.io reservd.dev.thingdust.io cust.disrec.thingdust.io reservd.disrec.thingdust.io cust.prod.thingdust.io cust.testing.thingdust.io reservd.testing.thingdust.io // ticket i/O GmbH : https://ticket.io // Submitted by Christian Franke tickets.io // Tlon.io : https://tlon.io // Submitted by Mark Staarink arvo.network azimuth.network tlon.network // Tor Project, Inc. : https://torproject.org // Submitted by Antoine Beaupré torproject.net pages.torproject.net // TownNews.com : http://www.townnews.com // Submitted by Dustin Ward townnews-staging.com // TrafficPlex GmbH : https://www.trafficplex.de/ // Submitted by Phillipp Röll 12hp.at 2ix.at 4lima.at lima-city.at 12hp.ch 2ix.ch 4lima.ch lima-city.ch trafficplex.cloud de.cool 12hp.de 2ix.de 4lima.de lima-city.de 1337.pictures clan.rip lima-city.rocks webspace.rocks lima.zone // TransIP : https://www.transip.nl // Submitted by Rory Breuk and Cedric Dubois *.transurl.be *.transurl.eu site.transip.me *.transurl.nl // TuxFamily : http://tuxfamily.org // Submitted by TuxFamily administrators tuxfamily.org // TwoDNS : https://www.twodns.de/ // Submitted by TwoDNS-Support dd-dns.de dray-dns.de draydns.de dyn-vpn.de dynvpn.de mein-vigor.de my-vigor.de my-wan.de syno-ds.de synology-diskstation.de synology-ds.de diskstation.eu diskstation.org // Typedream : https://typedream.com // Submitted by Putri Karunia typedream.app // Typeform : https://www.typeform.com // Submitted by Typeform pro.typeform.com // Uberspace : https://uberspace.de // Submitted by Moritz Werner uber.space // UDR Limited : http://www.udr.hk.com // Submitted by registry hk.com inc.hk ltd.hk hk.org // UK Intis Telecom LTD : https://it.com // Submitted by ITComdomains it.com // Unison Computing, PBC : https://unison.cloud // Submitted by Simon Højberg unison-services.cloud // United Gameserver GmbH : https://united-gameserver.de // Submitted by Stefan Schwarz virtual-user.de virtualuser.de // United States Writing Corporation : https://uswriting.co // Submitted by Andrew Sampson obj.ag // UNIVERSAL DOMAIN REGISTRY : https://www.udr.org.yt/ // see also: whois -h whois.udr.org.yt help // Submitted by Atanunu Igbunuroghene name.pm sch.tf biz.wf sch.wf org.yt // University of Banja Luka : https://unibl.org // Domains for Republic of Srpska administrative entity. // Submitted by Marko Ivanovic rs.ba // University of Bielsko-Biala regional domain : http://dns.bielsko.pl/ // Submitted by Marcin bielsko.pl // urown.net : https://urown.net // Submitted by Hostmaster urown.cloud dnsupdate.info // US REGISTRY LLC : http://us.org // Submitted by Gavin Brown us.org // V.UA Domain Registry: https://www.v.ua/ // Submitted by Serhii Rostilo v.ua // Val Town, Inc : https://val.town/ // Submitted by Tom MacWright val.run web.val.run // Vercel, Inc : https://vercel.com/ // Submitted by Laurens Duijvesteijn vercel.app v0.build vercel.dev vusercontent.net vercel.run now.sh // VeryPositive SIA : http://very.lv // Submitted by Danko Aleksejevs 2038.io // Virtual-Info : https://www.virtual-info.info/ // Submitted by Adnan RIHAN v-info.info // VistaBlog : https://vistablog.ir/ // Submitted by Hossein Piri vistablog.ir // Viva Republica, Inc. : https://toss.im/ // Submitted by Deus Team deus-canvas.com // Voorloper.com : https://voorloper.com // Submitted by Nathan van Bakel voorloper.cloud // Vultr Objects : https://www.vultr.com/products/object-storage/ // Submitted by Niels Maumenee *.vultrobjects.com // Waffle Computer Inc., Ltd. : https://docs.waffleinfo.com // Submitted by Masayuki Note wafflecell.com // Walrus : https://walrus.xyz // Submitted by Max Spector wal.app // Webflow, Inc. : https://www.webflow.com // Submitted by Webflow Security Team webflow.io webflowtest.io // WebHare bv : https://www.webhare.com/ // Submitted by Arnold Hendriks *.webhare.dev // WebHotelier Technologies Ltd : https://www.webhotelier.net/ // Submitted by Apostolos Tsakpinis bookonline.app hotelwithflight.com reserve-online.com reserve-online.net // WebPros International, LLC : https://webpros.com/ // Submitted by Nicolas Rochelemagne cprapid.com pleskns.com wp2.host pdns.page plesk.page cpanel.site wpsquared.site // WebWaddle Ltd : https://webwaddle.com/ // Submitted by Merlin Glander *.wadl.top // Western Digital Technologies, Inc : https://www.wdc.com // Submitted by Jung Jin remotewd.com // Whatbox Inc. : https://whatbox.ca/ // Submitted by Anthony Ryan box.ca // WIARD Enterprises : https://wiardweb.com // Submitted by Kidd Hustle pages.wiardweb.com // Wikimedia Foundation : https://wikitech.wikimedia.org // Submitted by Timo Tijhof toolforge.org wmcloud.org beta.wmcloud.org wmflabs.org // William Harrison : https://wharrison.com.au // Submitted by William Harrison wdh.app hrsn.au vps.hrsn.au hrsn.dev // Windsurf : https://windsurf.com // Submitted by Douglas Chen windsurf.app windsurf.build // WISP : https://wisp.gg // Submitted by Stepan Fedotov panel.gg daemon.panel.gg // Wix.com, Inc. : https://www.wix.com // Submitted by Shahar Talmi / Alon Kochba wixsite.com wixstudio.com editorx.io wixstudio.io wix.run // Wizard Zines : https://wizardzines.com // Submitted by Julia Evans messwithdns.com // WoltLab GmbH : https://www.woltlab.com // Submitted by Tim Düsterhus woltlab-demo.com myforum.community community-pro.de diskussionsbereich.de community-pro.net meinforum.net // Woods Valldata : https://www.woodsvalldata.co.uk/ // Submitted by Chris Whittle affinitylottery.org.uk raffleentry.org.uk weeklylottery.org.uk // WP Engine : https://wpengine.com/ // Submitted by Michael Smith // Submitted by Brandon DuRette wpenginepowered.com js.wpenginepowered.com // XenonCloud GbR : https://xenoncloud.net // Submitted by Julian Uphoff half.host // XnBay Technology : http://www.xnbay.com/ // Submitted by XnBay Developer xnbay.com u2.xnbay.com u2-local.xnbay.com // XS4ALL Internet bv : https://www.xs4all.nl/ // Submitted by Daniel Mostertman cistron.nl demon.nl xs4all.space // Yandex.Cloud LLC : https://cloud.yandex.com // Submitted by Alexander Lodin yandexcloud.net storage.yandexcloud.net website.yandexcloud.net sourcecraft.site // YesCourse Pty Ltd : https://yescourse.com // Submitted by Atul Bhouraskar official.academy // Yola : https://www.yola.com/ // Submitted by Stefano Rivera yolasite.com // Yunohost : https://yunohost.org // Submitted by Valentin Grimaud ynh.fr nohost.me noho.st // ZaNiC : http://www.za.net/ // Submitted by registry za.net za.org // ZAP-Hosting GmbH & Co. KG : https://zap-hosting.com // Submitted by Julian Alker zap.cloud // Zeabur : https://zeabur.com/ // Submitted by Zeabur Team zeabur.app // Zerops : https://zerops.io/ // Submitted by Zerops Team *.zerops.app // Zine EOOD : https://zine.bg/ // Submitted by Martin Angelov bss.design // Zitcom A/S : https://www.zitcom.dk // Submitted by Emil Stahl basicserver.io virtualserver.io enterprisecloud.nu // Zone.ID: https://zone.id // Submitted by Gx1.org zone.id // ZoneABC : https://zoneabc.net // Submitted by ZoneABC Team zabc.net // ===END PRIVATE DOMAINS=== httpclient5/src/main/resources/org/publicsuffix/list/readme.txt0100664 0000000 0000000 00000002302 14704162040 024035 0ustar000000000 0000000 // Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. // ==================================================================== // // This software consists of voluntary contributions made by many // individuals on behalf of the Apache Software Foundation. For more // information on the Apache Software Foundation, please see // . The file effective_tld_names.dat in this folder is a copy of https://publicsuffix.org/list/effective_tld_names.dat httpclient5/src/main/java/0040775 0000000 0000000 00000000000 14666635064 014531 5ustar000000000 0000000 httpclient5/src/main/java/org/0040775 0000000 0000000 00000000000 14666635064 015320 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/0040775 0000000 0000000 00000000000 14666635064 016541 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/0040775 0000000 0000000 00000000000 14666635064 017133 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/0040775 0000000 0000000 00000000000 14666635064 020476 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/0040775 0000000 0000000 00000000000 15063503632 021440 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/package-info.java0100664 0000000 0000000 00000002604 14666635064 024643 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client component APIs common to all client transports * such as connection route information and resolution * as well as common HTTP method definitions and * exception classes. */ package org.apache.hc.client5.http; httpclient5/src/main/java/org/apache/hc/client5/http/config/0040775 0000000 0000000 00000000000 15063503637 022712 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/config/package-info.java0100664 0000000 0000000 00000002367 14666635064 026116 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * HTTP client configuration APIs. */ package org.apache.hc.client5.http.config; httpclient5/src/main/java/org/apache/hc/client5/http/config/ConnectionConfig.java0100664 0000000 0000000 00000020274 15063503637 027004 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.config; import java.util.concurrent.TimeUnit; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Immutable class encapsulating connection initialization and management settings. * * @since 5.2 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class ConnectionConfig implements Cloneable { private static final Timeout DEFAULT_CONNECT_TIMEOUT = Timeout.ofMinutes(3); public static final ConnectionConfig DEFAULT = new Builder().build(); private final Timeout connectTimeout; private final Timeout socketTimeout; private final TimeValue validateAfterInactivity; private final TimeValue timeToLive; /** * Intended for CDI compatibility */ protected ConnectionConfig() { this(DEFAULT_CONNECT_TIMEOUT, null, null, null); } ConnectionConfig( final Timeout connectTimeout, final Timeout socketTimeout, final TimeValue validateAfterInactivity, final TimeValue timeToLive) { super(); this.connectTimeout = connectTimeout; this.socketTimeout = socketTimeout; this.validateAfterInactivity = validateAfterInactivity; this.timeToLive = timeToLive; } /** * @see Builder#setSocketTimeout(Timeout) */ public Timeout getSocketTimeout() { return socketTimeout; } /** * @see Builder#setConnectTimeout(Timeout) */ public Timeout getConnectTimeout() { return connectTimeout; } /** * @see Builder#setValidateAfterInactivity(TimeValue) */ public TimeValue getValidateAfterInactivity() { return validateAfterInactivity; } /** * @see Builder#setTimeToLive(TimeValue) (TimeValue) */ public TimeValue getTimeToLive() { return timeToLive; } @Override protected ConnectionConfig clone() throws CloneNotSupportedException { return (ConnectionConfig) super.clone(); } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("["); builder.append("connectTimeout=").append(connectTimeout); builder.append(", socketTimeout=").append(socketTimeout); builder.append(", validateAfterInactivity=").append(validateAfterInactivity); builder.append(", timeToLive=").append(timeToLive); builder.append("]"); return builder.toString(); } public static ConnectionConfig.Builder custom() { return new Builder(); } public static ConnectionConfig.Builder copy(final ConnectionConfig config) { return new Builder() .setConnectTimeout(config.getConnectTimeout()) .setSocketTimeout(config.getSocketTimeout()) .setValidateAfterInactivity(config.getValidateAfterInactivity()) .setTimeToLive(config.getTimeToLive()); } public static class Builder { private Timeout socketTimeout; private Timeout connectTimeout; private TimeValue validateAfterInactivity; private TimeValue timeToLive; Builder() { super(); this.connectTimeout = DEFAULT_CONNECT_TIMEOUT; } /** * @return this instance. * @see #setSocketTimeout(Timeout) */ public Builder setSocketTimeout(final int soTimeout, final TimeUnit timeUnit) { this.socketTimeout = Timeout.of(soTimeout, timeUnit); return this; } /** * Determines the default socket timeout value for I/O operations on * connections created by this configuration. * A timeout value of zero is interpreted as an infinite timeout. *

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

*

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

* * @return this instance. */ public Builder setSocketTimeout(final Timeout soTimeout) { this.socketTimeout = soTimeout; return this; } /** * Determines the timeout until a new connection is fully established. *

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

*

* Default: 3 minutes *

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

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

* * @return this instance. */ public Builder setValidateAfterInactivity(final TimeValue validateAfterInactivity) { this.validateAfterInactivity = validateAfterInactivity; return this; } /** * @return this instance. * @see #setValidateAfterInactivity(TimeValue) */ public Builder setValidateAfterInactivity(final long validateAfterInactivity, final TimeUnit timeUnit) { this.validateAfterInactivity = TimeValue.of(validateAfterInactivity, timeUnit); return this; } /** * Defines the total span of time connections can be kept alive or execute requests. *

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

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

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

*

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

*

* Default: {@code false} *

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

* Default: {@code null} *

* * @return this instance. * @deprecated Use {@link org.apache.hc.client5.http.impl.routing.DefaultProxyRoutePlanner} * or a custom {@link org.apache.hc.client5.http.routing.HttpRoutePlanner}. */ @Deprecated public Builder setProxy(final HttpHost proxy) { this.proxy = proxy; return this; } /** * Determines the name of the cookie specification to be used for HTTP state * management. *

* Default: {@code null} *

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

* Default: {@code true} *

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

* Default: {@code false} *

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

* Default: {@code 50} *

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

* Default: {@code true} *

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

* Default: {@code null} *

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

* Default: {@code null} *

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

* Default: 3 minutes. *

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

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

*

* Default: 3 minutes *

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

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

*

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

*

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

*

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

*

* Default: {@code null} *

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

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

*

* Default: 3 minutes *

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

* Default: {@code true} *

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

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

*

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

*

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

*

* Default: {@code true} *

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

* Presently supported: HTTP/1.1 TLS upgrade *

*

* Default: {@code true} *

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

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

*

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

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

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

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

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

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

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

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

* Default: {@link HttpVersionPolicy#NEGOTIATE} *

* * @return this instance. */ public Builder setVersionPolicy(final HttpVersionPolicy versionPolicy) { this.versionPolicy = versionPolicy; return this; } public TlsConfig build() { return new TlsConfig( handshakeTimeout, supportedProtocols, supportedCipherSuites, versionPolicy != null ? versionPolicy : HttpVersionPolicy.NEGOTIATE); } } } httpclient5/src/main/java/org/apache/hc/client5/http/config/Configurable.java0100664 0000000 0000000 00000002715 14704162040 026145 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.config; /** * Configuration interface for HTTP requests. * * @since 4.3 */ public interface Configurable { /** * Gets the actual request configuration. * * @return the actual request configuration. */ RequestConfig getConfig(); } httpclient5/src/main/java/org/apache/hc/client5/http/auth/0040775 0000000 0000000 00000000000 15005672016 022400 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/auth/package-info.java0100664 0000000 0000000 00000002366 14666635064 025611 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client HTTP authentication APIs. */ package org.apache.hc.client5.http.auth; httpclient5/src/main/java/org/apache/hc/client5/http/auth/Credentials.java0100664 0000000 0000000 00000003232 14666635064 025513 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.security.Principal; /** * This interface represents a set of credentials consisting of a security * principal and a secret (password) that can be used to establish user * identity * * @since 4.0 */ public interface Credentials { Principal getUserPrincipal(); /** * @deprecated Use specific credentials class that represent a username / password * set of a security token. */ @Deprecated char[] getPassword(); } httpclient5/src/main/java/org/apache/hc/client5/http/auth/ChallengeType.java0100664 0000000 0000000 00000002471 14666635064 026006 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; /** * Challenge type (TARGET or PROXY) * * @since 4.2 */ public enum ChallengeType { TARGET, PROXY } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthSchemeFactory.java0100664 0000000 0000000 00000003010 14666635064 026626 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.http.protocol.HttpContext; /** * Factory for {@link AuthScheme} implementations. * * @since 4.3 */ public interface AuthSchemeFactory { /** * Creates an instance of {@link AuthScheme}. * * @return auth scheme. */ AuthScheme create(HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/auth/CredentialsStore.java0100664 0000000 0000000 00000004134 14666635064 026532 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; /** * Abstract store of authentication credentials. *

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

* * @since 4.0 */ public interface CredentialsStore extends CredentialsProvider { /** * Sets the {@link Credentials credentials} for the given authentication * scope. Any previous credentials for the given scope will be overwritten. * * @param authScope the {@link AuthScope authentication scope} * @param credentials the authentication {@link Credentials credentials} * for the given scope. * * @see #getCredentials(AuthScope, org.apache.hc.core5.http.protocol.HttpContext) */ void setCredentials(AuthScope authScope, Credentials credentials); /** * Clears all credentials. */ void clear(); } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthExchange.java0100664 0000000 0000000 00000010224 15005672016 025603 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.util.Queue; import org.apache.hc.core5.util.Args; /** * This class represents the actual state of authentication handshake including the current {@link AuthScheme} * used for request authorization as well as a collection of backup authentication options if available. * * @since 4.5 */ public class AuthExchange { // This only tracks the server state. In particular, even if the state is SUCCESS, // the authentication may still fail if the challenge sent with a response cannot // be validated locally in case of a mutual authentication. public enum State { UNCHALLENGED, CHALLENGED, HANDSHAKE, FAILURE, SUCCESS } private State state; private AuthScheme authScheme; private Queue authOptions; private String pathPrefix; public AuthExchange() { super(); this.state = State.UNCHALLENGED; } public void reset() { this.state = State.UNCHALLENGED; this.authOptions = null; this.authScheme = null; this.pathPrefix = null; } public State getState() { return this.state; } public void setState(final State state) { this.state = state != null ? state : State.UNCHALLENGED; } /** * Returns actual {@link AuthScheme}. May be null. */ public AuthScheme getAuthScheme() { return this.authScheme; } /** * Returns {@code true} if the actual authentication scheme is connection based. */ public boolean isConnectionBased() { return this.authScheme != null && this.authScheme.isConnectionBased(); } /** * @since 5.2 */ public String getPathPrefix() { return pathPrefix; } /** * @since 5.2 */ public void setPathPrefix(final String pathPrefix) { this.pathPrefix = pathPrefix; } /** * Resets the auth state with {@link AuthScheme} and clears auth options. * * @param authScheme auth scheme. May not be null. */ public void select(final AuthScheme authScheme) { Args.notNull(authScheme, "Auth scheme"); this.authScheme = authScheme; this.authOptions = null; } /** * Returns available auth options. May be null. */ public Queue getAuthOptions() { return this.authOptions; } /** * Updates the auth state with a queue of auth options. * * @param authOptions a queue of auth options. May not be null or empty. */ public void setOptions(final Queue authOptions) { Args.notEmpty(authOptions, "Queue of auth options"); this.authOptions = authOptions; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append("[").append(this.state); if (this.authScheme != null) { buffer.append(" ").append(this.authScheme); } buffer.append("]"); return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthScheme.java0100664 0000000 0000000 00000024531 15005672016 025273 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.security.Principal; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; /** * This interface represents an abstract challenge-response oriented authentication scheme. *

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

*

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

*

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

*

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

*

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

*

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

*

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

*

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

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

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

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

* Please note if the scheme returns {@code true} from this method in response * to a challenge, it effectively implies a failure to respond to this challenge * and termination of the authentication process. * * @return {@code true} if the authentication process has been completed, * {@code false} otherwise. * * @since 5.0 */ boolean isChallengeComplete(); /** * Returns authentication realm. If the concept of an authentication * realm is not applicable to the given authentication scheme, returns * {@code null}. * * @return the authentication realm */ String getRealm(); /** * Determines whether or not an authorization response can be generated based on * the actual authentication state. Generally the outcome of this method will depend * upon availability of user credentials necessary to produce an authorization * response. * * @param credentialsProvider The credentials to be used for authentication * @param context HTTP context * @throws AuthenticationException if authorization string cannot * be generated due to an authentication failure * * @return {@code true} if an authorization response can be generated and * the authentication handshake can proceed, {@code false} otherwise. * * @since 5.0 */ boolean isResponseReady( HttpHost host, CredentialsProvider credentialsProvider, HttpContext context) throws AuthenticationException; /** * Returns {@link Principal} whose credentials are used to generate * an authentication response. Connection based schemes are required * to return a user {@link Principal} if authorization applies to * for the entire life span of connection. * @return user principal * * @see #isConnectionBased() * * @since 5.0 */ Principal getPrincipal(); /** * Generates an authorization response based on the current state. Some authentication * schemes may need to load user credentials required to generate an authorization * response from a {@link CredentialsProvider} prior to this method call. * * @param request The request being authenticated * @param context HTTP context * @throws AuthenticationException if authorization string cannot * be generated due to an authentication failure * * @return authorization header * * @see #isResponseReady(HttpHost, CredentialsProvider, HttpContext) * * @since 5.0 */ String generateAuthResponse( HttpHost host, HttpRequest request, HttpContext context) throws AuthenticationException; } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthChallenge.java0100664 0000000 0000000 00000006216 14666635064 025767 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.List; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.util.Args; /** * This class represents an authentication challenge consisting of a auth scheme * and either a single parameter or a list of name / value pairs. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class AuthChallenge { private final ChallengeType challengeType; private final String schemeName; private final String value; private final List params; public AuthChallenge(final ChallengeType challengeType, final String schemeName, final String value, final List params) { super(); this.challengeType = Args.notNull(challengeType, "Challenge type"); this.schemeName = Args.notNull(schemeName, "schemeName"); this.value = value; this.params = params != null ? Collections.unmodifiableList(new ArrayList<>(params)) : null; } public AuthChallenge(final ChallengeType challengeType, final String schemeName, final NameValuePair... params) { this(challengeType, schemeName, null, Arrays.asList(params)); } public ChallengeType getChallengeType() { return challengeType; } public String getSchemeName() { return schemeName; } public String getValue() { return value; } public List getParams() { return params; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append(schemeName).append(" "); if (value != null) { buffer.append(value); } else if (params != null) { buffer.append(params); } return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/UsernamePasswordCredentials.java0100664 0000000 0000000 00000007060 14666635064 030741 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.security.Principal; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Simple {@link Credentials} representation based on a user name / password * pair. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class UsernamePasswordCredentials implements Credentials, Serializable { private static final long serialVersionUID = 243343858802739403L; private final Principal principal; private final char[] password; /** * The constructor with the username and password arguments. * * @param principal the user principal * @param password the password * * @since 5.3 * * @see BasicUserPrincipal * @see NTUserPrincipal */ public UsernamePasswordCredentials(final Principal principal, final char[] password) { super(); this.principal = Args.notNull(principal, "User principal"); this.password = password; } /** * The constructor with the username and password arguments. * * @param username the user name * @param password the password */ public UsernamePasswordCredentials(final String username, final char[] password) { this(new BasicUserPrincipal(username), password); } @Override public Principal getUserPrincipal() { return this.principal; } public String getUserName() { return this.principal.getName(); } /** * @since 5.3 */ public char[] getUserPassword() { return password; } /** * @deprecated Use {@link #getUserPassword()}. */ @Deprecated @Override public char[] getPassword() { return password; } @Override public int hashCode() { return this.principal.hashCode(); } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof UsernamePasswordCredentials) { final UsernamePasswordCredentials that = (UsernamePasswordCredentials) o; return Objects.equals(this.principal, that.principal); } return false; } @Override public String toString() { return this.principal.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthScope.java0100664 0000000 0000000 00000021127 15005672016 025136 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.util.Locale; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; /** * {@code AuthScope} represents an authentication scope consisting of * an application protocol, a host name, a port number, a realm name * and an authentication scheme name. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class AuthScope { private final String protocol; private final String host; private final int port; private final String realm; private final String schemeName; /** * Defines auth scope with the given {@code protocol}, {@code host}, {@code port}, * {@code realm}, and {@code schemeName}. * * @param protocol application protocol. May be {@code null} if applies * to any protocol. * @param host authentication host. May be {@code null} if applies * to any host. * @param port authentication port. May be {@code -1} if applies * to any port of the host. * @param realm authentication realm. May be {@code null} if applies * to any realm on the host. * @param schemeName authentication scheme name. May be {@code null} if applies * to any auth scheme supported by the host. */ public AuthScope( final String protocol, final String host, final int port, final String realm, final String schemeName) { this.protocol = protocol != null ? protocol.toLowerCase(Locale.ROOT) : null; this.host = host != null ? host.toLowerCase(Locale.ROOT) : null; this.port = port >= 0 ? port : -1; this.realm = realm; this.schemeName = schemeName != null ? schemeName.toUpperCase(Locale.ROOT) : null; } /** * Defines auth scope for a specific host of origin. * * @param origin host of origin * @param realm authentication realm. May be {@code null} if applies * to any realm on the host. * @param schemeName authentication scheme name. May be {@code null} if applies * to any auth scheme supported by the host. * * @since 4.2 */ public AuthScope( final HttpHost origin, final String realm, final String schemeName) { Args.notNull(origin, "Host"); this.protocol = origin.getSchemeName().toLowerCase(Locale.ROOT); this.host = origin.getHostName().toLowerCase(Locale.ROOT); this.port = origin.getPort() >= 0 ? origin.getPort() : -1; this.realm = realm; this.schemeName = schemeName != null ? schemeName.toUpperCase(Locale.ROOT) : null; } /** * Defines auth scope for a specific host of origin. * * @param origin host of origin * * @since 4.2 */ public AuthScope(final HttpHost origin) { this(origin, null, null); } /** * Defines auth scope with the given {@code host} and {@code port}. * * @param host authentication host. May be {@code null} if applies * to any host. * @param port authentication port. May be {@code -1} if applies * to any port of the host. */ public AuthScope(final String host, final int port) { this(null, host, port, null, null); } /** * Creates a copy of the given credentials scope. */ public AuthScope(final AuthScope authScope) { super(); Args.notNull(authScope, "Scope"); this.protocol = authScope.getProtocol(); this.host = authScope.getHost(); this.port = authScope.getPort(); this.realm = authScope.getRealm(); this.schemeName = authScope.getSchemeName(); } public String getProtocol() { return protocol; } public String getHost() { return this.host; } public int getPort() { return this.port; } public String getRealm() { return this.realm; } public String getSchemeName() { return this.schemeName; } /** * Tests if the authentication scopes match. * * @return the match factor. Negative value signifies no match. * Non-negative signifies a match. The greater the returned value * the closer the match. */ public int match(final AuthScope that) { int factor = 0; if (Objects.equals(this.schemeName, that.schemeName)) { factor += 1; } else { if (this.schemeName != null && that.schemeName != null) { return -1; } } if (Objects.equals(this.realm, that.realm)) { factor += 2; } else { if (this.realm != null && that.realm != null) { return -1; } } if (this.port == that.port) { factor += 4; } else { if (this.port != -1 && that.port != -1) { return -1; } } if (Objects.equals(this.protocol, that.protocol)) { factor += 8; } else { if (this.protocol != null && that.protocol != null) { return -1; } } if (Objects.equals(this.host, that.host)) { factor += 16; } else { if (this.host != null && that.host != null) { return -1; } } return factor; } @Override public boolean equals(final Object obj) { if (this == obj) { return true; } if (obj instanceof AuthScope) { final AuthScope that = (AuthScope) obj; return Objects.equals(this.protocol, that.protocol) && Objects.equals(this.host, that.host) && this.port == that.port && Objects.equals(this.realm, that.realm) && Objects.equals(this.schemeName, that.schemeName); } return false; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.protocol); hash = LangUtils.hashCode(hash, this.host); hash = LangUtils.hashCode(hash, this.port); hash = LangUtils.hashCode(hash, this.realm); hash = LangUtils.hashCode(hash, this.schemeName); return hash; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); if (this.schemeName != null) { buffer.append(this.schemeName); } else { buffer.append(""); } buffer.append(' '); if (this.realm != null) { buffer.append('\''); buffer.append(this.realm); buffer.append('\''); } else { buffer.append(""); } buffer.append(' '); if (this.protocol != null) { buffer.append(this.protocol); } else { buffer.append(""); } buffer.append("://"); if (this.host != null) { buffer.append(this.host); } else { buffer.append(""); } buffer.append(':'); if (this.port >= 0) { buffer.append(this.port); } else { buffer.append(""); } return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/MalformedChallengeException.java0100664 0000000 0000000 00000004547 14666635064 030660 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.http.ProtocolException; /** * Signals that authentication challenge is in some way invalid or * illegal in the given context * * @since 4.0 */ public class MalformedChallengeException extends ProtocolException { private static final long serialVersionUID = 814586927989932284L; /** * Creates a new MalformedChallengeException with a {@code null} detail message. */ public MalformedChallengeException() { super(); } /** * Creates a new MalformedChallengeException with the specified message. * * @param message the exception detail message */ public MalformedChallengeException(final String message) { super(message); } /** * Creates a new MalformedChallengeException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public MalformedChallengeException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/InvalidCredentialsException.java0100664 0000000 0000000 00000004467 14666635064 030714 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; /** * Authentication credentials required to respond to a authentication * challenge are invalid * * @since 4.0 */ public class InvalidCredentialsException extends AuthenticationException { private static final long serialVersionUID = -4834003835215460648L; /** * Creates a new InvalidCredentialsException with a {@code null} detail message. */ public InvalidCredentialsException() { super(); } /** * Creates a new InvalidCredentialsException with the specified message. * * @param message the exception detail message */ public InvalidCredentialsException(final String message) { super(message); } /** * Creates a new InvalidCredentialsException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public InvalidCredentialsException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/BasicUserPrincipal.java0100664 0000000 0000000 00000005366 14666635064 027012 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.security.Principal; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; /** * Basic username based principal representation. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class BasicUserPrincipal implements Principal, Serializable { private static final long serialVersionUID = -2266305184969850467L; private final String username; public BasicUserPrincipal(final String username) { super(); Args.notNull(username, "User name"); this.username = username; } @Override public String getName() { return this.username; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.username); return hash; } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof BasicUserPrincipal) { final BasicUserPrincipal that = (BasicUserPrincipal) o; return Objects.equals(this.username, that.username); } return false; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append("[principal: "); buffer.append(this.username); buffer.append("]"); return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/KerberosConfig.java0100664 0000000 0000000 00000012003 14744133231 026136 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Immutable class encapsulating Kerberos configuration options. * * @since 4.6 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * */ @Deprecated @Contract(threading = ThreadingBehavior.IMMUTABLE) public class KerberosConfig implements Cloneable { public enum Option { DEFAULT, ENABLE, DISABLE } public static final KerberosConfig DEFAULT = new Builder().build(); private final Option stripPort; private final Option useCanonicalHostname; private final Option requestDelegCreds; /** * Intended for CDI compatibility */ protected KerberosConfig() { this(Option.DEFAULT, Option.DEFAULT, Option.DEFAULT); } KerberosConfig( final Option stripPort, final Option useCanonicalHostname, final Option requestDelegCreds) { super(); this.stripPort = stripPort; this.useCanonicalHostname = useCanonicalHostname; this.requestDelegCreds = requestDelegCreds; } public Option getStripPort() { return stripPort; } public Option getUseCanonicalHostname() { return useCanonicalHostname; } public Option getRequestDelegCreds() { return requestDelegCreds; } @Override protected KerberosConfig clone() throws CloneNotSupportedException { return (KerberosConfig) super.clone(); } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("["); builder.append("stripPort=").append(stripPort); builder.append(", useCanonicalHostname=").append(useCanonicalHostname); builder.append(", requestDelegCreds=").append(requestDelegCreds); builder.append("]"); return builder.toString(); } public static KerberosConfig.Builder custom() { return new Builder(); } public static KerberosConfig.Builder copy(final KerberosConfig config) { return new Builder() .setStripPort(config.getStripPort()) .setUseCanonicalHostname(config.getUseCanonicalHostname()) .setRequestDelegCreds(config.getRequestDelegCreds()); } public static class Builder { private Option stripPort; private Option useCanonicalHostname; private Option requestDelegCreds; Builder() { super(); this.stripPort = Option.DEFAULT; this.useCanonicalHostname = Option.DEFAULT; this.requestDelegCreds = Option.DEFAULT; } public Builder setStripPort(final Option stripPort) { this.stripPort = stripPort; return this; } public Builder setStripPort(final boolean stripPort) { this.stripPort = stripPort ? Option.ENABLE : Option.DISABLE; return this; } public Builder setUseCanonicalHostname(final Option useCanonicalHostname) { this.useCanonicalHostname = useCanonicalHostname; return this; } public Builder setUseCanonicalHostname(final boolean useCanonicalHostname) { this.useCanonicalHostname = useCanonicalHostname ? Option.ENABLE : Option.DISABLE; return this; } public Builder setRequestDelegCreds(final Option requestDelegCreds) { this.requestDelegCreds = requestDelegCreds; return this; } public KerberosConfig build() { return new KerberosConfig( stripPort, useCanonicalHostname, requestDelegCreds); } } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/NTCredentials.java0100664 0000000 0000000 00000021573 15005672016 025747 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.net.InetAddress; import java.net.UnknownHostException; import java.security.Principal; import java.util.Locale; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; /** * Microsoft Windows specific {@link Credentials} representation that includes * Windows specific attributes such as name of the domain the user belongs to. * * @since 4.0 * * @deprecated Do not use. the NTLM authentication scheme is no longer supported. * Consider using Basic or Bearer authentication with TLS instead. * * @see UsernamePasswordCredentials * @see BearerToken */ @Deprecated @Contract(threading = ThreadingBehavior.IMMUTABLE) public class NTCredentials implements Credentials, Serializable { private static final long serialVersionUID = -7385699315228907265L; /** The user principal */ private final NTUserPrincipal principal; /** Password */ private final char[] password; /** The netbios hostname the authentication request is originating from. */ private final String workstation; /** The netbios domain the authentication request is against */ private final String netbiosDomain; /** * Constructor. * @param userName The user name. This should not include the domain to authenticate with. * For example: "user" is correct whereas "DOMAIN\user" is not. * @param password The password. * @param workstation The workstation the authentication request is originating from. * Essentially, the computer name for this machine. * @param domain The domain to authenticate within. */ public NTCredentials( final String userName, final char[] password, final String workstation, final String domain) { this(password, userName, domain, convertDomain(domain)); } /** * Constructor. * @param userName The user name. This should not include the domain to authenticate with. * For example: "user" is correct whereas "DOMAIN\user" is not. * @param password The password. * @param workstation The netbios workstation name that the authentication request is originating from. * Essentially, the computer name for this machine. * @param domain The domain to authenticate within. * @param netbiosDomain The netbios version of the domain name. */ public NTCredentials( final String userName, final char[] password, final String workstation, final String domain, final String netbiosDomain) { this(password, userName, domain, netbiosDomain); } /** * Constructor to create an instance of NTCredentials. * * @param password The password to use for authentication. Must not be null. * @param userName The user name for authentication. This should not include the domain to authenticate with. * For example: "user" is correct whereas "DOMAIN\user" is not. Must not be null. * @param domain The domain to authenticate within. Can be null. * @param netbiosDomain An alternative representation of the domain name in NetBIOS format. Can be null. * This parameter is provided to accommodate specific scenarios that require the NetBIOS version of the domain name. *

* This constructor creates a new instance of NTCredentials, determining the workstation name at runtime * using the {@link #getWorkstationName()} method. The workstation name will be converted to uppercase * using the {@link Locale#ROOT} locale. */ public NTCredentials( final char[] password, final String userName, final String domain, final String netbiosDomain) { super(); Args.notNull(userName, "User name"); this.principal = new NTUserPrincipal(domain, userName); this.password = password; this.workstation = getWorkstationName().toUpperCase(Locale.ROOT); this.netbiosDomain = netbiosDomain; } @Override public Principal getUserPrincipal() { return this.principal; } public String getUserName() { return this.principal.getUsername(); } @Override public char[] getPassword() { return this.password; } /** * Retrieves the name to authenticate with. * * @return String the domain these credentials are intended to authenticate with. */ public String getDomain() { return this.principal.getDomain(); } /** * Retrieves the netbios domain to authenticate with. * @return String the netbios domain name. */ public String getNetbiosDomain() { return this.netbiosDomain; } /** * Retrieves the netbios workstation name of the computer originating the request. * * @return String the netbios workstation the user is logged into. */ public String getWorkstation() { return this.workstation; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.principal); hash = LangUtils.hashCode(hash, this.workstation); hash = LangUtils.hashCode(hash, this.netbiosDomain); return hash; } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof NTCredentials) { final NTCredentials that = (NTCredentials) o; return Objects.equals(this.principal, that.principal) && Objects.equals(this.workstation, that.workstation) && Objects.equals(this.netbiosDomain, that.netbiosDomain); } return false; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append("[principal: "); buffer.append(this.principal); buffer.append("][workstation: "); buffer.append(this.workstation); buffer.append("][netbiosDomain: "); buffer.append(this.netbiosDomain); buffer.append("]"); return buffer.toString(); } /** Strip dot suffix from a name */ private static String stripDotSuffix(final String value) { if (value == null) { return null; } final int index = value.indexOf('.'); if (index != -1) { return value.substring(0, index); } return value; } /** Convert domain to standard form */ private static String convertDomain(final String domain) { final String returnString = stripDotSuffix(domain); return returnString == null ? returnString : returnString.toUpperCase(Locale.ROOT); } /** * Retrieves the workstation name of the computer originating the request. * This method attempts to get the local host name using the InetAddress class. * If it fails to retrieve the host name due to an UnknownHostException, it returns "localhost" as a fallback. * * @return The unqualified workstation name as a String. */ private static String getWorkstationName() { try { final InetAddress addr = InetAddress.getLocalHost(); final String hostName = addr.getHostName(); // Ensure the hostname is unqualified by removing any domain part return stripDotSuffix(hostName); } catch (final UnknownHostException e) { return "localhost"; } } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthCache.java0100664 0000000 0000000 00000007265 14666635064 025115 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.http.HttpHost; /** * This interface represents an cache of {@link AuthScheme} state information * that can be re-used for preemptive authentication by subsequent requests. * * @since 4.1 */ public interface AuthCache { /** * Stores the authentication state with the given authentication scope in the cache. * * @param host the authentication authority. * @param authScheme the cacheable authentication state. */ void put(HttpHost host, AuthScheme authScheme); /** * Returns the authentication state with the given authentication scope from the cache * if available. * * @param host the authentication authority. * @return the authentication state ir {@code null} if not available in the cache. */ AuthScheme get(HttpHost host); /** * Removes the authentication state with the given authentication scope from the cache * if found. * * @param host the authentication authority. */ void remove(HttpHost host); void clear(); /** * Stores the authentication state with the given authentication scope in the cache. * * @param host the authentication authority. * @param pathPrefix the path prefix (the path component up to the last segment separator). * Can be {@code null}. * @param authScheme the cacheable authentication state. * * @since 5.2 */ default void put(HttpHost host, String pathPrefix, AuthScheme authScheme) { put(host, authScheme); } /** * Returns the authentication state with the given authentication scope from the cache * if available. * @param host the authentication authority. * @param pathPrefix the path prefix (the path component up to the last segment separator). * Can be {@code null}. * @return the authentication state ir {@code null} if not available in the cache. * * @since 5.2 */ default AuthScheme get(HttpHost host, String pathPrefix) { return get(host); } /** * Removes the authentication state with the given authentication scope from the cache * if found. * * @param host the authentication authority. * @param pathPrefix the path prefix (the path component up to the last segment separator). * Can be {@code null}. * * @since 5.2 */ default void remove(HttpHost host, String pathPrefix) { remove(host); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/BearerToken.java0100664 0000000 0000000 00000005101 14666635064 025454 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.security.Principal; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Opaque token {@link Credentials} usually representing a set of claims, often encrypted * or signed. The JWT (JSON Web Token) is among most widely used tokens used at the time * of writing. * * @since 5.3 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class BearerToken implements Credentials, Serializable { private final String token; public BearerToken(final String token) { super(); this.token = Args.notBlank(token, "Token"); } @Override public Principal getUserPrincipal() { return null; } /** * @deprecated Do not use. */ @Deprecated @Override public char[] getPassword() { return null; } public String getToken() { return token; } @Override public int hashCode() { return token.hashCode(); } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof BearerToken) { final BearerToken that = (BearerToken) o; return Objects.equals(this.token, that.token); } return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthenticationException.java0100664 0000000 0000000 00000004432 14666635064 030117 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.http.ProtocolException; /** * Signals a failure in authentication process * * @since 4.0 */ public class AuthenticationException extends ProtocolException { private static final long serialVersionUID = -6794031905674764776L; /** * Creates a new AuthenticationException with a {@code null} detail message. */ public AuthenticationException() { super(); } /** * Creates a new AuthenticationException with the specified message. * * @param message the exception detail message */ public AuthenticationException(final String message) { super(message); } /** * Creates a new AuthenticationException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public AuthenticationException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/AuthStateCacheable.java0100664 0000000 0000000 00000003252 14666635064 026732 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * Indicates that the state of an {@link AuthScheme} can be cached * and re-used for preemptive authentication by subsequent requests. * * @since 5.0 */ @Documented @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface AuthStateCacheable { } httpclient5/src/main/java/org/apache/hc/client5/http/auth/CredentialsProvider.java0100664 0000000 0000000 00000003646 14666635064 027237 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.http.protocol.HttpContext; /** * Provider of authentication credentials. *

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

* * @since 4.0 */ public interface CredentialsProvider { /** * Returns {@link Credentials credentials} for the given authentication scope, * if available. * * @param authScope the {@link AuthScope authentication scope} * @param context the {@link HttpContext http context} * @return the credentials * @since 5.0 */ Credentials getCredentials(AuthScope authScope, HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/auth/StandardAuthScheme.java0100664 0000000 0000000 00000005515 14744133231 026755 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; /** * Authentication schemes by their names supported by the HttpClient. * * @since 4.3 */ public final class StandardAuthScheme { private StandardAuthScheme() { // no instances } /** * Basic authentication scheme (considered inherently insecure without TLS, * but most widely supported). */ public static final String BASIC = "Basic"; /** * Digest authentication scheme. */ public static final String DIGEST = "Digest"; /** * Bearer authentication scheme (should be used with TLS). */ public static final String BEARER = "Bearer"; /** * The NTLM authentication scheme is a proprietary Microsoft Windows * authentication protocol as defined in [MS-NLMP]. * * @deprecated Do not use. the NTLM authentication scheme is no longer supported. * Consider using Basic or Bearer authentication with TLS instead. */ @Deprecated public static final String NTLM = "NTLM"; /** * SPNEGO authentication scheme as defined in RFC 4559 and RFC 4178. * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. */ @Deprecated public static final String SPNEGO = "Negotiate"; /** * Kerberos authentication scheme as defined in RFC 4120. * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. */ @Deprecated public static final String KERBEROS = "Kerberos"; } httpclient5/src/main/java/org/apache/hc/client5/http/auth/NTUserPrincipal.java0100664 0000000 0000000 00000006674 14666635064 026315 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.security.Principal; import java.util.Locale; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; /** * Microsoft Windows specific user principal implementation. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class NTUserPrincipal implements Principal, Serializable { private static final long serialVersionUID = -6870169797924406894L; private final String username; private final String domain; private final String ntname; public NTUserPrincipal( final String domain, final String username) { super(); Args.notNull(username, "User name"); this.username = username; if (domain != null) { this.domain = domain.toUpperCase(Locale.ROOT); } else { this.domain = null; } if (this.domain != null && !this.domain.isEmpty()) { final StringBuilder buffer = new StringBuilder(); buffer.append(this.domain); buffer.append('\\'); buffer.append(this.username); this.ntname = buffer.toString(); } else { this.ntname = this.username; } } @Override public String getName() { return this.ntname; } public String getDomain() { return this.domain; } public String getUsername() { return this.username; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.username); hash = LangUtils.hashCode(hash, this.domain); return hash; } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof NTUserPrincipal) { final NTUserPrincipal that = (NTUserPrincipal) o; return Objects.equals(this.username, that.username) && Objects.equals(this.domain, that.domain); } return false; } @Override public String toString() { return this.ntname; } } httpclient5/src/main/java/org/apache/hc/client5/http/auth/KerberosCredentials.java0100664 0000000 0000000 00000004725 14744133231 027202 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.Serializable; import java.security.Principal; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.ietf.jgss.GSSCredential; /** * Kerberos specific {@link Credentials} representation based on {@link GSSCredential}. * * @since 4.4 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * * @see UsernamePasswordCredentials * @see BearerToken */ @Deprecated @Contract(threading = ThreadingBehavior.IMMUTABLE) public class KerberosCredentials implements Credentials, Serializable { private static final long serialVersionUID = 487421613855550713L; /** GSSCredential */ private final GSSCredential gssCredential; /** * Constructor with GSSCredential argument * * @param gssCredential */ public KerberosCredentials(final GSSCredential gssCredential) { this.gssCredential = gssCredential; } public GSSCredential getGSSCredential() { return gssCredential; } @Override public Principal getUserPrincipal() { return null; } @Override public char[] getPassword() { return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/ClientProtocolException.java0100664 0000000 0000000 00000003442 14666635064 027137 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.io.IOException; /** * Signals an error in the HTTP protocol. * * @since 4.0 */ public class ClientProtocolException extends IOException { private static final long serialVersionUID = -5596590843227115865L; public ClientProtocolException() { super(); } public ClientProtocolException(final String s) { super(s); } public ClientProtocolException(final Throwable cause) { initCause(cause); } public ClientProtocolException(final String message, final Throwable cause) { super(message); initCause(cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/routing/0040775 0000000 0000000 00000000000 15005672016 023126 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/routing/package-info.java0100664 0000000 0000000 00000002370 14666635064 026332 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client connection routing APIs. */ package org.apache.hc.client5.http.routing; httpclient5/src/main/java/org/apache/hc/client5/http/routing/HttpRouteDirector.java0100664 0000000 0000000 00000005215 14666635064 027441 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.routing; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Provides directions on establishing a route. * Implementations of this interface compare a planned route with * a tracked route and indicate the next step required. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface HttpRouteDirector { /** Indicates that the route can not be established at all. */ int UNREACHABLE = -1; /** Indicates that the route is complete. */ int COMPLETE = 0; /** Step: open connection to target. */ int CONNECT_TARGET = 1; /** Step: open connection to proxy. */ int CONNECT_PROXY = 2; /** Step: tunnel through proxy to target. */ int TUNNEL_TARGET = 3; /** Step: tunnel through proxy to other proxy. */ int TUNNEL_PROXY = 4; /** Step: layer protocol (over tunnel). */ int LAYER_PROTOCOL = 5; /** * Provides the next step. * * @param plan the planned route * @param fact the currently established route, or * {@code null} if nothing is established * * @return one of the constants defined in this interface, indicating * either the next step to perform, or success, or failure. * 0 is for success, a negative value for failure. */ int nextStep(RouteInfo plan, RouteInfo fact); } httpclient5/src/main/java/org/apache/hc/client5/http/routing/RoutingSupport.java0100664 0000000 0000000 00000006236 15005672016 027021 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.routing; import java.net.URI; import java.net.URISyntaxException; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.utils.URIUtils; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.net.URIAuthority; public final class RoutingSupport { public static HttpHost determineHost(final HttpRequest request) throws HttpException { if (request == null) { return null; } final URIAuthority authority = request.getAuthority(); if (authority != null) { final String scheme = request.getScheme(); if (scheme == null) { throw new ProtocolException("Protocol scheme is not specified"); } return new HttpHost(scheme, authority); } try { final URI requestURI = request.getUri(); if (requestURI.isAbsolute()) { final HttpHost httpHost = URIUtils.extractHost(requestURI); if (httpHost == null) { throw new ProtocolException("URI does not specify a valid host name: " + requestURI); } return httpHost; } } catch (final URISyntaxException ignore) { } return null; } public static HttpHost normalize(final HttpHost host, final SchemePortResolver schemePortResolver) { if (host == null) { return null; } if (host.getPort() < 0) { final int port = (schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE).resolve(host); if (port > 0) { return new HttpHost(host.getSchemeName(), host.getAddress(), host.getHostName(), port); } } return host; } } httpclient5/src/main/java/org/apache/hc/client5/http/routing/HttpRoutePlanner.java0100664 0000000 0000000 00000006174 14704162040 027250 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.routing; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; /** * Encapsulates logic to compute a {@link HttpRoute} to a target host. * Implementations may for example be based on parameters, or on the * standard Java system properties. *

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

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface HttpRoutePlanner { /** * Determines the route for the given host. * * @param target the target host for the request. * @param context the context to use for the subsequent execution. * Implementations may accept {@code null}. * * @return the route that the request should take * * @throws HttpException in case of a problem */ HttpRoute determineRoute(HttpHost target, HttpContext context) throws HttpException; /** * Determines the route for the given host. * * @param target the target host for the request. * @param request the request message. Can be {@code null} if not given / known. * @param context the context to use for the subsequent execution. * Implementations may accept {@code null}. * * @return the route that the request should take * @throws HttpException in case of a problem. * * @since 5.4 */ default HttpRoute determineRoute(HttpHost target, HttpRequest request, HttpContext context) throws HttpException { return determineRoute(target, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/0040775 0000000 0000000 00000000000 14704162040 023054 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/classic/package-info.java0100664 0000000 0000000 00000002424 14666635064 026264 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * HTTP client APIs based on the classic (blocking) I/O model. */ package org.apache.hc.client5.http.classic; httpclient5/src/main/java/org/apache/hc/client5/http/classic/ExecChain.java0100664 0000000 0000000 00000005375 14704162040 025555 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import java.io.IOException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.util.Args; /** * Represents a single element in the client side classic request execution chain. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface ExecChain { final class Scope { public final String exchangeId; public final HttpRoute route; public final ClassicHttpRequest originalRequest; public final ExecRuntime execRuntime; public final HttpClientContext clientContext; public Scope(final String exchangeId, final HttpRoute route, final ClassicHttpRequest originalRequest, final ExecRuntime execRuntime, final HttpClientContext clientContext) { this.exchangeId = Args.notNull(exchangeId, "Exchange id"); this.route = Args.notNull(route, "Route"); this.originalRequest = Args.notNull(originalRequest, "Original request"); this.execRuntime = Args.notNull(execRuntime, "Exec runtime"); this.clientContext = Args.notNull(clientContext, "HTTP context"); } } ClassicHttpResponse proceed( ClassicHttpRequest request, Scope scope) throws IOException, HttpException; } httpclient5/src/main/java/org/apache/hc/client5/http/classic/HttpClient.java0100664 0000000 0000000 00000033636 14704162040 026005 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import java.io.Closeable; import java.io.IOException; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.protocol.HttpContext; /** * This interface represents only the most basic contract for HTTP request * execution. It imposes no restrictions or particular details on the request * execution process and leaves the specifics of state management, * authentication and redirect handling up to individual implementations. * * @since 4.0 */ public interface HttpClient { /** * Executes HTTP request using the default context. * * @param request the request to execute * * @return the response to the request. This is always a final response, * never an intermediate response with an 1xx status code. * Whether redirects or authentication challenges will be returned * or handled automatically depends on the implementation and * configuration of this client. * @throws IOException in case of a problem or the connection was aborted * * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(ClassicHttpRequest, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(ClassicHttpRequest, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated HttpResponse execute(ClassicHttpRequest request) throws IOException; /** * Executes HTTP request using the given context. * * @param request the request to execute * @param context the context to use for the execution, or * {@code null} to use the default context * * @return the response to the request. This is always a final response, * never an intermediate response with an 1xx status code. * Whether redirects or authentication challenges will be returned * or handled automatically depends on the implementation and * configuration of this client. * @throws IOException in case of a problem or the connection was aborted * * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated HttpResponse execute(ClassicHttpRequest request, HttpContext context) throws IOException; /** * Executes HTTP request using the default context. * * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * * @return the response to the request. This is always a final response, * never an intermediate response with an 1xx status code. * Whether redirects or authentication challenges will be returned * or handled automatically depends on the implementation and * configuration of this client. * @throws IOException in case of a problem or the connection was aborted * * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated ClassicHttpResponse execute(HttpHost target, ClassicHttpRequest request) throws IOException; /** * Executes HTTP request using the given context. * * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * @param context the context to use for the execution, or * {@code null} to use the default context * * @return the response to the request. This is always a final response, * never an intermediate response with an 1xx status code. * Whether redirects or authentication challenges will be returned * or handled automatically depends on the implementation and * configuration of this client. * @throws IOException in case of a problem or the connection was aborted * * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated HttpResponse execute(HttpHost target, ClassicHttpRequest request, HttpContext context) throws IOException; /** * Executes the request and opens the response stream using the given context. * * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * @param context the context to use for the execution, or * {@code null} to use the default context * * @return the response to the request. This is always a final response, * never an intermediate response with an 1xx status code. * Whether redirects or authentication challenges will be returned * or handled automatically depends on the implementation and * configuration of this client. * The response returned by this method must be closed with * {@link Closeable#close()} in order ensure deallocation * of system resources. * @throws IOException in case of a problem or the connection was aborted * * @since 5.2 */ @SuppressWarnings("deprecation") default ClassicHttpResponse executeOpen(HttpHost target, ClassicHttpRequest request, HttpContext context) throws IOException { return (ClassicHttpResponse) execute(target, request, context); } /** * Executes HTTP request using the default context and processes the * response using the given response handler. *

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

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

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

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

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

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

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

* * @param the type of the value determined by the response. * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * @param context the context to use for the execution, or * {@code null} to use the default context * @param responseHandler the response handler * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted */ T execute( HttpHost target, ClassicHttpRequest request, HttpContext context, HttpClientResponseHandler responseHandler) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/classic/ConnectionBackoffStrategy.java0100664 0000000 0000000 00000004672 14666635064 031045 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import org.apache.hc.core5.http.HttpResponse; /** * When managing a dynamic number of connections for a given route, this * strategy assesses whether a given request execution outcome should * result in a backoff signal or not, based on either examining the * {@code Throwable} that resulted or by examining the resulting * response (e.g. for its status code). * * @since 4.2 * */ public interface ConnectionBackoffStrategy { /** * Determines whether seeing the given {@code Throwable} as * a result of request execution should result in a backoff * signal. * @param t the {@code Throwable} that happened * @return {@code true} if a backoff signal should be * given */ boolean shouldBackoff(Throwable t); /** * Determines whether receiving the given {@link HttpResponse} as * a result of request execution should result in a backoff * signal. Implementations MUST restrict themselves to examining * the response header and MUST NOT consume any of the response * body, if any. * @param response the {@code HttpResponse} that was received * @return {@code true} if a backoff signal should be * given */ boolean shouldBackoff(HttpResponse response); } httpclient5/src/main/java/org/apache/hc/client5/http/classic/ExecRuntime.java0100664 0000000 0000000 00000015652 14704162040 026155 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import java.io.IOException; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.io.HttpResponseInformationCallback; import org.apache.hc.core5.util.TimeValue; /** * Execution runtime that provides access to the underlying connection endpoint and helps * manager its life cycle. *

* This interface is considered internal and generally ought not be used or accessed * by custom request exec handlers. * * @since 5.0 */ @Internal public interface ExecRuntime { /** * Determines of the request execution has been aborted. * * @return {@code true} if the request execution has been acquired, * {@code false} otherwise. */ boolean isExecutionAborted(); /** * Determines of a connection endpoint has been acquired. * * @return {@code true} if an endpoint has been acquired, {@code false} otherwise. */ boolean isEndpointAcquired(); /** * Acquires a connection endpoint. Endpoints can leased from a pool * or unconnected new endpoint can be created. * * @param id unique operation ID or {@code null}. * @param route the connection route. * @param state the expected connection state. May be {@code null} if connection * can be state-less or its state is irrelevant. * @param context the execution context. * @throws IOException if an I/O error occurs. */ void acquireEndpoint( String id, HttpRoute route, Object state, HttpClientContext context) throws IOException; /** * Releases the acquired endpoint potentially making it available for re-use. */ void releaseEndpoint(); /** * Shuts down and discards the acquired endpoint. */ void discardEndpoint(); /** * Determines of there the endpoint is connected to the initial hop (connection * target in case of a direct route or to the first proxy hop in case of a route * via a proxy or multiple proxies). * * @return {@code true} if the endpoint is connected, {@code false} otherwise. */ boolean isEndpointConnected(); /** * Disconnects the local endpoint from the initial hop in the connection route. * * @throws IOException if an I/O error occurs. */ void disconnectEndpoint() throws IOException; /** * Connect the local endpoint to the initial hop (connection target in case * of a direct route or to the first proxy hop in case of a route via a proxy * or multiple proxies). * * @param context the execution context. * @throws IOException if an I/O error occurs. */ void connectEndpoint(HttpClientContext context) throws IOException; /** * Upgrades transport security of the active connection by using the TLS security protocol. * * @param context the execution context. * @throws IOException if an I/O error occurs. */ void upgradeTls(HttpClientContext context) throws IOException; /** * Gets information about the underlying endpoint when connected or {@code null} otherwise. * * @return an EndpointInfo, defaults to {@code null}. */ default EndpointInfo getEndpointInfo() { return null; } /** * Executes HTTP request using the given context. * * @param id unique operation ID or {@code null}. * @param request the request message. * @param context the execution context. * @return a ClassicHttpResponse. * @throws IOException if an I/O error occurs. * @throws HttpException if a protocol error occurs. */ ClassicHttpResponse execute( String id, ClassicHttpRequest request, HttpClientContext context) throws IOException, HttpException; /** * Executes HTTP request using the given context. * * @param id unique operation ID or {@code null}. * @param request the request message. * @param informationCallback information (1xx) response handler * @param context the execution context. * @return a ClassicHttpResponse. * @throws IOException if an I/O error occurs. * @throws HttpException if a protocol error occurs. * @since 5.4 */ default ClassicHttpResponse execute( String id, ClassicHttpRequest request, HttpResponseInformationCallback informationCallback, HttpClientContext context) throws IOException, HttpException { return execute(id, request, context); } /** * Determines of the connection is considered re-usable. * * @return {@code true} if the connection is re-usable, {@code false} otherwise. */ boolean isConnectionReusable(); /** * Marks the connection as potentially re-usable for the given period of time * and also marks it as stateful if the state representation is given. * @param state the connection state representation or {@code null} if stateless. * @param validityTime the period of time this connection is valid for. */ void markConnectionReusable(Object state, TimeValue validityTime); /** * Marks the connection as non re-usable. */ void markConnectionNonReusable(); /** * Forks this runtime for parallel execution. * * @return another runtime with the same configuration. */ ExecRuntime fork(CancellableDependency cancellableAware); } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/0040775 0000000 0000000 00000000000 14704162040 024517 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/package-info.java0100664 0000000 0000000 00000002444 14666635064 027731 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Common HTTP methods and message handlers for the classic I/O model. */ package org.apache.hc.client5.http.classic.methods; httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpUriRequest.java0100664 0000000 0000000 00000004023 14666635064 030350 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.core5.http.ClassicHttpRequest; /** * Extended version of the {@link ClassicHttpRequest} interface that provides * convenience methods to access request properties such as request URI * and method type. * * @since 4.0 */ public interface HttpUriRequest extends ClassicHttpRequest, Configurable { /** * Aborts execution of the request. * * @throws UnsupportedOperationException if the abort operation * is not supported / cannot be implemented. */ void abort() throws UnsupportedOperationException; /** * Tests if the request execution has been aborted. * * @return {@code true} if the request execution has been aborted, * {@code false} otherwise. */ boolean isAborted(); } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpDelete.java0100664 0000000 0000000 00000004021 14704162040 027416 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP DELETE method. * * @since 4.0 */ public class HttpDelete extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "DELETE"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the URI is null. */ public HttpDelete(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the URI is invalid. */ public HttpDelete(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpPatch.java0100664 0000000 0000000 00000004014 14704162040 027255 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP PATCH method. * * @since 4.2 */ public class HttpPatch extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "PATCH"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpPatch(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpPatch(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpTrace.java0100664 0000000 0000000 00000004342 14704162040 027260 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; import org.apache.hc.core5.http.HttpEntity; /** * HTTP TRACE method. * * @since 4.0 */ public class HttpTrace extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "TRACE"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpTrace(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpTrace(final String uri) { this(URI.create(uri)); } @Override public void setEntity(final HttpEntity entity) { throw new IllegalStateException(METHOD_NAME + " requests may not include an entity."); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpOptions.java0100664 0000000 0000000 00000005720 14704162040 027656 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; import java.util.HashSet; import java.util.Iterator; import java.util.Set; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.util.Args; /** * HTTP OPTIONS method. * * @since 4.0 */ public class HttpOptions extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "OPTIONS"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpOptions(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpOptions(final String uri) { this(URI.create(uri)); } @Override public String getMethod() { return METHOD_NAME; } /** * Gets the allowed method names defined by {@code "Allow"} headers. * * @param response the response to query. * @return The response to query. */ public Set getAllowedMethods(final HttpResponse response) { Args.notNull(response, "HTTP response"); final Iterator it = MessageSupport.iterate(response, "Allow"); final Set methods = new HashSet<>(); while (it.hasNext()) { final HeaderElement element = it.next(); methods.add(element.getName()); } return methods; } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpPost.java0100664 0000000 0000000 00000004007 14704162040 027145 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP POST method. * * @since 4.0 */ public class HttpPost extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "POST"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpPost(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpPost(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpPut.java0100664 0000000 0000000 00000004002 14704162040 026763 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP PUT method. * * @since 4.0 */ public class HttpPut extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "PUT"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpPut(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpPut(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpUriRequestBase.java0100664 0000000 0000000 00000010450 14704162040 031122 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; import java.util.concurrent.atomic.AtomicMarkableReference; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; /** * Base class for HTTP method subclasses. */ public class HttpUriRequestBase extends BasicClassicHttpRequest implements HttpUriRequest, CancellableDependency { private static final long serialVersionUID = 1L; private final AtomicMarkableReference cancellableRef; private RequestConfig requestConfig; /** * Constructs a new instance with the given method and request URI. * * @param method request method. * @param requestUri request URI. */ public HttpUriRequestBase(final String method, final URI requestUri) { super(method, requestUri); this.cancellableRef = new AtomicMarkableReference<>(null, false); } @Override public boolean cancel() { while (!cancellableRef.isMarked()) { final Cancellable actualCancellable = cancellableRef.getReference(); if (cancellableRef.compareAndSet(actualCancellable, actualCancellable, false, true)) { if (actualCancellable != null) { actualCancellable.cancel(); } return true; } } return false; } @Override public boolean isCancelled() { return cancellableRef.isMarked(); } /** * @since 4.2 */ @Override public void setDependency(final Cancellable cancellable) { final Cancellable actualCancellable = cancellableRef.getReference(); if (!cancellableRef.compareAndSet(actualCancellable, cancellable, false, false)) { cancellable.cancel(); } } /** * Resets internal state of the request making it reusable. * * @since 4.2 */ public void reset() { for (;;) { final boolean marked = cancellableRef.isMarked(); final Cancellable actualCancellable = cancellableRef.getReference(); if (actualCancellable != null) { actualCancellable.cancel(); } if (cancellableRef.compareAndSet(actualCancellable, null, marked, false)) { break; } } } @Override public void abort() throws UnsupportedOperationException { cancel(); } @Override public boolean isAborted() { return isCancelled(); } /** * Sets the request configuration. * * @param requestConfig the request configuration. */ public void setConfig(final RequestConfig requestConfig) { this.requestConfig = requestConfig; } @Override public RequestConfig getConfig() { return requestConfig; } @Override public String toString() { final StringBuilder sb = new StringBuilder(); sb.append(getMethod()).append(" ").append(getRequestUri()); return sb.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpHead.java0100664 0000000 0000000 00000004007 14704162040 027061 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP HEAD method. * * @since 4.0 */ public class HttpHead extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "HEAD"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpHead(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpHead(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/HttpGet.java0100664 0000000 0000000 00000004002 14704162040 026732 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; /** * HTTP GET method. * * @since 4.0 */ public class HttpGet extends HttpUriRequestBase { private static final long serialVersionUID = 1L; /** * The method name {@value}. */ public final static String METHOD_NAME = "GET"; /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is null. */ public HttpGet(final URI uri) { super(METHOD_NAME, uri); } /** * Constructs a new instance initialized with the given URI. * * @param uri a non-null request URI. * @throws IllegalArgumentException if the uri is invalid. */ public HttpGet(final String uri) { this(URI.create(uri)); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/methods/ClassicHttpRequests.java0100664 0000000 0000000 00000022706 14704162040 031343 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.net.URI; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.util.Args; /** * Common HTTP methods using {@link HttpUriRequest} as a HTTP request message representation. *

* Each static method creates a request object of the exact subclass of {@link HttpUriRequest} * with a non-null URI. * * @since 5.0 * * @deprecated Use {@link org.apache.hc.core5.http.io.support.ClassicRequestBuilder} */ @Deprecated public final class ClassicHttpRequests { /** * Creates a new HttpUriRequest for the given {@code Method} and {@code String} URI. * * @param method A method. * @param uri a URI. * @return a new HttpUriRequest. */ public static HttpUriRequest create(final Method method, final String uri) { return create(method, URI.create(uri)); } /** * Creates a new HttpUriRequest for the given {@code Method} and {@code URI}. * * @param method A method. * @param uri a URI. * @return a new HttpUriRequest. */ public static HttpUriRequest create(final Method method, final URI uri) { switch (Args.notNull(method, "method")) { case DELETE: return delete(uri); case GET: return get(uri); case HEAD: return head(uri); case OPTIONS: return options(uri); case PATCH: return patch(uri); case POST: return post(uri); case PUT: return put(uri); case TRACE: return trace(uri); default: throw new IllegalArgumentException(method.toString()); } } /** * Creates a new HttpUriRequest for the given {@code method} and {@code String} URI. * * @param method A method supported by this class. * @param uri a non-null request string URI. * @throws IllegalArgumentException if the method is not supported. * @throws IllegalArgumentException if the string URI is null. * @return A new HttpUriRequest. */ public static HttpUriRequest create(final String method, final String uri) { return create(Method.normalizedValueOf(method), uri); } /** * Creates a new HttpUriRequest for the given {@code method} and {@code URI}. * * @param method A method supported by this class. * @param uri a non-null request URI. * @throws IllegalArgumentException if the method is not supported. * @throws IllegalArgumentException if the URI is null. * @return A new HttpUriRequest. */ public static HttpUriRequest create(final String method, final URI uri) { return create(Method.normalizedValueOf(method), uri); } /** * Constructs a new {@code "DELETE"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "DELETE" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest delete(final String uri) { return delete(URI.create(uri)); } /** * Constructs a new {@code "DELETE"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "DELETE" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest delete(final URI uri) { return new HttpDelete(uri); } /** * Constructs a new {@code "GET"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "GET" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest get(final String uri) { return get(URI.create(uri)); } /** * Constructs a new {@code "GET"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "GET" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest get(final URI uri) { return new HttpGet(uri); } /** * Constructs a new {@code "HEAD"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "HEAD" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest head(final String uri) { return head(URI.create(uri)); } /** * Constructs a new {@code "HEAD"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "HEAD" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest head(final URI uri) { return new HttpHead(uri); } /** * Constructs a new {@code "OPTIONS"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "OPTIONS" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest options(final String uri) { return options(URI.create(uri)); } /** * Constructs a new {@code "OPTIONS"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "OPTIONS" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest options(final URI uri) { return new HttpOptions(uri); } /** * Constructs a new {@code "PATCH"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "PATCH" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest patch(final String uri) { return patch(URI.create(uri)); } /** * Constructs a new {@code "PATCH"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "PATCH" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest patch(final URI uri) { return new HttpPatch(uri); } /** * Constructs a new {@code "POST"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "POST" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest post(final String uri) { return post(URI.create(uri)); } /** * Constructs a new {@code "POST"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "POST" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest post(final URI uri) { return new HttpPost(uri); } /** * Constructs a new {@code "PUT"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "PUT" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest put(final String uri) { return put(URI.create(uri)); } /** * Constructs a new {@code "PUT"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "PUT" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest put(final URI uri) { return new HttpPut(uri); } /** * Constructs a new {@code "TRACE"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "TRACE" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest trace(final String uri) { return trace(URI.create(uri)); } /** * Constructs a new {@code "TRACE"} HttpUriRequest initialized with the given URI. * * @param uri a non-null request URI. * @return a new "TRACE" HttpUriRequest. * @throws IllegalArgumentException if the URI is null. */ public static HttpUriRequest trace(final URI uri) { return new HttpTrace(uri); } } httpclient5/src/main/java/org/apache/hc/client5/http/classic/BackoffManager.java0100664 0000000 0000000 00000003643 14704162040 026550 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import org.apache.hc.client5.http.HttpRoute; /** * Represents a controller that dynamically adjusts the size * of an available connection pool based on feedback from * using the connections. * * @since 4.2 */ public interface BackoffManager { /** * Called when we have decided that the result of * using a connection should be interpreted as a * backoff signal. * * @param route the affected route. */ void backOff(HttpRoute route); /** * Called when we have determined that the result of * using a connection has succeeded and that we may * probe for more connections. * * @param route the affected route. */ void probe(HttpRoute route); } httpclient5/src/main/java/org/apache/hc/client5/http/classic/ExecChainHandler.java0100664 0000000 0000000 00000007074 14666635064 027073 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic; import java.io.IOException; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; import org.apache.hc.client5.http.impl.classic.HttpRequestRetryExec; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; /** * Abstract request execution handler in a classic client side request execution chain. * Handlers can either be a decorator around another element that implements a cross * cutting aspect or a self-contained executor capable of producing a response * for the given request. *

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

*

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

*

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

* * @since 4.3 * @see ChainElement * @see HttpClientBuilder#addExecInterceptorFirst(String, ExecChainHandler) * @see HttpClientBuilder#addExecInterceptorBefore(String, String, ExecChainHandler) * @see HttpClientBuilder#addExecInterceptorAfter(String, String, ExecChainHandler) * @see HttpClientBuilder#addExecInterceptorLast(String, ExecChainHandler) */ @Contract(threading = ThreadingBehavior.STATELESS) public interface ExecChainHandler { /** * Executes the actual HTTP request. The handler can choose to return * a response message or delegate request execution to the next element * in the execution chain. * * @param request the actual request. * @param scope the execution scope . * @param chain the next element in the request execution chain. */ ClassicHttpResponse execute( ClassicHttpRequest request, ExecChain.Scope scope, ExecChain chain) throws IOException, HttpException; } httpclient5/src/main/java/org/apache/hc/client5/http/AuthenticationStrategy.java0100664 0000000 0000000 00000005076 14666635064 027027 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.util.List; import java.util.Map; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * Strategy to select auth schemes in order of preference based on auth challenges * presented by the opposite endpoint (target server or a proxy). *

* Implementations of this interface must be thread-safe. Access to shared data must be * synchronized as methods of this interface may be executed from multiple threads. * * @since 4.2 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface AuthenticationStrategy { /** * Returns an list of {@link AuthScheme}s to handle the given {@link AuthChallenge}s * in their order of preference. * * @param challengeType challenge type. * @param challenges map of challenges keyed by lowercase auth scheme names. * @param context HTTP context. * @return authentication auth schemes that can be used for authentication. Can be empty. * * @since 5.0 */ List select( ChallengeType challengeType, Map challenges, HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/SchemePortResolver.java0100664 0000000 0000000 00000003650 14666635064 026114 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.net.NamedEndpoint; /** * Strategy for default port resolution for protocol schemes. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface SchemePortResolver { /** * Returns the actual port for the host based on the protocol scheme. */ int resolve(HttpHost host); /** * Returns the actual port for the host based on the protocol scheme. * * @since 5.2 */ default int resolve(String scheme, NamedEndpoint endpoint) { return resolve(new HttpHost(scheme, endpoint)); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/0040775 0000000 0000000 00000000000 14704162040 022550 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/package-info.java0100664 0000000 0000000 00000002432 14666635064 025757 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * HTTP client APIs based on the asynchronous, event driven I/O model. */ package org.apache.hc.client5.http.async; httpclient5/src/main/java/org/apache/hc/client5/http/async/HttpAsyncClient.java0100664 0000000 0000000 00000006270 14666635064 026513 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async; import java.util.concurrent.Future; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.protocol.HttpContext; /** * This interface represents only the most basic contract for HTTP request * execution. It imposes no restrictions or particular details on the request * execution process and leaves the specifics of state management, * authentication and redirect handling up to individual implementations. * * @since 4.0 */ public interface HttpAsyncClient { /** * Initiates asynchronous HTTP request execution using the given context. *

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

* Please note it may be unsafe to interact with the context instance * while the request is still being executed. * * @param the result type of request execution. * @param requestProducer request producer callback. * @param responseConsumer response consumer callback. * @param pushHandlerFactory the push handler factory. Optional and may be {@code null}. * @param context HTTP context. Optional and may be {@code null}. * @param callback future callback. Optional and may be {@code null}. * @return future representing pending completion of the operation. */ Future execute( AsyncRequestProducer requestProducer, AsyncResponseConsumer responseConsumer, HandlerFactory pushHandlerFactory, HttpContext context, FutureCallback callback); } httpclient5/src/main/java/org/apache/hc/client5/http/async/AsyncExecChainHandler.java0100664 0000000 0000000 00000007325 14704162040 027542 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async; import java.io.IOException; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.async.AsyncHttpRequestRetryExec; import org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.nio.AsyncEntityProducer; /** * Abstract request execution handler in an asynchronous client side request execution * chain. Handlers can either be a decorator around another element that implements * a cross cutting aspect or a self-contained executor capable of producing a response * for the given request. *

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

*

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

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

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

* * @since 5.0 */ @Internal public interface AsyncExecRuntime { /** * Determines of a connection endpoint has been acquired. * * @return {@code true} if an endpoint has been acquired, {@code false} otherwise. */ boolean isEndpointAcquired(); /** * Initiates operation to acquire a connection endpoint. Endpoints can leased from a pool * or unconnected new endpoint can be created. * * @param id unique operation ID or {@code null}. * @param route the connection route. * @param state the expected connection state. May be {@code null} if connection * can be state-less or its state is irrelevant. * @param context the execution context. * @param callback the result callback. * @return handle that can be used to cancel the operation. */ Cancellable acquireEndpoint( String id, HttpRoute route, Object state, HttpClientContext context, FutureCallback callback); /** * Releases the acquired endpoint potentially making it available for re-use. */ void releaseEndpoint(); /** * Shuts down and discards the acquired endpoint. */ void discardEndpoint(); /** * Determines of there the endpoint is connected to the initial hop (connection target * in case of a direct route or to the first proxy hop in case of a route via a proxy * or multiple proxies). * * @return {@code true} if the endpoint is connected, {@code false} otherwise. */ boolean isEndpointConnected(); /** * Initiates operation to connect the local endpoint to the initial hop (connection * target in case of a direct route or to the first proxy hop in case of a route * via a proxy or multiple proxies). * * @param context the execution context. * @param callback the result callback. * @return handle that can be used to cancel the operation. */ Cancellable connectEndpoint( HttpClientContext context, FutureCallback callback); /** * Disconnects the local endpoint from the initial hop in the connection route. */ void disconnectEndpoint(); /** * Upgrades transport security of the active connection by using the TLS security protocol. * * @param context the execution context. */ void upgradeTls(HttpClientContext context); /** * Upgrades transport security of the active connection by using the TLS security protocol. * * @param context the execution context. * * @since 5.2 */ default void upgradeTls(HttpClientContext context, FutureCallback callback) { upgradeTls(context); if (callback != null) { callback.completed(this); } } /** * Gets information about the underlying endpoint when connected or {@code null} otherwise. * * @return the underlying endpoint or {@code null} */ default EndpointInfo getEndpointInfo() { return null; } /** * Validates the connection making sure it can be used to execute requests. * * @return {@code true} if the connection is valid, {@code false}. */ boolean validateConnection(); /** * Initiates a message exchange using the given handler. * * @param id unique operation ID or {@code null}. * @param exchangeHandler the client message handler. * @param context the execution context. */ Cancellable execute( String id, AsyncClientExchangeHandler exchangeHandler, HttpClientContext context); /** * Marks the connection as potentially re-usable for the given period of time * and also marks it as stateful if the state representation is given. * @param state the connection state representation or {@code null} if stateless. * @param validityTime the period of time this connection is valid for. */ void markConnectionReusable(Object state, TimeValue validityTime); /** * Marks the connection as non re-usable. */ void markConnectionNonReusable(); /** * Forks this runtime for parallel execution. * * @return another runtime with the same configuration. */ AsyncExecRuntime fork(); } httpclient5/src/main/java/org/apache/hc/client5/http/async/AsyncExecChain.java0100664 0000000 0000000 00000015553 14704162040 026246 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async; import java.io.IOException; import java.util.concurrent.atomic.AtomicInteger; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; /** * Represents a single element in the client side asynchronous request execution chain. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface AsyncExecChain { /** * Request execution scope that includes the unique message exchange ID, * the connection route, the original request message, the execution * context and the internal execution runtime. */ final class Scope { public final String exchangeId; public final HttpRoute route; public final HttpRequest originalRequest; public final CancellableDependency cancellableDependency; public final HttpClientContext clientContext; public final AsyncExecRuntime execRuntime; public final Scheduler scheduler; public final AtomicInteger execCount; /** * @since 5.1 */ public Scope( final String exchangeId, final HttpRoute route, final HttpRequest originalRequest, final CancellableDependency cancellableDependency, final HttpClientContext clientContext, final AsyncExecRuntime execRuntime, final Scheduler scheduler, final AtomicInteger execCount) { this.exchangeId = Args.notBlank(exchangeId, "Exchange id"); this.route = Args.notNull(route, "Route"); this.originalRequest = Args.notNull(originalRequest, "Original request"); this.cancellableDependency = Args.notNull(cancellableDependency, "Dependency"); this.clientContext = Args.notNull(clientContext, "HTTP context"); this.execRuntime = Args.notNull(execRuntime, "Exec runtime"); this.scheduler = scheduler; this.execCount = execCount != null ? execCount : new AtomicInteger(1); } /** * @deprecated Use {@link Scope#Scope(String, HttpRoute, HttpRequest, CancellableDependency, HttpClientContext, * AsyncExecRuntime, Scheduler, AtomicInteger)} */ @Deprecated public Scope( final String exchangeId, final HttpRoute route, final HttpRequest originalRequest, final CancellableDependency cancellableDependency, final HttpClientContext clientContext, final AsyncExecRuntime execRuntime) { this(exchangeId, route, originalRequest, cancellableDependency, clientContext, execRuntime, null, new AtomicInteger(1)); } } /** * Request execution scheduler * * @since 5.1 */ interface Scheduler { /** * Schedules request re-execution immediately or after a delay. * @param request the actual request. * @param entityProducer the request entity producer or {@code null} if the request * does not enclose an entity. * @param scope the execution scope. * @param asyncExecCallback the execution callback. * @param delay re-execution delay. Can be {@code null} if the request is to be * re-executed immediately. */ void scheduleExecution( HttpRequest request, AsyncEntityProducer entityProducer, AsyncExecChain.Scope scope, AsyncExecCallback asyncExecCallback, TimeValue delay); /** * Schedules request re-execution of the given execution chain immediately or * after a delay. * @param request the actual request. * @param entityProducer the request entity producer or {@code null} if the request * does not enclose an entity. * @param scope the execution scope. * @param chain the execution chain. * @param asyncExecCallback the execution callback. * @param delay re-execution delay. Can be {@code null} if the request is to be * re-executed immediately. * * @since 5.3 */ @Internal default void scheduleExecution( HttpRequest request, AsyncEntityProducer entityProducer, AsyncExecChain.Scope scope, AsyncExecChain chain, AsyncExecCallback asyncExecCallback, TimeValue delay) { scheduleExecution(request, entityProducer, scope, asyncExecCallback, delay); } } /** * Proceeds to the next element in the request execution chain. * * @param request the actual request. * @param entityProducer the request entity producer or {@code null} if the request * does not enclose an entity. * @param scope the execution scope . * @param asyncExecCallback the execution callback. */ void proceed( HttpRequest request, AsyncEntityProducer entityProducer, Scope scope, AsyncExecCallback asyncExecCallback) throws HttpException, IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/0040775 0000000 0000000 00000000000 15063503632 024220 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/package-info.java0100664 0000000 0000000 00000002447 14666635064 027430 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Common HTTP methods and message handlers for the asynchronous I/O model. */ package org.apache.hc.client5.http.async.methods; httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleResponseBuilder.java0100664 0000000 0000000 00000013071 15005672016 031340 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.util.Arrays; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.support.AbstractResponseBuilder; import org.apache.hc.core5.util.Args; /** * Builds {@link SimpleHttpResponse} instances. * * @since 5.1 */ public class SimpleResponseBuilder extends AbstractResponseBuilder { private SimpleBody body; SimpleResponseBuilder(final int status) { super(status); } /** * Creates a new SimpleResponseBuilder with the given status. * * @param status response status. * @return a new SimpleResponseBuilder. */ public static SimpleResponseBuilder create(final int status) { Args.checkRange(status, 100, 599, "HTTP status code"); return new SimpleResponseBuilder(status); } /** * Copies a source instance into a new one. * * @param response the source instance to copy. * @return a new SimpleResponseBuilder. */ public static SimpleResponseBuilder copy(final SimpleHttpResponse response) { Args.notNull(response, "HTTP response"); final SimpleResponseBuilder builder = new SimpleResponseBuilder(response.getCode()); builder.digest(response); return builder; } protected void digest(final SimpleHttpResponse response) { super.digest(response); setBody(response.getBody()); } @Override public SimpleResponseBuilder setVersion(final ProtocolVersion version) { super.setVersion(version); return this; } @Override public SimpleResponseBuilder setHeaders(final Header... headers) { super.setHeaders(headers); return this; } @Override public SimpleResponseBuilder addHeader(final Header header) { super.addHeader(header); return this; } @Override public SimpleResponseBuilder addHeader(final String name, final String value) { super.addHeader(name, value); return this; } @Override public SimpleResponseBuilder removeHeader(final Header header) { super.removeHeader(header); return this; } @Override public SimpleResponseBuilder removeHeaders(final String name) { super.removeHeaders(name); return this; } @Override public SimpleResponseBuilder setHeader(final Header header) { super.setHeader(header); return this; } @Override public SimpleResponseBuilder setHeader(final String name, final String value) { super.setHeader(name, value); return this; } /** * Gets the body. * * @return the body. */ public SimpleBody getBody() { return body; } /** * Sets the body. * * @param body the body. * @return this instance. */ public SimpleResponseBuilder setBody(final SimpleBody body) { this.body = body; return this; } /** * Sets the body. * * @param content the body content. * @param contentType the body content-type. * @return this instance. */ public SimpleResponseBuilder setBody(final String content, final ContentType contentType) { this.body = SimpleBody.create(content, contentType); return this; } /** * Sets the body. * * @param content the body content. * @param contentType the body content-type. * @return this instance. */ public SimpleResponseBuilder setBody(final byte[] content, final ContentType contentType) { this.body = SimpleBody.create(content, contentType); return this; } @Override public SimpleHttpResponse build() { final SimpleHttpResponse result = new SimpleHttpResponse(getStatus()); result.setVersion(getVersion()); result.setHeaders(getHeaders()); result.setBody(body); return result; } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("SimpleResponseBuilder [status="); builder.append(getStatus()); builder.append(", headerGroup="); builder.append(Arrays.toString(getHeaders())); builder.append(", body="); builder.append(body); builder.append("]"); return builder.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/BasicHttpRequests.java0100664 0000000 0000000 00000023556 14704162040 030503 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.net.URI; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.message.BasicHttpRequest; /** * Common HTTP methods using {@link BasicHttpRequest} as a HTTP request message representation. * * @since 5.0 * * @deprecated Use {@link org.apache.hc.core5.http.support.BasicRequestBuilder}. */ @Deprecated public final class BasicHttpRequests { /** * Creates a new BasicHttpRequest for the given {@code method} and {@code String} URI. * * @param method A method supported by this class. * @param uri a non-null request string URI. * @return A new BasicHttpRequest. */ public static BasicHttpRequest create(final String method, final String uri) { return create(Method.normalizedValueOf(method), uri); } /** * Creates a new BasicHttpRequest for the given {@code method} and {@code URI}. * * @param method A method supported by this class. * @param uri a non-null request URI. * @return A new BasicHttpRequest. */ public static BasicHttpRequest create(final String method, final URI uri) { return create(Method.normalizedValueOf(method), uri); } /** * Creates a new DELETE {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest delete(final String uri) { return delete(URI.create(uri)); } /** * Creates a new DELETE {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest delete(final URI uri) { return create(Method.DELETE, uri); } /** * Creates a new DELETE {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest delete(final HttpHost host, final String path) { return create(Method.DELETE, host, path); } /** * Creates a new GET {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest get(final String uri) { return get(URI.create(uri)); } /** * Creates a new GET {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest get(final URI uri) { return create(Method.GET, uri); } /** * Creates a new HEAD {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest get(final HttpHost host, final String path) { return create(Method.GET, host, path); } /** * Creates a new HEAD {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest head(final String uri) { return head(URI.create(uri)); } /** * Creates a new HEAD {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest head(final URI uri) { return create(Method.HEAD, uri); } /** * Creates a new HEAD {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest head(final HttpHost host, final String path) { return create(Method.HEAD, host, path); } /** * Creates a new OPTIONS {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest options(final String uri) { return options(URI.create(uri)); } /** * Creates a new OPTIONS {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest options(final URI uri) { return create(Method.OPTIONS, uri); } /** * Creates a new OPTIONS {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest options(final HttpHost host, final String path) { return create(Method.OPTIONS, host, path); } /** * Creates a new PATCH {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest patch(final String uri) { return patch(URI.create(uri)); } /** * Creates a new PATCH {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest patch(final URI uri) { return create(Method.PATCH, uri); } /** * Creates a new PATCH {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest patch(final HttpHost host, final String path) { return create(Method.PATCH, host, path); } /** * Creates a new POST {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest post(final String uri) { return post(URI.create(uri)); } /** * Creates a new POST {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest post(final URI uri) { return create(Method.POST, uri); } /** * Creates a new POST {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest post(final HttpHost host, final String path) { return create(Method.POST, host, path); } /** * Creates a new PUT {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest put(final String uri) { return put(URI.create(uri)); } /** * Creates a new PUT {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest put(final URI uri) { return create(Method.PUT, uri); } /** * Creates a new PUT {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest put(final HttpHost host, final String path) { return create(Method.PUT, host, path); } /** * Creates a new TRACE {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest trace(final String uri) { return trace(URI.create(uri)); } /** * Creates a new TRACE {@link BasicHttpRequest}. * * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest trace(final URI uri) { return create(Method.TRACE, uri); } /** * Creates a new TRACE {@link BasicHttpRequest}. * * @param host HTTP host. * @param path request path. * @return a new BasicHttpRequest */ public static BasicHttpRequest trace(final HttpHost host, final String path) { return create(Method.TRACE, host, path); } /** * Creates a new {@link BasicHttpRequest}. * * @param method a non-null HTTP method. * @param uri a non-null URI String. * @return a new BasicHttpRequest */ public static BasicHttpRequest create(final Method method, final String uri) { return create(method, URI.create(uri)); } /** * Creates a new {@link BasicHttpRequest}. * * @param method a non-null HTTP method. * @param uri a non-null URI. * @return a new BasicHttpRequest */ public static BasicHttpRequest create(final Method method, final URI uri) { return new BasicHttpRequest(method, uri); } /** * Creates a new {@link BasicHttpRequest}. * * @param method a non-null HTTP method. * @param host HTTP host. * @param path request path. * @return a new subclass of BasicHttpRequest */ public static BasicHttpRequest create(final Method method, final HttpHost host, final String path) { return new BasicHttpRequest(method, host, path); } } ././@LongLink0100644 0000000 0000000 00000000145 14704162040 011631 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/AbstractCharResponseConsumer.javahttpclient5/src/main/java/org/apache/hc/client5/http/async/methods/AbstractCharResponseConsumer.java0100664 0000000 0000000 00000011477 14704162040 032661 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.nio.charset.UnsupportedCharsetException; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer; import org.apache.hc.core5.http.protocol.HttpContext; /** * Abstract response consumer that processes response body data as a character stream. * * @since 5.0 * * @param response message representation. */ public abstract class AbstractCharResponseConsumer extends AbstractCharDataConsumer implements AsyncResponseConsumer { private volatile FutureCallback resultCallback; private final Charset defaultCharset; public AbstractCharResponseConsumer() { this.defaultCharset = StandardCharsets.UTF_8; } protected AbstractCharResponseConsumer(final int bufSize, final CharCodingConfig charCodingConfig) { super(bufSize, charCodingConfig); this.defaultCharset = charCodingConfig != null && charCodingConfig.getCharset() != null ? charCodingConfig.getCharset() : StandardCharsets.UTF_8; } /** * Triggered to signal the beginning of data processing. * * @param response the response message head * @param contentType the content type of the response body, * or {@code null} if the response does not enclose a response entity. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ protected abstract void start(HttpResponse response, ContentType contentType) throws HttpException, IOException; /** * Triggered to generate object that represents a result of response message processing. * * @return the result of response processing. */ protected abstract T buildResult() throws IOException; @Override public void informationResponse( final HttpResponse response, final HttpContext context) throws HttpException, IOException { } @Override public final void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context, final FutureCallback resultCallback) throws HttpException, IOException { this.resultCallback = resultCallback; if (entityDetails != null) { final ContentType contentType; try { contentType = ContentType.parse(entityDetails.getContentType()); } catch (final UnsupportedCharsetException ex) { throw new UnsupportedEncodingException(ex.getMessage()); } Charset charset = contentType != null ? contentType.getCharset() : null; if (charset == null) { charset = defaultCharset; } setCharset(charset); start(response, contentType != null ? contentType : ContentType.DEFAULT_TEXT); } else { start(response, null); completed(); } } @Override protected final void completed() throws IOException { resultCallback.completed(buildResult()); } @Override public void failed(final Exception cause) { } }httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleRequestProducer.java0100664 0000000 0000000 00000006006 14666635064 031405 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityProducer; import org.apache.hc.core5.http.nio.entity.StringAsyncEntityProducer; import org.apache.hc.core5.http.nio.support.BasicRequestProducer; import org.apache.hc.core5.util.Args; /** * HTTP request producer that generates message data stream events based * on content of a {@link SimpleHttpRequest} instance. *

* IMPORTANT: {@link SimpleHttpRequest}s are intended for simple scenarios where entities inclosed * in requests are known to be small. It is generally recommended to use * {@link org.apache.hc.core5.http.nio.support.AsyncRequestBuilder} and streaming * {@link org.apache.hc.core5.http.nio.AsyncEntityProducer}s. * * @since 5.0 * * @see SimpleBody * @see SimpleHttpRequest * @see org.apache.hc.core5.http.nio.support.AsyncRequestBuilder * @see org.apache.hc.core5.http.nio.AsyncEntityProducer */ public final class SimpleRequestProducer extends BasicRequestProducer { SimpleRequestProducer(final SimpleHttpRequest request, final AsyncEntityProducer entityProducer) { super(request, entityProducer); } public static SimpleRequestProducer create(final SimpleHttpRequest request) { Args.notNull(request, "Request"); final SimpleBody body = request.getBody(); final AsyncEntityProducer entityProducer; if (body != null) { if (body.isText()) { entityProducer = new StringAsyncEntityProducer(body.getBodyText(), body.getContentType()); } else { entityProducer = new BasicAsyncEntityProducer(body.getBodyBytes(), body.getContentType()); } } else { entityProducer = null; } return new SimpleRequestProducer(request, entityProducer); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleHttpRequest.java0100664 0000000 0000000 00000021152 14704162040 030516 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.net.URI; import java.util.Iterator; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; /** * HTTP request that can enclose a body represented as a simple text string or an array of bytes. *

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

it = original.headerIterator(); it.hasNext(); ) { copy.addHeader(it.next()); } copy.setScheme(original.getScheme()); copy.setAuthority(original.getAuthority()); return copy; } /** * Constructs a new request message with the given method and request path. * * @param method request method. * @param path request path. */ public SimpleHttpRequest(final String method, final String path) { super(method, path); } /** * Constructs a new request message with the given method, host, and request path. * * @param method request method. * @param host request host. * @param path request path. */ public SimpleHttpRequest(final String method, final HttpHost host, final String path) { super(method, host, path); } /** * Constructs a new request message with the given method, and request URI. * * @param method request method. * @param requestUri request URI. * @since 5.1 */ public SimpleHttpRequest(final String method, final URI requestUri) { super(method, requestUri); } /** * Constructs a new request message with the given method, and request URI. * * @param method request method. * @param requestUri request URI. * @since 5.1 */ public SimpleHttpRequest(final Method method, final URI requestUri) { this(method.name(), requestUri); } /** * Constructs a new request message with the given method, host, and request path. * * @param method request method. * @param host request host. * @param path request path. * @since 5.1 */ public SimpleHttpRequest(final Method method, final HttpHost host, final String path) { this(method.name(), host, path); } /** * Constructs a new request message with the given method, scheme, authority, and request path. * * @param method request method. * @param scheme request host. * @param authority request URI authority. * @param path request path. * @since 5.1 */ public SimpleHttpRequest(final String method, final String scheme, final URIAuthority authority, final String path) { super(method, scheme, authority, path); } /** * Sets the message body and content type. * * @param body request body. */ public void setBody(final SimpleBody body) { this.body = body; } /** * Sets the message body and content type. * * @param bodyBytes request body. * @param contentType request content type. */ public void setBody(final byte[] bodyBytes, final ContentType contentType) { this.body = SimpleBody.create(bodyBytes, contentType); } /** * Sets the message body and content type. * * @param bodyText request body. * @param contentType request content type. */ public void setBody(final String bodyText, final ContentType contentType) { this.body = SimpleBody.create(bodyText, contentType); } /** * Gets the request body. * * @return the request body. */ public SimpleBody getBody() { return body; } /** * Gets the request content type. * * @return the request content type. */ public ContentType getContentType() { return body != null ? body.getContentType() : null; } /** * Gets the request body as a String. * * @return the request body. */ public String getBodyText() { return body != null ? body.getBodyText() : null; } /** * Gets the request body as a byte array. * * @return the request body. */ public byte[] getBodyBytes() { return body != null ? body.getBodyBytes() : null; } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleBody.java0100664 0000000 0000000 00000010330 14704162040 027117 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * Message body representation as a simple text string or an array of bytes. * * @since 5.0 */ public final class SimpleBody { private final byte[] bodyAsBytes; private final String bodyAsText; private final ContentType contentType; SimpleBody(final byte[] bodyAsBytes, final String bodyAsText, final ContentType contentType) { this.bodyAsBytes = bodyAsBytes; this.bodyAsText = bodyAsText; this.contentType = contentType; } static SimpleBody create(final String body, final ContentType contentType) { Args.notNull(body, "Body"); if (body.length() > 2048) { return new SimpleBody(null, body, contentType); } final Charset charset = (contentType != null ? contentType : ContentType.DEFAULT_TEXT).getCharset(); final byte[] bytes = body.getBytes(charset != null ? charset : StandardCharsets.US_ASCII); return new SimpleBody(bytes, null, contentType); } static SimpleBody create(final byte[] body, final ContentType contentType) { Args.notNull(body, "Body"); return new SimpleBody(body, null, contentType); } /** * Gets the content type. * * @return the content type. */ public ContentType getContentType() { return contentType; } /** * Gets the body as a byte array. * * @return the body as a byte array. */ public byte[] getBodyBytes() { if (bodyAsBytes != null) { return bodyAsBytes; } else if (bodyAsText != null) { final Charset charset = (contentType != null ? contentType : ContentType.DEFAULT_TEXT).getCharset(); return bodyAsText.getBytes(charset != null ? charset : StandardCharsets.US_ASCII); } else { return null; } } /** * Gets the body as a String. * * @return the body as a String. */ public String getBodyText() { if (bodyAsBytes != null) { final Charset charset = (contentType != null ? contentType : ContentType.DEFAULT_TEXT).getCharset(); return new String(bodyAsBytes, charset != null ? charset : StandardCharsets.US_ASCII); } return bodyAsText; } /** * Tests whether the body is currently cached as a String. * * @return whether the body is currently cached as a String. */ public boolean isText() { return bodyAsText != null; } /** * Tests whether the body is currently cached as a byte array. * * @return whether the body is currently cached as a byte array. */ public boolean isBytes() { return bodyAsBytes != null; } @Override public String toString() { return "SimpleBody{content length=" + (bodyAsBytes != null ? bodyAsBytes.length : "chunked") + ", content type=" + contentType + "}"; } } ././@LongLink0100644 0000000 0000000 00000000156 14704162040 011633 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/IgnoreCompleteExceptionFutureCallback.javahttpclient5/src/main/java/org/apache/hc/client5/http/async/methods/IgnoreCompleteExceptionFutureCall0100664 0000000 0000000 00000004472 14704162040 032724 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import org.apache.hc.core5.concurrent.FutureCallback; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * @param the future result type returned by this callback. * @since 5.2 */ public class IgnoreCompleteExceptionFutureCallback implements FutureCallback { private final FutureCallback callback; private static final Logger LOG = LoggerFactory.getLogger(IgnoreCompleteExceptionFutureCallback.class); public IgnoreCompleteExceptionFutureCallback(final FutureCallback callback) { super(); this.callback = callback; } @Override public void completed(final T result) { if (callback != null) { try { callback.completed(result); } catch (final Exception ex) { LOG.error(ex.getMessage(), ex); } } } @Override public void failed(final Exception ex) { if (callback != null) { callback.failed(ex); } } @Override public void cancelled() { if (callback != null) { callback.cancelled(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/AbstractBinResponseConsumer.java0100664 0000000 0000000 00000007656 14704162040 032520 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.nio.charset.UnsupportedCharsetException; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.entity.AbstractBinDataConsumer; import org.apache.hc.core5.http.protocol.HttpContext; /** * Abstract response consumer that processes response body data as an octet stream. * * @since 5.0 * * @param response message representation. */ public abstract class AbstractBinResponseConsumer extends AbstractBinDataConsumer implements AsyncResponseConsumer { private volatile FutureCallback resultCallback; /** * Triggered to signal the beginning of response processing. * * @param response the response message head * @param contentType the content type of the response body, * or {@code null} if the response does not enclose a response entity. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ protected abstract void start(HttpResponse response, ContentType contentType) throws HttpException, IOException; /** * Triggered to generate object that represents a result of response message processing. * * @return the result of response processing. */ protected abstract T buildResult(); @Override public void informationResponse( final HttpResponse response, final HttpContext context) throws HttpException, IOException { } @Override public final void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context, final FutureCallback resultCallback) throws HttpException, IOException { this.resultCallback = resultCallback; if (entityDetails != null) { try { final ContentType contentType = ContentType.parse(entityDetails.getContentType()); start(response, contentType != null ? contentType : ContentType.DEFAULT_BINARY); } catch (final UnsupportedCharsetException ex) { throw new UnsupportedEncodingException(ex.getMessage()); } } else { start(response, null); completed(); } } @Override protected final void completed() { resultCallback.completed(buildResult()); } @Override public void failed(final Exception cause) { } }httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleHttpRequests.java0100664 0000000 0000000 00000014262 14704162040 030705 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.net.URI; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.Method; /** * Common HTTP methods using {@link SimpleHttpRequest} as a HTTP request message representation. * * @since 5.0 * * @deprecated Use {@link SimpleRequestBuilder}. */ @Deprecated public final class SimpleHttpRequests { /** * Creates a new BasicHttpRequest for the given {@code method} and {@code String} URI. * * @param method A method supported by this class. * @param uri a non-null request string URI. * @return A new BasicHttpRequest. */ public static SimpleHttpRequest create(final String method, final String uri) { return create(Method.normalizedValueOf(method), uri); } /** * Creates a new BasicHttpRequest for the given {@code method} and {@code URI}. * * @param method A method supported by this class. * @param uri a non-null request URI. * @return A new BasicHttpRequest. */ public static SimpleHttpRequest create(final String method, final URI uri) { return create(Method.normalizedValueOf(method), uri); } public static SimpleHttpRequest delete(final String uri) { return delete(URI.create(uri)); } public static SimpleHttpRequest delete(final URI uri) { return create(Method.DELETE, uri); } public static SimpleHttpRequest delete(final HttpHost host, final String path) { return create(Method.DELETE, host, path); } public static SimpleHttpRequest get(final String uri) { return get(URI.create(uri)); } public static SimpleHttpRequest get(final URI uri) { return create(Method.GET, uri); } public static SimpleHttpRequest get(final HttpHost host, final String path) { return create(Method.GET, host, path); } public static SimpleHttpRequest head(final String uri) { return head(URI.create(uri)); } public static SimpleHttpRequest head(final URI uri) { return create(Method.HEAD, uri); } public static SimpleHttpRequest head(final HttpHost host, final String path) { return create(Method.HEAD, host, path); } public static SimpleHttpRequest options(final String uri) { return options(URI.create(uri)); } public static SimpleHttpRequest options(final URI uri) { return create(Method.OPTIONS, uri); } public static SimpleHttpRequest options(final HttpHost host, final String path) { return create(Method.OPTIONS, host, path); } public static SimpleHttpRequest patch(final String uri) { return patch(URI.create(uri)); } public static SimpleHttpRequest patch(final URI uri) { return create(Method.PATCH, uri); } public static SimpleHttpRequest patch(final HttpHost host, final String path) { return create(Method.PATCH, host, path); } public static SimpleHttpRequest post(final String uri) { return post(URI.create(uri)); } public static SimpleHttpRequest post(final URI uri) { return create(Method.POST, uri); } public static SimpleHttpRequest post(final HttpHost host, final String path) { return create(Method.POST, host, path); } public static SimpleHttpRequest put(final String uri) { return put(URI.create(uri)); } public static SimpleHttpRequest put(final URI uri) { return create(Method.PUT, uri); } public static SimpleHttpRequest put(final HttpHost host, final String path) { return create(Method.PUT, host, path); } public static SimpleHttpRequest trace(final String uri) { return trace(URI.create(uri)); } public static SimpleHttpRequest trace(final URI uri) { return create(Method.TRACE, uri); } public static SimpleHttpRequest trace(final HttpHost host, final String path) { return create(Method.TRACE, host, path); } /** * Creates a request object of the exact subclass of {@link SimpleHttpRequest}. * * @param uri a non-null URI String. * @return a new SimpleHttpRequest. */ public static SimpleHttpRequest create(final Method method, final String uri) { return create(method, URI.create(uri)); } /** * Creates a request object of the exact subclass of {@link SimpleHttpRequest}. * * @param method a non-null HTTP method. * @param uri a non-null URI. * @return a new SimpleHttpRequest. */ public static SimpleHttpRequest create(final Method method, final URI uri) { return new SimpleHttpRequest(method, uri); } /** * Creates a request object of the exact subclass of {@link SimpleHttpRequest}. * * @param method a non-null HTTP method. * @param host HTTP host. * @param path request path. * @return a new SimpleHttpRequest. */ public static SimpleHttpRequest create(final Method method, final HttpHost host, final String path) { return new SimpleHttpRequest(method, host, path); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleResponseConsumer.java0100664 0000000 0000000 00000006333 14704162040 031544 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncEntityConsumer; import org.apache.hc.core5.http.nio.support.AbstractAsyncResponseConsumer; import org.apache.hc.core5.http.protocol.HttpContext; /** * HTTP response consumer that generates a {@link SimpleHttpResponse} instance based on events * of an incoming data stream. *

* IMPORTANT: {@link SimpleHttpResponse}s are intended for simple scenarios where entities inclosed * in responses are known to be small. It is generally recommended to use streaming * {@link org.apache.hc.core5.http.nio.AsyncResponseConsumer}s, for instance, such as based on * {@link AbstractCharResponseConsumer} or {@link AbstractBinResponseConsumer}. * * @since 5.0 * * @see SimpleBody * @see SimpleHttpResponse * @see AbstractCharResponseConsumer * @see AbstractBinResponseConsumer */ public final class SimpleResponseConsumer extends AbstractAsyncResponseConsumer { SimpleResponseConsumer(final AsyncEntityConsumer entityConsumer) { super(entityConsumer); } /** * Creates a new SimpleResponseConsumer instance initialized with a new {@code SimpleAsyncEntityConsumer}. * * @return a new SimpleResponseConsumer instance. */ public static SimpleResponseConsumer create() { return new SimpleResponseConsumer(new SimpleAsyncEntityConsumer()); } @Override public void informationResponse(final HttpResponse response, final HttpContext context) throws HttpException, IOException { } @Override protected SimpleHttpResponse buildResult(final HttpResponse response, final byte[] entity, final ContentType contentType) { final SimpleHttpResponse simpleResponse = SimpleHttpResponse.copy(response); if (entity != null) { simpleResponse.setBody(entity, contentType); } return simpleResponse; } }httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/AbstractBinPushConsumer.java0100664 0000000 0000000 00000006503 14704162040 031627 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.nio.charset.UnsupportedCharsetException; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.entity.AbstractBinDataConsumer; import org.apache.hc.core5.http.protocol.HttpContext; /** * Abstract push response consumer that processes response body data as an octet stream. * * @since 5.0 */ public abstract class AbstractBinPushConsumer extends AbstractBinDataConsumer implements AsyncPushConsumer { /** * Triggered to signal the beginning of response processing. * * @param response the response message head * @param contentType the content type of the response body, * or {@code null} if the response does not enclose a response entity. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ protected abstract void start(HttpRequest promise, HttpResponse response, ContentType contentType) throws HttpException, IOException; @Override public final void consumePromise( final HttpRequest promise, final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { if (entityDetails != null) { final ContentType contentType; try { contentType = ContentType.parse(entityDetails.getContentType()); } catch (final UnsupportedCharsetException ex) { throw new UnsupportedEncodingException(ex.getMessage()); } start(promise, response, contentType != null ? contentType : ContentType.DEFAULT_BINARY); } else { start(promise, response, null); completed(); } } @Override public void failed(final Exception cause) { } }././@LongLink0100644 0000000 0000000 00000000155 14704162040 011632 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/IgnoreCompleteExceptonFutureCallback.javahttpclient5/src/main/java/org/apache/hc/client5/http/async/methods/IgnoreCompleteExceptonFutureCallb0100664 0000000 0000000 00000003214 14704162040 032706 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import org.apache.hc.core5.concurrent.FutureCallback; /** * @param the future result type returned by this callback. * @deprecated Use {@link IgnoreCompleteExceptionFutureCallback} * @since 5.2 */ @Deprecated public class IgnoreCompleteExceptonFutureCallback extends IgnoreCompleteExceptionFutureCallback { public IgnoreCompleteExceptonFutureCallback(final FutureCallback callback) { super(callback); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleAsyncEntityConsumer.java0100664 0000000 0000000 00000005027 14704162040 032217 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.nio.ByteBuffer; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.nio.entity.AbstractBinAsyncEntityConsumer; import org.apache.hc.core5.util.ByteArrayBuffer; final class SimpleAsyncEntityConsumer extends AbstractBinAsyncEntityConsumer { private final ByteArrayBuffer buffer; SimpleAsyncEntityConsumer() { super(); this.buffer = new ByteArrayBuffer(1024); } @Override protected void streamStart(final ContentType contentType) throws HttpException, IOException { } @Override protected int capacityIncrement() { return Integer.MAX_VALUE; } @Override protected void data(final ByteBuffer src, final boolean endOfStream) throws IOException { if (src == null) { return; } if (src.hasArray()) { buffer.append(src.array(), src.arrayOffset() + src.position(), src.remaining()); } else { while (src.hasRemaining()) { buffer.append(src.get()); } } } @Override protected byte[] generateContent() throws IOException { return buffer.toByteArray(); } @Override public void releaseResources() { buffer.clear(); } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/ConfigurableHttpRequest.java0100664 0000000 0000000 00000006716 14704162040 031676 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.net.URI; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.net.URIAuthority; /** * HTTP request message with a custom configuration. * * @since 5.0 */ public class ConfigurableHttpRequest extends BasicHttpRequest implements Configurable { private static final long serialVersionUID = 1L; private RequestConfig requestConfig; /** * Constructs a new request message with the given method and request path. * * @param method request method. * @param path request path. */ public ConfigurableHttpRequest(final String method, final String path) { super(method, path); } /** * Constructs a new request message with the given method, host, and request path. * * @param method request method. * @param host request host. * @param path request path. */ public ConfigurableHttpRequest(final String method, final HttpHost host, final String path) { super(method, host, path); } /** * Constructs a new request message with the given method, scheme, authority, and request path. * * @param method request method. * @param scheme request host. * @param authority request URI authority. * @param path request path. * @since 5.1 */ public ConfigurableHttpRequest(final String method, final String scheme, final URIAuthority authority, final String path) { super(method, scheme, authority, path); } /** * Constructs a new request message with the given method, and request URI. * * @param method request method. * @param requestUri request URI. * @since 5.1 */ public ConfigurableHttpRequest(final String method, final URI requestUri) { super(method, requestUri); } @Override public RequestConfig getConfig() { return requestConfig; } /** * Sets the request configuration. * * @param requestConfig the request configuration. */ public void setConfig(final RequestConfig requestConfig) { this.requestConfig = requestConfig; } } httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/AbstractCharPushConsumer.java0100664 0000000 0000000 00000010217 14704162040 031771 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.nio.charset.UnsupportedCharsetException; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.entity.AbstractCharDataConsumer; import org.apache.hc.core5.http.protocol.HttpContext; /** * Abstract push response consumer that processes response body data as a character stream. * * @since 5.0 */ public abstract class AbstractCharPushConsumer extends AbstractCharDataConsumer implements AsyncPushConsumer { private final Charset defaultCharset; public AbstractCharPushConsumer() { this.defaultCharset = StandardCharsets.UTF_8; } protected AbstractCharPushConsumer(final int bufSize, final CharCodingConfig charCodingConfig) { super(bufSize, charCodingConfig); this.defaultCharset = charCodingConfig != null && charCodingConfig.getCharset() != null ? charCodingConfig.getCharset() : StandardCharsets.UTF_8; } /** * Triggered to signal the beginning of data processing. * * @param response the response message head * @param contentType the content type of the response body, * or {@code null} if the response does not enclose a response entity. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ protected abstract void start(HttpRequest promise, HttpResponse response, ContentType contentType) throws HttpException, IOException; @Override public final void consumePromise( final HttpRequest promise, final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { if (entityDetails != null) { final ContentType contentType; try { contentType = ContentType.parse(entityDetails.getContentType()); } catch (final UnsupportedCharsetException ex) { throw new UnsupportedEncodingException(ex.getMessage()); } Charset charset = contentType != null ? contentType.getCharset() : null; if (charset == null) { charset = defaultCharset; } setCharset(charset); start(promise, response, contentType != null ? contentType : ContentType.DEFAULT_TEXT); } else { start(promise, response, null); completed(); } } @Override public void failed(final Exception cause) { } }httpclient5/src/main/java/org/apache/hc/client5/http/async/methods/SimpleRequestBuilder.java0100664 0000000 0000000 00000032150 14666635064 031207 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import java.net.URI; import java.net.URISyntaxException; import java.nio.charset.Charset; import java.util.Arrays; import java.util.List; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.support.AbstractRequestBuilder; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.net.WWWFormCodec; import org.apache.hc.core5.util.Args; /** * Builder for {@link SimpleHttpRequest} instances. *

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

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

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

it = original.headerIterator(); it.hasNext(); ) { copy.addHeader(it.next()); } return copy; } public static SimpleHttpResponse create(final int code) { return new SimpleHttpResponse(code); } public static SimpleHttpResponse create(final int code, final String content, final ContentType contentType) { final SimpleHttpResponse response = new SimpleHttpResponse(code); if (content != null) { response.setBody(content, contentType); } return response; } public static SimpleHttpResponse create(final int code, final String content) { return create(code, content, ContentType.TEXT_PLAIN); } public static SimpleHttpResponse create(final int code, final byte[] content, final ContentType contentType) { final SimpleHttpResponse response = new SimpleHttpResponse(code); if (content != null) { response.setBody(content, contentType); } return response; } public static SimpleHttpResponse create(final int code, final byte[] content) { return create(code, content, ContentType.TEXT_PLAIN); } public void setBody(final SimpleBody body) { this.body = body; } public void setBody(final byte[] bodyBytes, final ContentType contentType) { this.body = SimpleBody.create(bodyBytes, contentType); } public void setBody(final String bodyText, final ContentType contentType) { this.body = SimpleBody.create(bodyText, contentType); } public SimpleBody getBody() { return body; } public ContentType getContentType() { return body != null ? body.getContentType() : null; } public String getBodyText() { return body != null ? body.getBodyText() : null; } public byte[] getBodyBytes() { return body != null ? body.getBodyBytes() : null; } } httpclient5/src/main/java/org/apache/hc/client5/http/async/AsyncExecCallback.java0100664 0000000 0000000 00000006337 14704162040 026720 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async; import java.io.IOException; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncDataConsumer; /** * AsyncExecCallback methods represent response processing events * in the client side request execution chain. * * @since 5.0 */ public interface AsyncExecCallback { /** * Triggered to signal receipt of a response message head sent by the server * in response to the request being executed. * * @param response the response message head. * @param entityDetails the response entity details or {@code null} if the response * does not enclose an entity. * @return the data consumer to be used for processing of incoming response message body. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ AsyncDataConsumer handleResponse( HttpResponse response, EntityDetails entityDetails) throws HttpException, IOException; /** * Triggered to signal receipt of an intermediate response message. * * @param response the intermediate response message. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ void handleInformationResponse(HttpResponse response) throws HttpException, IOException; /** * Triggered to signal completion of the message exchange. *

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

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

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

*/ void failed(Exception cause); } httpclient5/src/main/java/org/apache/hc/client5/http/DnsResolver.java0100664 0000000 0000000 00000006030 15005672016 024544 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.UnknownHostException; import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.stream.Collectors; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Users may implement this interface to override the normal DNS lookup offered * by the OS. * * @since 4.2 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface DnsResolver { /** * Returns the IP address for the specified host name, or null if the given * host is not recognized or the associated IP address cannot be used to * build an InetAddress instance. * * @see InetAddress * * @param host * The host name to be resolved by this resolver. * @return The IP address associated to the given host name, or null if the * host name is not known by the implementation class. */ InetAddress[] resolve(String host) throws UnknownHostException; /** * Gets the fully qualified domain name for given host name. * @since 5.0 */ String resolveCanonicalHostname(String host) throws UnknownHostException; /** * Returns a list of {@link InetSocketAddress} for the given host with the given port. * * @see InetSocketAddress * * @since 5.5 */ default List resolve(String host, int port) throws UnknownHostException { final InetAddress[] inetAddresses = resolve(host); if (inetAddresses == null) { return Collections.singletonList(InetSocketAddress.createUnresolved(host, port)); } return Arrays.stream(inetAddresses) .map(e -> new InetSocketAddress(e, port)) .collect(Collectors.toList()); } } httpclient5/src/main/java/org/apache/hc/client5/http/RouteTracker.java0100664 0000000 0000000 00000026647 15063503632 024731 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.InetAddress; import java.util.Objects; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.LangUtils; /** * Helps tracking the steps in establishing a route. * * @since 4.0 */ public final class RouteTracker implements RouteInfo, Cloneable { /** The target host to connect to. */ private final HttpHost targetHost; /** * The local address to connect from. * {@code null} indicates that the default should be used. */ private final InetAddress localAddress; // the attributes above are fixed at construction time // now follow attributes that indicate the established route /** Whether the first hop of the route is established. */ private boolean connected; /** The proxy chain, if any. */ private HttpHost[] proxyChain; /** Whether the the route is tunnelled end-to-end through proxies. */ private TunnelType tunnelled; /** Whether the route is layered over a tunnel. */ private LayerType layered; /** Whether the route is secure. */ private boolean secure; /** * Creates a new route tracker. * The target and origin need to be specified at creation time. * * @param target the host to which to route * @param local the local address to route from, or * {@code null} for the default */ public RouteTracker(final HttpHost target, final InetAddress local) { Args.notNull(target, "Target host"); this.targetHost = target; this.localAddress = local; this.tunnelled = TunnelType.PLAIN; this.layered = LayerType.PLAIN; } /** * @since 4.2 */ public void reset() { this.connected = false; this.proxyChain = null; this.tunnelled = TunnelType.PLAIN; this.layered = LayerType.PLAIN; this.secure = false; } /** * Creates a new tracker for the given route. * Only target and origin are taken from the route, * everything else remains to be tracked. * * @param route the route to track */ public RouteTracker(final HttpRoute route) { this(route.getTargetHost(), route.getLocalAddress()); } /** * Tracks connecting to the target. * * @param secure {@code true} if the route is secure, * {@code false} otherwise */ public void connectTarget(final boolean secure) { Asserts.check(!this.connected, "Already connected"); this.connected = true; this.secure = secure; } /** * Tracks connecting to the first proxy. * * @param proxy the proxy connected to * @param secure {@code true} if the route is secure, * {@code false} otherwise */ public void connectProxy(final HttpHost proxy, final boolean secure) { Args.notNull(proxy, "Proxy host"); Asserts.check(!this.connected, "Already connected"); this.connected = true; this.proxyChain = new HttpHost[]{proxy}; this.secure = secure; } /** * Tracks tunnelling to the target. * * @param secure {@code true} if the route is secure, * {@code false} otherwise */ public void tunnelTarget(final boolean secure) { Asserts.check(this.connected, "No tunnel unless connected"); Asserts.notNull(this.proxyChain, "No tunnel without proxy"); this.tunnelled = TunnelType.TUNNELLED; this.secure = secure; } /** * Tracks tunnelling to a proxy in a proxy chain. * This will extend the tracked proxy chain, but it does not mark * the route as tunnelled. Only end-to-end tunnels are considered there. * * @param proxy the proxy tunnelled to * @param secure {@code true} if the route is secure, * {@code false} otherwise */ public void tunnelProxy(final HttpHost proxy, final boolean secure) { Args.notNull(proxy, "Proxy host"); Asserts.check(this.connected, "No tunnel unless connected"); Asserts.notNull(this.proxyChain, "No tunnel without proxy"); // prepare an extended proxy chain final HttpHost[] proxies = new HttpHost[this.proxyChain.length + 1]; System.arraycopy(this.proxyChain, 0, proxies, 0, this.proxyChain.length); proxies[proxies.length - 1] = proxy; this.proxyChain = proxies; this.secure = secure; } /** * Tracks layering a protocol. * * @param secure {@code true} if the route is secure, * {@code false} otherwise */ public void layerProtocol(final boolean secure) { // it is possible to layer a protocol over a direct connection, // although this case is probably not considered elsewhere Asserts.check(this.connected, "No layered protocol unless connected"); this.layered = LayerType.LAYERED; this.secure = secure; } @Override public HttpHost getTargetHost() { return this.targetHost; } @Override public InetAddress getLocalAddress() { return this.localAddress; } @Override public int getHopCount() { int hops = 0; if (this.connected) { if (proxyChain == null) { hops = 1; } else { hops = proxyChain.length + 1; } } return hops; } @Override public HttpHost getHopTarget(final int hop) { Args.notNegative(hop, "Hop index"); final int hopcount = getHopCount(); Args.check(hop < hopcount, "Hop index exceeds tracked route length"); HttpHost result = null; if (hop < hopcount - 1) { result = this.proxyChain[hop]; } else { result = this.targetHost; } return result; } @Override public HttpHost getProxyHost() { return this.proxyChain == null ? null : this.proxyChain[0]; } public boolean isConnected() { return this.connected; } @Override public TunnelType getTunnelType() { return this.tunnelled; } @Override public boolean isTunnelled() { return this.tunnelled == TunnelType.TUNNELLED; } @Override public LayerType getLayerType() { return this.layered; } @Override public boolean isLayered() { return this.layered == LayerType.LAYERED; } @Override public boolean isSecure() { return this.secure; } /** * Obtains the tracked route. * If a route has been tracked, it is {@link #isConnected connected}. * If not connected, nothing has been tracked so far. * * @return the tracked route, or * {@code null} if nothing has been tracked so far */ public HttpRoute toRoute() { return !this.connected ? null : new HttpRoute(this.targetHost, this.localAddress, this.proxyChain, this.secure, this.tunnelled, this.layered); } /** * Compares this tracked route to another. * * @param o the object to compare with * * @return {@code true} if the argument is the same tracked route, * {@code false} */ @Override public boolean equals(final Object o) { if (o == this) { return true; } if (!(o instanceof RouteTracker)) { return false; } final RouteTracker that = (RouteTracker) o; return // Do the cheapest checks first this.connected == that.connected && this.secure == that.secure && this.tunnelled == that.tunnelled && this.layered == that.layered && Objects.equals(this.targetHost, that.targetHost) && Objects.equals(this.localAddress, that.localAddress) && Objects.equals(this.proxyChain, that.proxyChain); } /** * Generates a hash code for this tracked route. * Route trackers are modifiable and should therefore not be used * as lookup keys. Use {@link #toRoute toRoute} to obtain an * unmodifiable representation of the tracked route. * * @return the hash code */ @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.targetHost); hash = LangUtils.hashCode(hash, this.localAddress); if (this.proxyChain != null) { for (final HttpHost element : this.proxyChain) { hash = LangUtils.hashCode(hash, element); } } hash = LangUtils.hashCode(hash, this.connected); hash = LangUtils.hashCode(hash, this.secure); hash = LangUtils.hashCode(hash, this.tunnelled); hash = LangUtils.hashCode(hash, this.layered); return hash; } /** * Obtains a description of the tracked route. * * @return a human-readable representation of the tracked route */ @Override public String toString() { final StringBuilder cab = new StringBuilder(50 + getHopCount() * 30); cab.append("RouteTracker["); if (this.localAddress != null) { cab.append(this.localAddress); cab.append("->"); } cab.append('{'); if (this.connected) { cab.append('c'); } if (this.tunnelled == TunnelType.TUNNELLED) { cab.append('t'); } if (this.layered == LayerType.LAYERED) { cab.append('l'); } if (this.secure) { cab.append('s'); } cab.append("}->"); if (this.proxyChain != null) { for (final HttpHost element : this.proxyChain) { cab.append(element); cab.append("->"); } } cab.append(this.targetHost); cab.append(']'); return cab.toString(); } // default implementation of clone() is sufficient @Override public Object clone() throws CloneNotSupportedException { return super.clone(); } } httpclient5/src/main/java/org/apache/hc/client5/http/UnsupportedSchemeException.java0100664 0000000 0000000 00000003410 14704162040 027625 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.io.IOException; /** * Signals failure to establish connection using an unknown protocol scheme. * * @since 4.3 */ public class UnsupportedSchemeException extends IOException { private static final long serialVersionUID = 3597127619218687636L; /** * Creates a UnsupportedSchemeException with the specified detail message. * * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method). */ public UnsupportedSchemeException(final String message) { super(message); } } httpclient5/src/main/java/org/apache/hc/client5/http/utils/0040775 0000000 0000000 00000000000 15005672035 022600 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/utils/package-info.java0100664 0000000 0000000 00000002356 14666635064 026007 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client utility classes. */ package org.apache.hc.client5.http.utils; httpclient5/src/main/java/org/apache/hc/client5/http/utils/Base64.java0100664 0000000 0000000 00000012462 14666635064 024506 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.utils; import static java.util.Base64.getEncoder; import static java.util.Base64.getMimeDecoder; import org.apache.hc.core5.annotation.Internal; /** * Provide implementations of the Base64 conversion methods from Commons Codec, delegating to the Java Base64 * implementation. *

* Only the features currently used by HttpClient are implemented here rather than all the features of Commons Codec. *

* Notes: *

    *
  • Commons Codec accepts null inputs, so this is also accepted here. This is not done in the Java 8 implementation
    • *
  • Decoding invalid input returns an empty value. The Java 8 implementation throws an exception, which is caught here
    • *
  • Commons Codec decoders accept both standard and url-safe variants of input. As this is not a requirement for * HttpClient, this is NOT implemented here. *
    • *
* This class is intended as in interim convenience. Any new code should use `java.util.Base64` directly. */ @Internal public class Base64 { private static final Base64 CODEC = new Base64(); private static final byte[] EMPTY_BYTES = new byte[0]; /** * Return an instance of the Base64 codec that use the regular Base64 alphabet * (as opposed to the URL-safe alphabet). Note that unlike the Commons Codec version, * thus class will NOT decode characters from URL-safe alphabet. */ public Base64() { } /** * Creates a Base64 codec used for decoding and encoding in URL-unsafe mode. *

* As HttpClient never uses a non-zero length, this feature is not implemented here. */ public Base64(final int lineLength) { if (lineLength != 0) { throw new UnsupportedOperationException("Line breaks not supported"); } } /** * Decodes Base64 data into octets. *

* Note: this method does NOT accept URL-safe encodings */ public static byte[] decodeBase64(final byte[] base64) { return CODEC.decode(base64); } /** * Decodes a Base64 String into octets. *

* Note: this method does NOT accept URL-safe encodings */ public static byte[] decodeBase64(final String base64) { return CODEC.decode(base64); } /** * Encodes binary data using the base64 algorithm but does not chunk the output. */ public static byte[] encodeBase64(final byte[] base64) { return CODEC.encode(base64); } /** * Encodes binary data using the base64 algorithm but does not chunk the output. */ public static String encodeBase64String(final byte[] bytes) { if (null == bytes) { return null; } return getEncoder().encodeToString(bytes); } /** * Decode Base64-encoded bytes to their original form, using specifications from this codec instance */ public byte[] decode(final byte[] base64) { if (null == base64) { return null; } try { return getMimeDecoder().decode(base64); } catch (final IllegalArgumentException e) { return EMPTY_BYTES; } } /** * Decode a Base64 String to its original form, using specifications from this codec instance */ public byte[] decode(final String base64) { if (null == base64) { return null; } try { // getMimeDecoder is used instead of getDecoder as it better matches the // functionality of the default Commons Codec implementation (primarily more forgiving of strictly // invalid inputs to decode) // Code using java.util.Base64 directly should make a choice based on whether this forgiving nature is // appropriate. return getMimeDecoder().decode(base64); } catch (final IllegalArgumentException e) { return EMPTY_BYTES; } } /** * Encode bytes to their Base64 form, using specifications from this codec instance */ public byte[] encode(final byte[] value) { if (null == value) { return null; } return getEncoder().encode(value); } } httpclient5/src/main/java/org/apache/hc/client5/http/utils/Hex.java0100664 0000000 0000000 00000006335 14666635064 024210 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.utils; import org.apache.hc.core5.annotation.Internal; @Internal public class Hex { private Hex() { } public static String encodeHexString(final byte[] bytes) { final char[] out = new char[bytes.length * 2]; encodeHex(bytes, 0, bytes.length, DIGITS_LOWER, out, 0); return new String(out); } // // The following comes from commons-codec // https://github.com/apache/commons-codec/blob/master/src/main/java/org/apache/commons/codec/binary/Hex.java /** * Used to build output as hex. */ private static final char[] DIGITS_LOWER = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' }; /** * Converts an array of bytes into an array of characters representing the hexadecimal values of each byte in order. * * @param data a byte[] to convert to hex characters * @param dataOffset the position in {@code data} to start encoding from * @param dataLen the number of bytes from {@code dataOffset} to encode * @param toDigits the output alphabet (must contain at least 16 chars) * @param out a char[] which will hold the resultant appropriate characters from the alphabet. * @param outOffset the position within {@code out} at which to start writing the encoded characters. */ private static void encodeHex(final byte[] data, final int dataOffset, final int dataLen, final char[] toDigits, final char[] out, final int outOffset) { // two characters form the hex value. for (int i = dataOffset, j = outOffset; i < dataOffset + dataLen; i++) { out[j++] = toDigits[(0xF0 & data[i]) >>> 4]; out[j++] = toDigits[0x0F & data[i]]; } } /* // Can be replaced in Java 17 with the following: private static final java.util.HexFormat HEX_FORMAT = HexFormat.of(); public static String encodeHex(byte[] bytes) { return HEX_FORMAT.formatHex(bytes); } */ } httpclient5/src/main/java/org/apache/hc/client5/http/utils/DnsUtils.java0100664 0000000 0000000 00000005326 15005672035 025213 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.utils; import java.net.IDN; /** * A collection of utilities relating to Domain Name System. * * @since 4.5 */ public class DnsUtils { private DnsUtils() { } private static boolean isUpper(final char c) { return c >= 'A' && c <= 'Z'; } public static String normalize(final String s) { if (s == null) { return null; } int pos = 0; int remaining = s.length(); while (remaining > 0) { if (isUpper(s.charAt(pos))) { break; } pos++; remaining--; } if (remaining > 0) { final StringBuilder buf = new StringBuilder(s.length()); buf.append(s, 0, pos); while (remaining > 0) { final char c = s.charAt(pos); if (isUpper(c)) { buf.append((char) (c + ('a' - 'A'))); } else { buf.append(c); } pos++; remaining--; } return buf.toString(); } return s; } /** * Decodes to Unicode and normalizes the given DNS name. * @since 5.5 */ public static String normalizeUnicode(final String s) { if (s == null) { return null; } String decoded; try { decoded = IDN.toUnicode(s); } catch (final IllegalArgumentException ignore) { decoded = s; } return normalize(decoded); } } httpclient5/src/main/java/org/apache/hc/client5/http/utils/URIUtils.java0100664 0000000 0000000 00000030022 14666635064 025132 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.utils; import java.net.URI; import java.net.URISyntaxException; import java.util.ArrayList; import java.util.Iterator; import java.util.List; import java.util.Locale; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; /** * A collection of utilities for {@link URI URIs}, to workaround * bugs within the class or for ease-of-use features. * * @since 4.0 */ public class URIUtils { /** * A convenience method for creating a new {@link URI} whose scheme, host * and port are taken from the target host, but whose path, query and * fragment are taken from the existing URI. The fragment is only used if * dropFragment is false. The path is set to "/" if not explicitly specified. * * @param uri * Contains the path, query and fragment to use. * @param target * Contains the scheme, host and port to use. * @param dropFragment * True if the fragment should not be copied. * * @throws URISyntaxException * If the resulting URI is invalid. * * @deprecated Use {@link URIBuilder}. */ @Deprecated public static URI rewriteURI( final URI uri, final HttpHost target, final boolean dropFragment) throws URISyntaxException { Args.notNull(uri, "URI"); if (uri.isOpaque()) { return uri; } final URIBuilder uribuilder = new URIBuilder(uri); if (target != null) { uribuilder.setScheme(target.getSchemeName()); uribuilder.setHost(target.getHostName()); uribuilder.setPort(target.getPort()); } else { uribuilder.setScheme(null); uribuilder.setHost((String) null); uribuilder.setPort(-1); } if (dropFragment) { uribuilder.setFragment(null); } final List originalPathSegments = uribuilder.getPathSegments(); final List pathSegments = new ArrayList<>(originalPathSegments); for (final Iterator it = pathSegments.iterator(); it.hasNext(); ) { final String pathSegment = it.next(); if (pathSegment.isEmpty() && it.hasNext()) { it.remove(); } } if (pathSegments.size() != originalPathSegments.size()) { uribuilder.setPathSegments(pathSegments); } if (pathSegments.isEmpty()) { uribuilder.setPathSegments(""); } return uribuilder.build(); } /** * A convenience method for * {@link URIUtils#rewriteURI(URI, HttpHost, boolean)} that always keeps the * fragment. * * @deprecated Use {@link URIBuilder}. */ @Deprecated public static URI rewriteURI( final URI uri, final HttpHost target) throws URISyntaxException { return rewriteURI(uri, target, false); } /** * A convenience method that creates a new {@link URI} whose scheme, host, port, path, * query are taken from the existing URI, dropping any fragment or user-information. * The path is set to "/" if not explicitly specified. The existing URI is returned * unmodified if it has no fragment or user-information and has a path. * * @param uri * original URI. * @throws URISyntaxException * If the resulting URI is invalid. * * @deprecated Use {@link URIBuilder}. */ @Deprecated public static URI rewriteURI(final URI uri) throws URISyntaxException { Args.notNull(uri, "URI"); if (uri.isOpaque()) { return uri; } final URIBuilder uribuilder = new URIBuilder(uri); if (uribuilder.getUserInfo() != null) { uribuilder.setUserInfo(null); } if (uribuilder.isPathEmpty()) { uribuilder.setPathSegments(""); } if (uribuilder.getHost() != null) { uribuilder.setHost(uribuilder.getHost().toLowerCase(Locale.ROOT)); } uribuilder.setFragment(null); return uribuilder.build(); } /** * Resolves a URI reference against a base URI. Work-around for bug in * java.net.URI (http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4708535) * * @param baseURI the base URI * @param reference the URI reference * @return the resulting URI */ public static URI resolve(final URI baseURI, final String reference) { return resolve(baseURI, URI.create(reference)); } /** * Resolves a URI reference against a base URI. Work-around for bugs in * java.net.URI (e.g. http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4708535) * * @param baseURI the base URI * @param reference the URI reference * @return the resulting URI */ public static URI resolve(final URI baseURI, final URI reference) { Args.notNull(baseURI, "Base URI"); Args.notNull(reference, "Reference URI"); final String s = reference.toASCIIString(); if (s.startsWith("?")) { String baseUri = baseURI.toASCIIString(); final int i = baseUri.indexOf('?'); baseUri = i > -1 ? baseUri.substring(0, i) : baseUri; return URI.create(baseUri + s); } final boolean emptyReference = s.isEmpty(); URI resolved; if (emptyReference) { resolved = baseURI.resolve(URI.create("#")); final String resolvedString = resolved.toASCIIString(); resolved = URI.create(resolvedString.substring(0, resolvedString.indexOf('#'))); } else { resolved = baseURI.resolve(reference); } try { return normalizeSyntax(resolved); } catch (final URISyntaxException ex) { throw new IllegalArgumentException(ex); } } /** * Removes dot segments and performs Syntax-Based Normalization. * * @param uri the original URI * @return the URI without dot segments */ static URI normalizeSyntax(final URI uri) throws URISyntaxException { if (uri.isOpaque() || uri.getAuthority() == null) { // opaque and file: URIs return uri; } final URIBuilder builder = new URIBuilder(uri); final String scheme = builder.getScheme(); if (scheme == null) { builder.setScheme(URIScheme.HTTP.id); } else { builder.setScheme(TextUtils.toLowerCase(scheme)); } final String host = builder.getHost(); if (host != null) { builder.setHost(TextUtils.toLowerCase(host)); } if (builder.isPathEmpty()) { builder.setPathSegments(""); } return builder.build(); } /** * Extracts target host from the given {@link URI}. * * @param uri * @return the target host if the URI is absolute or {@code null} if the URI is * relative or does not contain a valid host name. * * @since 4.1 */ public static HttpHost extractHost(final URI uri) { if (uri == null) { return null; } final URIBuilder uriBuilder = new URIBuilder(uri); final String scheme = uriBuilder.getScheme(); final String host = uriBuilder.getHost(); final int port = uriBuilder.getPort(); if (!TextUtils.isBlank(host)) { try { return new HttpHost(scheme, host, port); } catch (final IllegalArgumentException ignore) { } } return null; } /** * Derives the interpreted (absolute) URI that was used to generate the last * request. This is done by extracting the request-uri and target origin for * the last request and scanning all the redirect locations for the last * fragment identifier, then combining the result into a {@link URI}. * * @param originalURI * original request before any redirects * @param target * if the last URI is relative, it is resolved against this target, * or {@code null} if not available. * @param redirects * collection of redirect locations since the original request * or {@code null} if not available. * @return interpreted (absolute) URI */ public static URI resolve( final URI originalURI, final HttpHost target, final List redirects) throws URISyntaxException { Args.notNull(originalURI, "Request URI"); final URIBuilder uribuilder; if (redirects == null || redirects.isEmpty()) { uribuilder = new URIBuilder(originalURI); } else { uribuilder = new URIBuilder(redirects.get(redirects.size() - 1)); String frag = uribuilder.getFragment(); // read interpreted fragment identifier from redirect locations for (int i = redirects.size() - 1; frag == null && i >= 0; i--) { frag = redirects.get(i).getFragment(); } uribuilder.setFragment(frag); } // read interpreted fragment identifier from original request if (uribuilder.getFragment() == null) { uribuilder.setFragment(originalURI.getFragment()); } // last target origin if (target != null && !uribuilder.isAbsolute()) { uribuilder.setScheme(target.getSchemeName()); uribuilder.setHost(target.getHostName()); uribuilder.setPort(target.getPort()); } return uribuilder.build(); } /** * Convenience factory method for {@link URI} instances. * * @since 5.0 * * @deprecated Use {@link URIBuilder}. */ @Deprecated public static URI create(final HttpHost host, final String path) throws URISyntaxException { final URIBuilder builder = new URIBuilder(path); if (host != null) { builder.setHost(host.getHostName()).setPort(host.getPort()).setScheme(host.getSchemeName()); } return builder.build(); } /** * Convenience factory method for {@link URI} instances. * * @since 5.0 * * @deprecated Use {@link URIBuilder}. */ @Deprecated public static URI create(final String scheme, final URIAuthority host, final String path) throws URISyntaxException { final URIBuilder builder = new URIBuilder(path); if (scheme != null) { builder.setScheme(scheme); } if (host != null) { builder.setHost(host.getHostName()).setPort(host.getPort()); } return builder.build(); } /** * This class should not be instantiated. */ private URIUtils() { } } httpclient5/src/main/java/org/apache/hc/client5/http/utils/DateUtils.java0100664 0000000 0000000 00000035673 14704162040 025347 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.utils; import java.time.DateTimeException; import java.time.Instant; import java.time.LocalDateTime; import java.time.ZoneId; import java.time.ZoneOffset; import java.time.format.DateTimeFormatter; import java.time.format.DateTimeFormatterBuilder; import java.util.Date; import java.util.Locale; import java.util.TimeZone; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.MessageHeaders; import org.apache.hc.core5.util.Args; /** * A utility class for parsing and formatting HTTP dates as used in cookies and * other headers. * * @since 4.3 */ public final class DateUtils { /** * @deprecated use {@link #INTERNET_MESSAGE_FORMAT} */ @Deprecated public static final String PATTERN_RFC1123 = "EEE, dd MMM yyyy HH:mm:ss zzz"; public static final String INTERNET_MESSAGE_FORMAT = "EEE, dd MMM yyyy HH:mm:ss zzz"; /** * Date formatter used to parse HTTP date headers in the Internet Message Format * specified by the HTTP protocol. * * @since 5.2 */ public static final DateTimeFormatter FORMATTER_RFC1123 = new DateTimeFormatterBuilder() .parseLenient() .parseCaseInsensitive() .appendPattern(INTERNET_MESSAGE_FORMAT) .toFormatter(Locale.ENGLISH); /** * Date format pattern used to parse HTTP date headers in RFC 1036 format. */ public static final String PATTERN_RFC1036 = "EEE, dd-MMM-yy HH:mm:ss zzz"; /** * Date formatter used to parse HTTP date headers in RFC 1036 format. * * @since 5.2 */ public static final DateTimeFormatter FORMATTER_RFC1036 = new DateTimeFormatterBuilder() .parseLenient() .parseCaseInsensitive() .appendPattern(PATTERN_RFC1036) .toFormatter(Locale.ENGLISH); /** * Date format pattern used to parse HTTP date headers in ANSI C * {@code asctime()} format. */ public static final String PATTERN_ASCTIME = "EEE MMM d HH:mm:ss yyyy"; /** * Date formatter used to parse HTTP date headers in in ANSI C {@code asctime()} format. * * @since 5.2 */ public static final DateTimeFormatter FORMATTER_ASCTIME = new DateTimeFormatterBuilder() .parseLenient() .parseCaseInsensitive() .appendPattern(PATTERN_ASCTIME) .toFormatter(Locale.ENGLISH); /** * Standard date formatters: {@link #FORMATTER_RFC1123}, {@link #FORMATTER_RFC1036}, {@link #FORMATTER_ASCTIME}. * * @since 5.2 */ public static final DateTimeFormatter[] STANDARD_PATTERNS = new DateTimeFormatter[] { FORMATTER_RFC1123, FORMATTER_RFC1036, FORMATTER_ASCTIME }; static final ZoneId GMT_ID = ZoneId.of("GMT"); /** * @since 5.2 */ public static Date toDate(final Instant instant) { return instant != null ? new Date(instant.toEpochMilli()) : null; } /** * @since 5.2 */ public static Instant toInstant(final Date date) { return date != null ? Instant.ofEpochMilli(date.getTime()) : null; } /** * @since 5.2 */ public static LocalDateTime toUTC(final Instant instant) { return instant != null ? instant.atZone(ZoneOffset.UTC).toLocalDateTime() : null; } /** * @since 5.2 */ public static LocalDateTime toUTC(final Date date) { return toUTC(toInstant(date)); } /** * Parses the date value using the given date/time formats. *

This method can handle strings without time-zone information by failing gracefully, in which case * it returns {@code null}.

* * @param dateValue the instant value to parse * @param dateFormatters the date/time formats to use * * @return the parsed instant or null if input could not be parsed * * @since 5.2 */ public static Instant parseDate(final String dateValue, final DateTimeFormatter... dateFormatters) { Args.notNull(dateValue, "Date value"); String v = dateValue; // trim single quotes around date if present // see issue #5279 if (v.length() > 1 && v.startsWith("'") && v.endsWith("'")) { v = v.substring (1, v.length() - 1); } for (final DateTimeFormatter dateFormatter : dateFormatters) { try { return Instant.from(dateFormatter.parse(v)); } catch (final DateTimeException ignore) { } } return null; } /** * Parses the instant value using the standard date/time formats ({@link #PATTERN_RFC1123}, * {@link #PATTERN_RFC1036}, {@link #PATTERN_ASCTIME}). * * @param dateValue the instant value to parse * * @return the parsed instant or null if input could not be parsed * * @since 5.2 */ public static Instant parseStandardDate(final String dateValue) { return parseDate(dateValue, STANDARD_PATTERNS); } /** * Parses an instant value from a header with the given name. * * @param headers message headers * @param headerName header name * * @return the parsed instant or null if input could not be parsed * * @since 5.2 */ public static Instant parseStandardDate(final MessageHeaders headers, final String headerName) { if (headers == null) { return null; } final Header header = headers.getFirstHeader(headerName); if (header == null) { return null; } return parseStandardDate(header.getValue()); } /** * Formats the given instant according to the RFC 1123 pattern. * * @param instant Instant to format. * @return An RFC 1123 formatted instant string. * * @see #PATTERN_RFC1123 * * @since 5.2 */ public static String formatStandardDate(final Instant instant) { return formatDate(instant, FORMATTER_RFC1123); } /** * Formats the given date according to the specified pattern. * * @param instant Instant to format. * @param dateTimeFormatter The pattern to use for formatting the instant. * @return A formatted instant string. * * @throws IllegalArgumentException If the given date pattern is invalid. * * @since 5.2 */ public static String formatDate(final Instant instant, final DateTimeFormatter dateTimeFormatter) { Args.notNull(instant, "Instant"); Args.notNull(dateTimeFormatter, "DateTimeFormatter"); return dateTimeFormatter.format(instant.atZone(GMT_ID)); } /** * @deprecated This attribute is no longer supported as a part of the public API. */ @Deprecated public 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 or null if input could not be parsed * * @deprecated Use {@link #parseStandardDate(String)} */ @Deprecated public static Date parseDate(final String dateValue) { return parseDate(dateValue, null, null); } /** * Parses a date value from a header with the given name. * * @param headers message headers * @param headerName header name * * @return the parsed date or null if input could not be parsed * * @since 5.0 * * @deprecated Use {@link #parseStandardDate(MessageHeaders, String)} */ @Deprecated public static Date parseDate(final MessageHeaders headers, final String headerName) { return toDate(parseStandardDate(headers, headerName)); } /** * Tests if the first message is after (newer) than second one * using the given message header for comparison. * * @param message1 the first message * @param message2 the second message * @param headerName header name * * @return {@code true} if both messages contain a header with the given name * and the value of the header from the first message is newer that of * the second message. * * @since 5.0 * * @deprecated This method is no longer supported as a part of the public API. */ @Deprecated public static boolean isAfter( final MessageHeaders message1, final MessageHeaders message2, final String headerName) { if (message1 != null && message2 != null) { final Header dateHeader1 = message1.getFirstHeader(headerName); if (dateHeader1 != null) { final Header dateHeader2 = message2.getFirstHeader(headerName); if (dateHeader2 != null) { final Date date1 = parseDate(dateHeader1.getValue()); if (date1 != null) { final Date date2 = parseDate(dateHeader2.getValue()); if (date2 != null) { return date1.after(date2); } } } } } return false; } /** * Tests if the first message is before (older) than the second one * using the given message header for comparison. * * @param message1 the first message * @param message2 the second message * @param headerName header name * * @return {@code true} if both messages contain a header with the given name * and the value of the header from the first message is older that of * the second message. * * @since 5.0 * * @deprecated This method is no longer supported as a part of the public API. */ @Deprecated public static boolean isBefore( final MessageHeaders message1, final MessageHeaders message2, final String headerName) { if (message1 != null && message2 != null) { final Header dateHeader1 = message1.getFirstHeader(headerName); if (dateHeader1 != null) { final Header dateHeader2 = message2.getFirstHeader(headerName); if (dateHeader2 != null) { final Date date1 = parseDate(dateHeader1.getValue()); if (date1 != null) { final Date date2 = parseDate(dateHeader2.getValue()); if (date2 != null) { return date1.before(date2); } } } } } return false; } /** * Parses the date value using the given date/time formats. * * @param dateValue the date value to parse * @param dateFormats the date/time formats to use * * @return the parsed date or null if input could not be parsed * * @deprecated Use {@link #parseDate(String, DateTimeFormatter...)} */ @Deprecated public static Date parseDate(final String dateValue, final String[] dateFormats) { return parseDate(dateValue, dateFormats, null); } /** * Parses the date value using the given date/time formats. * * @param dateValue the date value to parse * @param dateFormats the date/time formats to use * @param startDate During parsing, two digit years will be placed in the range * {@code startDate} to {@code startDate + 100 years}. This value may * be {@code null}. When {@code null} is given as a parameter, year * {@code 2000} will be used. * * @return the parsed date or null if input could not be parsed * * @deprecated Use {@link #parseDate(String, DateTimeFormatter...)} */ @Deprecated public static Date parseDate( final String dateValue, final String[] dateFormats, final Date startDate) { final DateTimeFormatter[] dateTimeFormatters; if (dateFormats != null) { dateTimeFormatters = new DateTimeFormatter[dateFormats.length]; for (int i = 0; i < dateFormats.length; i++) { dateTimeFormatters[i] = new DateTimeFormatterBuilder() .parseLenient() .parseCaseInsensitive() .appendPattern(dateFormats[i]) .toFormatter(); } } else { dateTimeFormatters = STANDARD_PATTERNS; } return toDate(parseDate(dateValue, dateTimeFormatters)); } /** * 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 * * @deprecated Use {@link #formatStandardDate(Instant)} */ @Deprecated public static String formatDate(final Date date) { return formatStandardDate(toInstant(date)); } /** * Formats the given date according to the specified pattern. * * @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. * * @deprecated Use {@link #formatDate(Instant, DateTimeFormatter)} */ @Deprecated public static String formatDate(final Date date, final String pattern) { Args.notNull(date, "Date"); Args.notNull(pattern, "Pattern"); return DateTimeFormatter.ofPattern(pattern).format(toInstant(date).atZone(GMT_ID)); } /** * Clears thread-local variable containing {@link java.text.DateFormat} cache. * * @since 4.3 * * @deprecated Noop method. Do not use. */ @Deprecated public static void clearThreadLocal() { } /** This class should not be instantiated. */ private DateUtils() { } } httpclient5/src/main/java/org/apache/hc/client5/http/utils/ByteArrayBuilder.java0100664 0000000 0000000 00000015031 15005672016 026650 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.utils; import java.nio.ByteBuffer; import java.nio.CharBuffer; import java.nio.charset.CharacterCodingException; import java.nio.charset.Charset; import java.nio.charset.CharsetEncoder; import java.nio.charset.CoderResult; import java.nio.charset.CodingErrorAction; import java.nio.charset.StandardCharsets; /** * Builder class for sequences of bytes. * * @since 5.0 */ public final class ByteArrayBuilder { private CharsetEncoder charsetEncoder; private ByteBuffer buffer; public ByteArrayBuilder() { } public ByteArrayBuilder(final int initialCapacity) { this.buffer = ByteBuffer.allocate(initialCapacity); } public int capacity() { return this.buffer != null ? this.buffer.capacity() : 0; } static ByteBuffer ensureFreeCapacity(final ByteBuffer buffer, final int capacity) { if (buffer == null) { return ByteBuffer.allocate(capacity); } if (buffer.remaining() < capacity) { final ByteBuffer newBuffer = ByteBuffer.allocate(buffer.position() + capacity); buffer.flip(); newBuffer.put(buffer); return newBuffer; } return buffer; } static ByteBuffer encode( final ByteBuffer buffer, final CharBuffer in, final CharsetEncoder encoder) throws CharacterCodingException { final int capacity = (int) (in.remaining() * encoder.averageBytesPerChar()); ByteBuffer out = ensureFreeCapacity(buffer, capacity); while (in.hasRemaining()) { CoderResult result = encoder.encode(in, out, true); if (result.isError()) { result.throwException(); } if (result.isUnderflow()) { result = encoder.flush(out); } if (result.isUnderflow()) { break; } if (result.isOverflow()) { out = ensureFreeCapacity(out, capacity); } } return out; } public void ensureFreeCapacity(final int freeCapacity) { this.buffer = ensureFreeCapacity(this.buffer, freeCapacity); } private void doAppend(final CharBuffer charBuffer) { if (this.charsetEncoder == null) { this.charsetEncoder = StandardCharsets.US_ASCII.newEncoder() .onMalformedInput(CodingErrorAction.IGNORE) .onUnmappableCharacter(CodingErrorAction.REPLACE); } this.charsetEncoder.reset(); try { this.buffer = encode(this.buffer, charBuffer, this.charsetEncoder); } catch (final CharacterCodingException ex) { // Should never happen throw new IllegalStateException("Unexpected character coding error", ex); } } public ByteArrayBuilder charset(final Charset charset) { if (charset == null) { this.charsetEncoder = null; } else { this.charsetEncoder = charset.newEncoder() .onMalformedInput(CodingErrorAction.IGNORE) .onUnmappableCharacter(CodingErrorAction.REPLACE); } return this; } public ByteArrayBuilder append(final byte[] b, final int off, final int len) { if (b == null) { return this; } if (off < 0 || off > b.length || len < 0 || off + len < 0 || off + len > b.length) { throw new IndexOutOfBoundsException("off: " + off + " len: " + len + " b.length: " + b.length); } ensureFreeCapacity(len); this.buffer.put(b, off, len); return this; } public ByteArrayBuilder append(final byte[] b) { if (b == null) { return this; } return append(b, 0, b.length); } public ByteArrayBuilder append(final CharBuffer charBuffer) { if (charBuffer == null) { return this; } doAppend(charBuffer); return this; } public ByteArrayBuilder append(final char[] b, final int off, final int len) { if (b == null) { return this; } if (off < 0 || off > b.length || len < 0 || off + len < 0 || off + len > b.length) { throw new IndexOutOfBoundsException("off: " + off + " len: " + len + " b.length: " + b.length); } return append(CharBuffer.wrap(b, off, len)); } public ByteArrayBuilder append(final char[] b) { if (b == null) { return this; } return append(b, 0, b.length); } public ByteArrayBuilder append(final String s) { if (s == null) { return this; } return append(CharBuffer.wrap(s)); } public ByteBuffer toByteBuffer() { return this.buffer != null ? this.buffer.duplicate() : ByteBuffer.allocate(0); } public byte[] toByteArray() { if (this.buffer == null) { return new byte[] {}; } this.buffer.flip(); final byte[] b = new byte[this.buffer.remaining()]; this.buffer.get(b); this.buffer.clear(); return b; } public void reset() { if (this.charsetEncoder != null) { this.charsetEncoder.reset(); } if (this.buffer != null) { this.buffer.clear(); } } @Override public String toString() { return String.valueOf(this.buffer); } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/0040775 0000000 0000000 00000000000 15063503632 023301 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/protocol/package-info.java0100664 0000000 0000000 00000002532 14666635064 026504 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * HTTP protocol interceptors that enable advanced functionality * such as HTTP state management and authentication state caching. */ package org.apache.hc.client5.http.protocol; httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestClientConnControl.java0100664 0000000 0000000 00000006564 14704162040 031115 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * This protocol interceptor is responsible for adding the {@code Connection} * header to the outgoing requests, which is essential for managing persistence * of {@code HTTP/1.0} connections. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class RequestClientConnControl implements HttpRequestInterceptor { private static final Logger LOG = LoggerFactory.getLogger(RequestClientConnControl.class); public RequestClientConnControl() { super(); } @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); final String method = request.getMethod(); if (Method.CONNECT.isSame(method)) { return; } final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); // Obtain the client connection (required) final RouteInfo route = clientContext.getHttpRoute(); if (route == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Connection route not set in the context", exchangeId); } return; } if (route.getHopCount() == 1 || route.isTunnelled()) { if (!request.containsHeader(HttpHeaders.CONNECTION)) { request.addHeader(HttpHeaders.CONNECTION, HeaderElements.KEEP_ALIVE); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/ResponseProcessCookies.java0100664 0000000 0000000 00000014335 14704162040 030614 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import java.util.Iterator; import java.util.List; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Response interceptor that populates the current {@link CookieStore} with data * contained in response cookies received in the given the HTTP response. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class ResponseProcessCookies implements HttpResponseInterceptor { /** * Default instance of {@link ResponseProcessCookies}. * * @since 5.2 */ public static final ResponseProcessCookies INSTANCE = new ResponseProcessCookies(); private static final Logger LOG = LoggerFactory.getLogger(ResponseProcessCookies.class); public ResponseProcessCookies() { super(); } @Override public void process(final HttpResponse response, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(response, "HTTP request"); Args.notNull(context, "HTTP context"); final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); // Obtain actual CookieSpec instance final CookieSpec cookieSpec = clientContext.getCookieSpec(); if (cookieSpec == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie spec not specified in HTTP context", exchangeId); } return; } // Obtain cookie store final CookieStore cookieStore = clientContext.getCookieStore(); if (cookieStore == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie store not specified in HTTP context", exchangeId); } return; } // Obtain actual CookieOrigin instance final CookieOrigin cookieOrigin = clientContext.getCookieOrigin(); if (cookieOrigin == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie origin not specified in HTTP context", exchangeId); } return; } final Iterator
it = response.headerIterator(HttpHeaders.SET_COOKIE); processCookies(exchangeId, it, cookieSpec, cookieOrigin, cookieStore); } private void processCookies( final String exchangeId, final Iterator
iterator, final CookieSpec cookieSpec, final CookieOrigin cookieOrigin, final CookieStore cookieStore) { while (iterator.hasNext()) { final Header header = iterator.next(); try { final List cookies = cookieSpec.parse(header, cookieOrigin); for (final Cookie cookie : cookies) { try { cookieSpec.validate(cookie, cookieOrigin); cookieStore.addCookie(cookie); if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie accepted [{}]", exchangeId, formatCookie(cookie)); } } catch (final MalformedCookieException ex) { if (LOG.isWarnEnabled()) { LOG.warn("{} Cookie rejected [{}] {}", exchangeId, formatCookie(cookie), ex.getMessage()); } } } } catch (final MalformedCookieException ex) { if (LOG.isWarnEnabled()) { LOG.warn("{} Invalid cookie header: \"{}\". {}", exchangeId, header, ex.getMessage()); } } } } private static String formatCookie(final Cookie cookie) { final StringBuilder buf = new StringBuilder(); buf.append(cookie.getName()); buf.append("=\""); String v = cookie.getValue(); if (v != null) { if (v.length() > 100) { v = v.substring(0, 100) + "..."; } buf.append(v); } buf.append("\""); buf.append(", domain:"); buf.append(cookie.getDomain()); buf.append(", path:"); buf.append(cookie.getPath()); buf.append(", expiry:"); buf.append(cookie.getExpiryInstant()); return buf.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RedirectLocations.java0100664 0000000 0000000 00000006201 14704162040 027550 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.net.URI; import java.util.ArrayList; import java.util.HashSet; import java.util.List; import java.util.Set; /** * This class represents a collection of {@link URI}s used * as redirect locations. * * @since 4.0 */ public final class RedirectLocations { private final Set unique; private final List all; /** * Constructs a new instance. */ public RedirectLocations() { super(); this.unique = new HashSet<>(); this.all = new ArrayList<>(); } /** * Test if the URI is present in the collection. */ public boolean contains(final URI uri) { return this.unique.contains(uri); } /** * Adds a new URI to the collection. */ public void add(final URI uri) { this.unique.add(uri); this.all.add(uri); } /** * Returns all redirect {@link URI}s in the order they were added to the collection. * * @return list of all URIs * * @since 4.1 */ public List getAll() { return new ArrayList<>(this.all); } /** * Returns the URI at the specified position in this list. * * @param index * index of the location to return * @return the URI at the specified position in this list * @throws IndexOutOfBoundsException * if the index is out of range ( * {@code index < 0 || index >= size()}) * @since 4.3 */ public URI get(final int index) { return this.all.get(index); } /** * Returns the number of elements in this list. If this list contains more * than {@code Integer.MAX_VALUE} elements, returns * {@code Integer.MAX_VALUE}. * * @return the number of elements in this list * @since 4.3 */ public int size() { return this.all.size(); } public void clear() { unique.clear(); all.clear(); } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestUpgrade.java0100664 0000000 0000000 00000007172 14740035240 027104 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * @since 5.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public final class RequestUpgrade implements HttpRequestInterceptor { private static final Logger LOG = LoggerFactory.getLogger(RequestUpgrade.class); public RequestUpgrade() { } @Override public void process( final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(context, "HTTP context"); final HttpClientContext clientContext = HttpClientContext.cast(context); final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault(); if (requestConfig.isProtocolUpgradeEnabled()) { final ProtocolVersion version = request.getVersion() != null ? request.getVersion() : clientContext.getProtocolVersion(); if (!request.containsHeader(HttpHeaders.UPGRADE) && !request.containsHeader(HttpHeaders.CONNECTION) && version.getMajor() == 1 && version.getMinor() >= 1) { if (LOG.isDebugEnabled()) { LOG.debug("Connection is upgradable: protocol version = {}", version); } final String method = request.getMethod(); if ((Method.OPTIONS.isSame(method) || Method.HEAD.isSame(method) || Method.GET.isSame(method)) && clientContext.getSSLSession() == null) { LOG.debug("Connection is upgradable to TLS: method = {}", method); request.addHeader(HttpHeaders.UPGRADE, "TLS/1.2"); request.addHeader(HttpHeaders.CONNECTION, HttpHeaders.UPGRADE); } } } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestAddCookies.java0100664 0000000 0000000 00000017633 14751065436 027541 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import java.time.Instant; import java.util.ArrayList; import java.util.List; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.cookie.StandardCookieSpec; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request interceptor that matches cookies available in the current * {@link CookieStore} to the request being executed and generates * corresponding {@code Cookie} request headers. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class RequestAddCookies implements HttpRequestInterceptor { /** * Default instance of {@link RequestAddCookies}. * * @since 5.2 */ public static final RequestAddCookies INSTANCE = new RequestAddCookies(); private static final Logger LOG = LoggerFactory.getLogger(RequestAddCookies.class); public RequestAddCookies() { super(); } @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(context, "HTTP context"); final String method = request.getMethod(); if (Method.CONNECT.isSame(method) || Method.TRACE.isSame(method)) { return; } // Check if a Cookie header is already present if (request.containsHeader(HttpHeaders.COOKIE)) { if (LOG.isDebugEnabled()) { LOG.debug("Skipping cookie addition, Cookie header already present in the request"); } // Skip adding cookies if the Cookie header is already present return; } final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); // Obtain cookie store final CookieStore cookieStore = clientContext.getCookieStore(); if (cookieStore == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie store not specified in HTTP context", exchangeId); } return; } // Obtain the registry of cookie specs final Lookup registry = clientContext.getCookieSpecRegistry(); if (registry == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} CookieSpec registry not specified in HTTP context", exchangeId); } return; } // Obtain the route (required) final RouteInfo route = clientContext.getHttpRoute(); if (route == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Connection route not set in the context", exchangeId); } return; } final RequestConfig config = clientContext.getRequestConfigOrDefault(); String cookieSpecName = config.getCookieSpec(); if (cookieSpecName == null) { cookieSpecName = StandardCookieSpec.STRICT; } if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie spec selected: {}", exchangeId, cookieSpecName); } final URIAuthority authority = request.getAuthority(); String path = request.getPath(); if (TextUtils.isEmpty(path)) { path = "/"; } String hostName = authority != null ? authority.getHostName() : null; if (hostName == null) { hostName = route.getTargetHost().getHostName(); } int port = authority != null ? authority.getPort() : -1; if (port < 0) { port = route.getTargetHost().getPort(); } final CookieOrigin cookieOrigin = new CookieOrigin(hostName, port, path, route.isSecure()); // Get an instance of the selected cookie policy final CookieSpecFactory factory = registry.lookup(cookieSpecName); if (factory == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Unsupported cookie spec: {}", exchangeId, cookieSpecName); } return; } final CookieSpec cookieSpec = factory.create(clientContext); // Get all cookies available in the HTTP state final List cookies = cookieStore.getCookies(); // Find cookies matching the given origin final List matchedCookies = new ArrayList<>(); final Instant now = Instant.now(); boolean expired = false; for (final Cookie cookie : cookies) { if (!cookie.isExpired(now)) { if (cookieSpec.match(cookie, cookieOrigin)) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie {} match {}", exchangeId, cookie, cookieOrigin); } matchedCookies.add(cookie); } } else { if (LOG.isDebugEnabled()) { LOG.debug("{} Cookie {} expired", exchangeId, cookie); } expired = true; } } // Per RFC 6265, 5.3 // The user agent must evict all expired cookies if, at any time, an expired cookie // exists in the cookie store if (expired) { cookieStore.clearExpired(now); } // Generate Cookie request headers if (!matchedCookies.isEmpty()) { final List
headers = cookieSpec.formatCookies(matchedCookies); for (final Header header : headers) { request.addHeader(header); } } // Stick the CookieSpec and CookieOrigin instances to the HTTP context // so they could be obtained by the response interceptor clientContext.setCookieSpec(cookieSpec); clientContext.setCookieOrigin(cookieOrigin); } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/HttpClientContext.java0100664 0000000 0000000 00000052553 15005672016 027575 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.util.HashMap; import java.util.Map; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.EndpointDetails; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpCoreContext; /** * Client execution {@link HttpContext}. This class can be re-used for * multiple consecutive logically related request executions that represent * a single communication session. This context may not be used concurrently. *

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

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

*

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* * @since 5.4 */ default boolean isRedirectAllowed( HttpHost currentTarget, HttpHost newTarget, HttpRequest redirect, HttpContext context) { return true; } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestDefaultHeaders.java0100664 0000000 0000000 00000006024 15005672016 030373 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import java.util.Collection; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** * Request interceptor that adds default request headers. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class RequestDefaultHeaders implements HttpRequestInterceptor { /** * Default instance of {@link RequestDefaultHeaders}. * * @since 5.2 */ public static final RequestDefaultHeaders INSTANCE = new RequestDefaultHeaders(); private final Collection defaultHeaders; /** * @since 4.3 */ public RequestDefaultHeaders(final Collection defaultHeaders) { super(); this.defaultHeaders = defaultHeaders; } public RequestDefaultHeaders() { this(null); } @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); final String method = request.getMethod(); if (Method.CONNECT.isSame(method)) { return; } if (this.defaultHeaders != null) { for (final Header defHeader : this.defaultHeaders) { if (!request.containsHeader(defHeader.getName())) { request.addHeader(defHeader); } } } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/NextNonceInterceptor.java0100664 0000000 0000000 00000015574 15005672016 030274 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.FormattedHeader; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.TextUtils; import org.apache.hc.core5.util.Tokenizer; /** * {@code NextNonceInterceptor} is an HTTP response interceptor that extracts the {@code nextnonce} * parameter from the {@code Authentication-Info} header of an HTTP response. This parameter is used * in HTTP Digest Access Authentication to provide an additional nonce value that the client is expected * to use in subsequent authentication requests. By retrieving and storing this {@code nextnonce} value, * the interceptor facilitates one-time nonce implementations and prevents replay attacks by ensuring that * each request/response interaction includes a fresh nonce. *

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

* *

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

* *

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

* *

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

* * @since 5.5 */ @Contract(threading = ThreadingBehavior.STATELESS) public class NextNonceInterceptor implements HttpResponseInterceptor { public static final HttpResponseInterceptor INSTANCE = new NextNonceInterceptor(); private final Tokenizer tokenParser = Tokenizer.INSTANCE; private static final String AUTHENTICATION_INFO_HEADER = "Authentication-Info"; private static final Tokenizer.Delimiter TOKEN_DELIMS = Tokenizer.delimiters('=', ','); private static final Tokenizer.Delimiter VALUE_DELIMS = Tokenizer.delimiters(','); /** * Processes the HTTP response and extracts the {@code nextnonce} parameter from the * {@code Authentication-Info} header if available, storing it in the provided {@code context}. * * @param response the HTTP response containing the {@code Authentication-Info} header * @param entity the response entity, ignored by this interceptor * @param context the HTTP context in which to store the {@code nextnonce} parameter * @throws NullPointerException if either {@code response} or {@code context} is null */ @Override public void process(final HttpResponse response, final EntityDetails entity, final HttpContext context) { Args.notNull(response, "HTTP response"); Args.notNull(context, "HTTP context"); final Header header = response.getFirstHeader(AUTHENTICATION_INFO_HEADER); if (header != null) { final String nextNonce; if (header instanceof FormattedHeader) { final CharSequence buf = ((FormattedHeader) header).getBuffer(); final ParserCursor cursor = new ParserCursor(((FormattedHeader) header).getValuePos(), buf.length()); nextNonce = parseNextNonce(buf, cursor); } else { final CharSequence headerValue = header.getValue(); final ParserCursor cursor = new ParserCursor(0, headerValue.length()); nextNonce = parseNextNonce(headerValue, cursor); } if (!TextUtils.isBlank(nextNonce)) { HttpClientContext.castOrCreate(context).setNextNonce(nextNonce); } } } /** * Parses the {@code Authentication-Info} header content represented by a {@link CharArrayBuffer} * to extract the {@code nextnonce} parameter. * * @param buffer the {@link CharArrayBuffer} containing the value of the {@code Authentication-Info} header * @param cursor the {@link ParserCursor} used to navigate through the buffer content * @return the extracted {@code nextnonce} parameter value, or {@code null} if the parameter is not found */ private String parseNextNonce(final CharSequence buffer, final ParserCursor cursor) { while (!cursor.atEnd()) { final String name = tokenParser.parseToken(buffer, cursor, TOKEN_DELIMS); if ("nextnonce".equals(name)) { cursor.updatePos(cursor.getPos() + 1); return tokenParser.parseValue(buffer, cursor, VALUE_DELIMS); } if (!cursor.atEnd()) { cursor.updatePos(cursor.getPos() + 1); } } return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestIfRange.java0100664 0000000 0000000 00000013272 14704162040 027025 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import java.time.Instant; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.client5.http.validator.ETag; import org.apache.hc.client5.http.validator.ValidatorType; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** *

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

* *

* Key points: *

*
    *
  • A client MUST NOT generate an If-Range header field in a request that does not contain a Range header field.
    • *
  • An origin server MUST ignore an If-Range header field received in a request for a target resource that does not support Range requests.
    • *
  • A client MUST NOT generate an If-Range header field containing an entity tag that is marked as weak.
    • *
  • A client MUST NOT generate an If-Range header field containing an HTTP-date unless the client has no entity tag for the corresponding representation and the date is a strong validator.
    • *
  • A server that receives an If-Range header field on a Range request MUST evaluate the condition before performing the method.
    • *
* * @since 5.4 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public class RequestIfRange implements HttpRequestInterceptor { /** * Default instance of {@link RequestIfRange}. * * @since 5.4 */ public static final RequestIfRange INSTANCE = new RequestIfRange(); public RequestIfRange() { super(); } /** * Processes the given request to ensure it adheres to the RFC guidelines for the 'If-Range' header. * * @param request The HTTP request to be processed. * @param entity The entity details of the request. * @param context The HTTP context. * @throws HttpException If the request does not adhere to the RFC guidelines. * @throws IOException If an I/O error occurs. */ @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); final Header ifRangeHeader = request.getFirstHeader(HttpHeaders.IF_RANGE); // If there's no If-Range header, just return if (ifRangeHeader == null) { return; } // If there's an If-Range header but no Range header, throw an exception if (!request.containsHeader(HttpHeaders.RANGE)) { throw new ProtocolException("Request with 'If-Range' header must also contain a 'Range' header."); } final ETag eTag = ETag.get(request); // If there's a weak ETag in the If-Range header, throw an exception if (eTag != null && eTag.getType() == ValidatorType.WEAK) { throw new ProtocolException("'If-Range' header must not contain a weak entity tag."); } final Instant dateInstant = DateUtils.parseStandardDate(request, HttpHeaders.DATE); if (dateInstant == null) { return; } final Instant lastModifiedInstant = DateUtils.parseStandardDate(request, HttpHeaders.LAST_MODIFIED); if (lastModifiedInstant == null) { // If there's no Last-Modified header, we exit early because we can't deduce that it is strong. return; } // If the difference between the Last-Modified and Date headers is less than 1 second, throw an exception if (lastModifiedInstant.plusSeconds(1).isAfter(dateInstant) && eTag != null) { throw new ProtocolException("'If-Range' header with a Date must be a strong validator."); } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestAuthCache.java0100664 0000000 0000000 00000012147 14704162040 027337 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.impl.RequestSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request interceptor that can preemptively authenticate against known hosts, * if there is a cached {@link AuthScheme} instance in the local * {@link AuthCache} associated with the given target or proxy host. * * @since 4.1 * * @deprecated Do not use. */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public class RequestAuthCache implements HttpRequestInterceptor { private static final Logger LOG = LoggerFactory.getLogger(RequestAuthCache.class); public RequestAuthCache() { super(); } @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(context, "HTTP context"); final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); final AuthCache authCache = clientContext.getAuthCache(); if (authCache == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Auth cache not set in the context", exchangeId); } return; } final CredentialsProvider credsProvider = clientContext.getCredentialsProvider(); if (credsProvider == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Credentials provider not set in the context", exchangeId); } return; } final RouteInfo route = clientContext.getHttpRoute(); if (route == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Route info not set in the context", exchangeId); } return; } final HttpHost target = new HttpHost(request.getScheme(), request.getAuthority()); final AuthExchange targetAuthExchange = clientContext.getAuthExchange(target); if (targetAuthExchange.getState() == AuthExchange.State.UNCHALLENGED) { final String pathPrefix = RequestSupport.extractPathPrefix(request); final AuthScheme authScheme = authCache.get(target, pathPrefix); if (authScheme != null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Re-using cached '{}' auth scheme for {}", exchangeId, authScheme.getName(), target); } targetAuthExchange.select(authScheme); } } final HttpHost proxy = route.getProxyHost(); if (proxy != null) { final AuthExchange proxyAuthExchange = clientContext.getAuthExchange(proxy); if (proxyAuthExchange.getState() == AuthExchange.State.UNCHALLENGED) { final AuthScheme authScheme = authCache.get(proxy, null); if (authScheme != null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Re-using cached '{}' auth scheme for {}", exchangeId, authScheme.getName(), proxy); } proxyAuthExchange.select(authScheme); } } } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestValidateTrace.java0100664 0000000 0000000 00000014740 14704162040 030223 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** *

RequestTraceInterceptor

* *

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

* *

Responsibilities:

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

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

* *

Interceptor Behavior:

*
    *
  • If the HTTP method is TRACE, the interceptor throws a {@link ProtocolException} if any {@code Authorization} or {@code Cookie} headers are present to prevent sensitive data leakage.
    • *
  • If a TRACE request contains a body, a {@link ProtocolException} is thrown.
    • *
* * @version 5.4 * @see HttpRequestInterceptor * @see HttpException * @see IOException * @see ProtocolException * @see Method#TRACE * @see HttpHeaders#AUTHORIZATION * @see HttpHeaders#COOKIE *//** *

RequestTraceInterceptor

* *

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

* *

Responsibilities:

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

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

* *

Interceptor Behavior:

*
    *
  • If the HTTP method is TRACE, the interceptor throws a {@link ProtocolException} if any {@code Authorization} or {@code Cookie} headers are present to prevent sensitive data leakage.
    • *
  • If a TRACE request contains a body, a {@link ProtocolException} is thrown.
    • *
* * @version 5.4 * @see HttpRequestInterceptor * @see HttpException * @see IOException * @see ProtocolException * @see Method#TRACE * @see HttpHeaders#AUTHORIZATION * @see HttpHeaders#COOKIE */ @Contract(threading = ThreadingBehavior.STATELESS) public class RequestValidateTrace implements HttpRequestInterceptor { /** * Default instance of {@link RequestValidateTrace}. */ public static final HttpRequestInterceptor INSTANCE = new RequestValidateTrace(); /** * Default constructor. */ public RequestValidateTrace() { super(); } /** * Processes an incoming HTTP request. If the request is of type TRACE, it performs the following actions: *
    *
  • Throws a {@link ProtocolException} if the request contains an {@code Authorization} header to prevent sensitive data leakage.
    • *
  • Throws a {@link ProtocolException} if the request contains a {@code Cookie} header to prevent sensitive data leakage.
    • *
  • Throws a {@link ProtocolException} if the request contains a body.
    • *
* * @param request The incoming HTTP request. Cannot be {@code null}. * @param entity Details of the request entity. Can be {@code null}. * @param context The HTTP context. * @throws HttpException If a protocol error occurs. * @throws IOException If an I/O error occurs. */ @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(context, "HTTP context"); // Check if the request method is TRACE if (Method.TRACE.isSame(request.getMethod())) { // A client MUST NOT send content in a TRACE request. if (entity != null) { throw new ProtocolException("TRACE request MUST NOT contain a request body."); } // Check for sensitive headers final Header authHeader = request.getHeader(HttpHeaders.AUTHORIZATION); if (authHeader != null) { throw new ProtocolException("TRACE request MUST NOT contain an Authorization header."); } // Check for cookies final Header cookieHeader = request.getHeader(HttpHeaders.COOKIE); if (cookieHeader != null) { throw new ProtocolException("TRACE request MUST NOT contain a Cookie header."); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/protocol/RequestExpectContinue.java0100664 0000000 0000000 00000006400 15063503632 030447 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.io.IOException; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** * RequestExpectContinue is responsible for enabling the 'expect-continue' * handshake by adding {@code Expect} header. *

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

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class RequestExpectContinue implements HttpRequestInterceptor { public RequestExpectContinue() { super(); } @Override public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context) throws HttpException, IOException { Args.notNull(request, "HTTP request"); if (!request.containsHeader(HttpHeaders.EXPECT)) { final HttpClientContext clientContext = HttpClientContext.cast(context); final ProtocolVersion version = request.getVersion() != null ? request.getVersion() : clientContext.getProtocolVersion(); // Do not send the expect header if request body is known to be empty if (entity != null && entity.getContentLength() != 0 && !version.lessEquals(HttpVersion.HTTP_1_0)) { final RequestConfig config = clientContext.getRequestConfigOrDefault(); if (config.isExpectContinueEnabled()) { request.addHeader(HttpHeaders.EXPECT, HeaderElements.CONTINUE); } } } } } httpclient5/src/main/java/org/apache/hc/client5/http/ConnectExceptionSupport.java0100664 0000000 0000000 00000007324 14666635064 027170 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.io.IOException; import java.net.ConnectException; import java.net.InetAddress; import java.net.SocketTimeoutException; import java.util.Arrays; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.net.NamedEndpoint; /** * Connect exception support methods. * * @since 5.0 */ @Internal public final class ConnectExceptionSupport { public static ConnectTimeoutException createConnectTimeoutException( final IOException cause, final NamedEndpoint namedEndpoint, final InetAddress... remoteAddresses) { final String message = "Connect to " + (namedEndpoint != null ? namedEndpoint : "remote endpoint") + (remoteAddresses != null && remoteAddresses.length > 0 ? " " + Arrays.asList(remoteAddresses) : "") + ((cause != null && cause.getMessage() != null) ? " failed: " + cause.getMessage() : " timed out"); return new ConnectTimeoutException(message, namedEndpoint); } public static HttpHostConnectException createHttpHostConnectException( final IOException cause, final NamedEndpoint namedEndpoint, final InetAddress... remoteAddresses) { final String message = "Connect to " + (namedEndpoint != null ? namedEndpoint : "remote endpoint") + (remoteAddresses != null && remoteAddresses.length > 0 ? " " + Arrays.asList(remoteAddresses) : "") + ((cause != null && cause.getMessage() != null) ? " failed: " + cause.getMessage() : " refused"); return new HttpHostConnectException(message, namedEndpoint); } public static IOException enhance( final IOException cause, final NamedEndpoint namedEndpoint, final InetAddress... remoteAddresses) { if (cause instanceof SocketTimeoutException) { final IOException ex = createConnectTimeoutException(cause, namedEndpoint, remoteAddresses); ex.setStackTrace(cause.getStackTrace()); return ex; } else if (cause instanceof ConnectException) { if ("Connection timed out".equals(cause.getMessage())) { final IOException ex = createConnectTimeoutException(cause, namedEndpoint, remoteAddresses); ex.initCause(cause); return ex; } final IOException ex = createHttpHostConnectException(cause, namedEndpoint, remoteAddresses); ex.setStackTrace(cause.getStackTrace()); return ex; } else { return cause; } } } httpclient5/src/main/java/org/apache/hc/client5/http/nio/0040775 0000000 0000000 00000000000 15063503632 022225 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/nio/ManagedAsyncClientConnection.java0100664 0000000 0000000 00000005250 14666635064 030615 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.nio; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.ProtocolIOSession; import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer; /** * Represents a managed asynchronous connection whose state and life cycle * is managed by a connection manager. * * @since 5.0 */ @Internal public interface ManagedAsyncClientConnection extends HttpConnection, TransportSecurityLayer { /** * Submits the given command for execution. * * @param command the command to be executed. * @param priority the command priority. */ void submitCommand(Command command, Command.Priority priority); /** * Puts the connection into idle mode. */ void passivate(); /** * Restores the connection from idle mode. */ void activate(); /** * Switches this I/O session to the application protocol with the given ID. * @param protocolId the application protocol ID * @param callback the result callback * @throws UnsupportedOperationException if application protocol switch * is not supported. * * @since 5.2 */ default void switchProtocol(String protocolId, FutureCallback callback) throws UnsupportedOperationException { throw new UnsupportedOperationException("Protocol switch not supported"); } } httpclient5/src/main/java/org/apache/hc/client5/http/nio/package-info.java0100664 0000000 0000000 00000002424 14666635064 025430 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Connection management APIs based on the asynchronous I/O model. */ package org.apache.hc.client5.http.nio; httpclient5/src/main/java/org/apache/hc/client5/http/nio/AsyncClientConnectionOperator.java0100664 0000000 0000000 00000013266 15063503632 031045 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.nio; import java.net.SocketAddress; import java.util.concurrent.Future; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.util.Timeout; /** * Connection operator that performs connection connect and upgrade operations. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public interface AsyncClientConnectionOperator { /** * Initiates operation to create a connection to the remote endpoint using * the provided {@link ConnectionInitiator}. * * @param connectionInitiator the connection initiator. * @param host the address of the opposite endpoint. * @param localAddress the address of the local endpoint. * @param connectTimeout the timeout of the connect operation. * @param attachment the attachment, which can be any object representing custom parameter * of the operation. * @param callback the future result callback. */ Future connect( ConnectionInitiator connectionInitiator, HttpHost host, SocketAddress localAddress, Timeout connectTimeout, Object attachment, FutureCallback callback); /** * Initiates operation to create a connection to the remote endpoint using * the provided {@link ConnectionInitiator}. * * @param connectionInitiator the connection initiator. * @param endpointHost the address of the remote endpoint. * @param endpointName the name of the remote endpoint, if different from the endpoint host name, * {@code null} otherwise. Usually taken from the request URU authority. * @param localAddress the address of the local endpoint. * @param connectTimeout the timeout of the connect operation. * @param attachment the attachment, which can be any object representing custom parameter * of the operation. * @param context the execution context. * @param callback the future result callback. * @since 5.4 */ default Future connect( ConnectionInitiator connectionInitiator, HttpHost endpointHost, NamedEndpoint endpointName, SocketAddress localAddress, Timeout connectTimeout, Object attachment, HttpContext context, FutureCallback callback) { return connect(connectionInitiator, endpointHost, localAddress, connectTimeout, attachment, callback); } /** * Upgrades transport security of the given managed connection * by using the TLS security protocol. * * @param conn the managed connection. * @param host the address of the opposite endpoint with TLS security. * @param attachment the attachment, which can be any object representing custom parameter * of the operation. */ void upgrade(ManagedAsyncClientConnection conn, HttpHost host, Object attachment); /** * Upgrades transport security of the given managed connection * by using the TLS security protocol. * * @param conn the managed connection. * @param endpointHost the address of the remote endpoint. * @param endpointName the name of the remote endpoint, if different from the endpoint host name, * {@code null} otherwise. Usually taken from the request URU authority. * @param attachment the attachment, which can be any object representing custom parameter * of the operation. * @param context the execution context. * @param callback the future result callback. * @since 5.4 */ default void upgrade( ManagedAsyncClientConnection conn, HttpHost endpointHost, NamedEndpoint endpointName, Object attachment, HttpContext context, FutureCallback callback) { upgrade(conn, endpointHost, attachment); if (callback != null) { callback.completed(conn); } } } httpclient5/src/main/java/org/apache/hc/client5/http/nio/AsyncConnectionEndpoint.java0100664 0000000 0000000 00000017661 14704162040 027671 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.nio; import java.io.IOException; import java.util.concurrent.Future; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.BasicFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.support.BasicClientExchangeHandler; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpCoreContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.util.Timeout; /** * Client connection endpoint that can be used to execute message exchanges. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE) public abstract class AsyncConnectionEndpoint implements ModalCloseable { /** * Initiates a message exchange using the given handler. * * @param id unique operation ID or {@code null}. * @param exchangeHandler the message exchange handler. * @param pushHandlerFactory the push handler factory. * @param context the execution context. */ public abstract void execute( String id, AsyncClientExchangeHandler exchangeHandler, HandlerFactory pushHandlerFactory, HttpContext context); /** * Determines if the connection to the remote endpoint is still open and valid. */ public abstract boolean isConnected(); /** * Sets socket timeout. * * @param timeout the socket timeout. */ public abstract void setSocketTimeout(Timeout timeout); @Override public final void close() throws IOException { close(CloseMode.GRACEFUL); } /** * Initiates a message exchange using the given handler. * * @param id unique operation ID or {@code null}. * @param exchangeHandler the message exchange handler. * @param context the execution context. */ public void execute( final String id, final AsyncClientExchangeHandler exchangeHandler, final HttpContext context) { execute(id, exchangeHandler, null, context); } /** * Initiates message exchange using the given request producer and response consumer. * * @param id unique operation ID or {@code null}. * @param requestProducer the request producer. * @param responseConsumer the response consumer. * @param pushHandlerFactory the push handler factory. * @param context the execution context. * @param callback the result callback. * @param the result representation. * @return the result future. */ public final Future execute( final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback) { final BasicFuture future = new BasicFuture<>(callback); execute(id, new BasicClientExchangeHandler<>(requestProducer, responseConsumer, new FutureCallback() { @Override public void completed(final T result) { future.completed(result); } @Override public void failed(final Exception ex) { future.failed(ex); } @Override public void cancelled() { future.cancel(); } }), pushHandlerFactory, context != null ? context : HttpCoreContext.create()); return future; } /** * Initiates message exchange using the given request producer and response consumer. * * @param id unique operation ID or {@code null}. * @param requestProducer the request producer. * @param responseConsumer the response consumer. * @param context the execution context. * @param callback the result callback. * @param the result representation. * @return the result future. */ public final Future execute( final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HttpContext context, final FutureCallback callback) { return execute(id, requestProducer, responseConsumer, null, context, callback); } /** * Initiates message exchange using the given request producer and response consumer. * * @param id unique operation ID or {@code null}. * @param requestProducer the request producer. * @param responseConsumer the response consumer. * @param pushHandlerFactory the push handler factory. * @param callback the result callback. * @param the result representation. * @return the result future. */ public final Future execute( final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final FutureCallback callback) { return execute(id, requestProducer, responseConsumer, pushHandlerFactory, null, callback); } /** * Initiates message exchange using the given request producer and response consumer. * * @param id unique operation ID or {@code null}. * @param requestProducer the request producer. * @param responseConsumer the response consumer. * @param callback the result callback. * @param the result representation. * @return the result future. */ public final Future execute( final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final FutureCallback callback) { return execute(id, requestProducer, responseConsumer, null, null, callback); } /** * Returns information about the endpoint or {@code null} when not connected. * * @since 5.4 */ public EndpointInfo getInfo() { return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/nio/AsyncClientConnectionManager.java0100664 0000000 0000000 00000014363 14666635064 030640 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.nio; import java.util.concurrent.Future; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Represents a manager of persistent non-blocking client connections. *

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

*

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

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

* Please note that newly allocated endpoints can be leased * {@link AsyncConnectionEndpoint#isConnected() disconnected}. The consumer * of the endpoint is responsible for fully establishing the route to * the endpoint target by calling {@link #connect(AsyncConnectionEndpoint, * ConnectionInitiator, Timeout, Object, HttpContext, FutureCallback)} * in order to connect directly to the target or to the first proxy hop, * and optionally calling {@link #upgrade(AsyncConnectionEndpoint, Object, HttpContext)} * method to upgrade the underlying transport to Transport Layer Security * after having executed a {@code CONNECT} method to all intermediate * proxy hops. * * @param id unique operation ID or {@code null}. * @param route HTTP route of the requested connection. * @param state expected state of the connection or {@code null} * if the connection is not expected to carry any state. * @param requestTimeout lease request timeout. * @param callback result callback. */ Future lease( String id, HttpRoute route, Object state, Timeout requestTimeout, FutureCallback callback); /** * Releases the endpoint back to the manager making it potentially * re-usable by other consumers. Optionally, the maximum period * of how long the manager should keep the connection alive can be * defined using {@code validDuration} and {@code timeUnit} * parameters. * * @param endpoint the managed endpoint. * @param newState the new connection state of {@code null} if state-less. * @param validDuration the duration of time this connection is valid for reuse. */ void release(AsyncConnectionEndpoint endpoint, Object newState, TimeValue validDuration); /** * Connects the endpoint to the initial hop (connection target in case * of a direct route or to the first proxy hop in case of a route via a proxy * or multiple proxies). * * @param endpoint the managed endpoint. * @param connectTimeout connect timeout. * @param context the actual HTTP context. * @param attachment connect request attachment. * @param callback result callback. */ Future connect( AsyncConnectionEndpoint endpoint, ConnectionInitiator connectionInitiator, Timeout connectTimeout, Object attachment, HttpContext context, FutureCallback callback); /** * Upgrades transport security of the given endpoint by using the TLS security protocol. * * @param endpoint the managed endpoint. * @param attachment the attachment the upgrade attachment object. * @param context the actual HTTP context. */ void upgrade( AsyncConnectionEndpoint endpoint, Object attachment, HttpContext context); /** * Upgrades transport security of the given endpoint by using the TLS security protocol. * * @param endpoint the managed endpoint. * @param attachment the attachment the upgrade attachment object. * @param context the actual HTTP context. * @param callback result callback. * * @since 5.2 */ default void upgrade( AsyncConnectionEndpoint endpoint, Object attachment, HttpContext context, FutureCallback callback) { upgrade(endpoint, attachment, context); if (callback != null) { callback.completed(endpoint); } } } httpclient5/src/main/java/org/apache/hc/client5/http/HttpRoute.java0100664 0000000 0000000 00000035657 15063503632 024256 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.InetAddress; import java.net.InetSocketAddress; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.Objects; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; /** * Connection route definition for HTTP requests. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class HttpRoute implements RouteInfo, Cloneable { /** The target host to connect to. */ private final HttpHost targetHost; /** The target name, if different from the target host, {@code null} otherwise. */ private final NamedEndpoint targetName; /** * The local address to connect from. * {@code null} indicates that the default should be used. */ private final InetAddress localAddress; /** The proxy servers, if any. Never null. */ private final List proxyChain; /** Whether the the route is tunnelled through the proxy. */ private final TunnelType tunnelled; /** Whether the route is layered. */ private final LayerType layered; /** Whether the route is (supposed to be) secure. */ private final boolean secure; HttpRoute(final HttpHost targetHost, final NamedEndpoint targetName, final InetAddress local, final List proxies, final boolean secure, final TunnelType tunnelled, final LayerType layered) { Args.notNull(targetHost, "Target host"); Args.notNegative(targetHost.getPort(), "Target port"); this.targetName = targetName; this.targetHost = targetHost; this.localAddress = local; if (proxies != null && !proxies.isEmpty()) { this.proxyChain = new ArrayList<>(proxies); } else { this.proxyChain = null; } if (tunnelled == TunnelType.TUNNELLED) { Args.check(this.proxyChain != null, "Proxy required if tunnelled"); } this.secure = secure; this.tunnelled = tunnelled != null ? tunnelled : TunnelType.PLAIN; this.layered = layered != null ? layered : LayerType.PLAIN; } /** * Creates a new route with all attributes specified explicitly. * * @param target the host to which to route * @param local the local address to route from, or * {@code null} for the default * @param proxies the proxy chain to use, or * {@code null} for a direct route * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise * @param tunnelled the tunnel type of this route * @param layered the layering type of this route */ public HttpRoute(final HttpHost target, final InetAddress local, final HttpHost[] proxies, final boolean secure, final TunnelType tunnelled, final LayerType layered) { this(target, null, local, proxies != null ? Arrays.asList(proxies) : null, secure, tunnelled, layered); } /** * Creates a new route with all attributes specified explicitly. * * @param target the host to which to route * @param targetName the target targetName if differs from the target host. * @param local the local address to route from, or * {@code null} for the default * @param proxies the proxy chain to use, or * {@code null} for a direct route * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise * @param tunnelled the tunnel type of this route * @param layered the layering type of this route * * @since 5.4 */ public HttpRoute(final HttpHost target, final NamedEndpoint targetName, final InetAddress local, final HttpHost[] proxies, final boolean secure, final TunnelType tunnelled, final LayerType layered) { this(target, targetName, local, proxies != null ? Arrays.asList(proxies) : null, secure, tunnelled, layered); } /** * Creates a new route with at most one proxy. * * @param target the host to which to route * @param local the local address to route from, or * {@code null} for the default * @param proxy the proxy to use, or * {@code null} for a direct route * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise * @param tunnelled {@code true} if the route is (to be) tunnelled * via the proxy, * {@code false} otherwise * @param layered {@code true} if the route includes a * layered protocol, * {@code false} otherwise */ public HttpRoute(final HttpHost target, final InetAddress local, final HttpHost proxy, final boolean secure, final TunnelType tunnelled, final LayerType layered) { this(target, null, local, proxy != null ? Collections.singletonList(proxy) : null, secure, tunnelled, layered); } /** * Creates a new direct route. * That is a route without a proxy. * * @param target the host to which to route * @param local the local address to route from, or * {@code null} for the default * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise */ public HttpRoute(final HttpHost target, final InetAddress local, final boolean secure) { this(target, null, local, Collections.emptyList(), secure, TunnelType.PLAIN, LayerType.PLAIN); } /** * Creates a new direct route. That is a route without a proxy. * * @param target the host to which to route * @param targetName the target targetName if differs from the target host. * @param local the local address to route from, or * {@code null} for the default * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise * * @since 5.4 */ public HttpRoute(final HttpHost target, final NamedEndpoint targetName, final InetAddress local, final boolean secure) { this(target, targetName, local, Collections.emptyList(), secure, TunnelType.PLAIN, LayerType.PLAIN); } /** * Creates a new direct insecure route. * * @param target the host to which to route */ public HttpRoute(final HttpHost target) { this(target, null, null, Collections.emptyList(), false, TunnelType.PLAIN, LayerType.PLAIN); } /** * Creates a new route through a proxy. * When using this constructor, the {@code proxy} MUST be given. * For convenience, it is assumed that a secure connection will be * layered over a tunnel through the proxy. * * @param target the host to which to route * @param targetName the target targetName if differs from the target host. * @param local the local address to route from, or * {@code null} for the default * @param proxy the proxy to use * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise * * @since 5.4 */ public HttpRoute(final HttpHost target, final NamedEndpoint targetName, final InetAddress local, final HttpHost proxy, final boolean secure) { this(target, targetName, local, Collections.singletonList(Args.notNull(proxy, "Proxy host")), secure, secure ? TunnelType.TUNNELLED : TunnelType.PLAIN, secure ? LayerType.LAYERED : LayerType.PLAIN); } /** * Creates a new route through a proxy. * When using this constructor, the {@code proxy} MUST be given. * For convenience, it is assumed that a secure connection will be * layered over a tunnel through the proxy. * * @param target the host to which to route * @param local the local address to route from, or * {@code null} for the default * @param proxy the proxy to use * @param secure {@code true} if the route is (to be) secure, * {@code false} otherwise */ public HttpRoute(final HttpHost target, final InetAddress local, final HttpHost proxy, final boolean secure) { this(target, null, local, Collections.singletonList(Args.notNull(proxy, "Proxy host")), secure, secure ? TunnelType.TUNNELLED : TunnelType.PLAIN, secure ? LayerType.LAYERED : LayerType.PLAIN); } /** * Creates a new plain route through a proxy. * * @param target the host to which to route * @param proxy the proxy to use * * @since 4.3 */ public HttpRoute(final HttpHost target, final HttpHost proxy) { this(target, null, proxy, false); } @Override public HttpHost getTargetHost() { return this.targetHost; } /** * @since 5.4 */ @Override public NamedEndpoint getTargetName() { return targetName; } @Override public InetAddress getLocalAddress() { return this.localAddress; } public InetSocketAddress getLocalSocketAddress() { return this.localAddress != null ? new InetSocketAddress(this.localAddress, 0) : null; } @Override public int getHopCount() { return proxyChain != null ? proxyChain.size() + 1 : 1; } @Override public HttpHost getHopTarget(final int hop) { Args.notNegative(hop, "Hop index"); final int hopcount = getHopCount(); Args.check(hop < hopcount, "Hop index exceeds tracked route length"); if (hop < hopcount - 1) { return this.proxyChain.get(hop); } return this.targetHost; } @Override public HttpHost getProxyHost() { return proxyChain != null && !this.proxyChain.isEmpty() ? this.proxyChain.get(0) : null; } @Override public TunnelType getTunnelType() { return this.tunnelled; } @Override public boolean isTunnelled() { return this.tunnelled == TunnelType.TUNNELLED; } @Override public LayerType getLayerType() { return this.layered; } @Override public boolean isLayered() { return this.layered == LayerType.LAYERED; } @Override public boolean isSecure() { return this.secure; } /** * Compares this route to another. * * @param obj the object to compare with * * @return {@code true} if the argument is the same route, * {@code false} */ @Override public boolean equals(final Object obj) { if (this == obj) { return true; } if (obj instanceof HttpRoute) { final HttpRoute that = (HttpRoute) obj; return // Do the cheapest tests first this.secure == that.secure && this.tunnelled == that.tunnelled && this.layered == that.layered && Objects.equals(this.targetHost, that.targetHost) && Objects.equals(this.targetName, that.targetName) && Objects.equals(this.localAddress, that.localAddress) && Objects.equals(this.proxyChain, that.proxyChain); } return false; } /** * Generates a hash code for this route. * * @return the hash code */ @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.targetHost); hash = LangUtils.hashCode(hash, this.targetName); hash = LangUtils.hashCode(hash, this.localAddress); if (this.proxyChain != null) { for (final HttpHost element : this.proxyChain) { hash = LangUtils.hashCode(hash, element); } } hash = LangUtils.hashCode(hash, this.secure); hash = LangUtils.hashCode(hash, this.tunnelled); hash = LangUtils.hashCode(hash, this.layered); return hash; } /** * Obtains a description of this route. * * @return a human-readable representation of this route */ @Override public String toString() { final StringBuilder cab = new StringBuilder(50 + getHopCount() * 30); if (this.localAddress != null) { cab.append(this.localAddress); cab.append("->"); } cab.append('{'); if (this.tunnelled == TunnelType.TUNNELLED) { cab.append('t'); } if (this.layered == LayerType.LAYERED) { cab.append('l'); } if (this.secure) { cab.append('s'); } cab.append("}->"); if (this.proxyChain != null) { for (final HttpHost aProxyChain : this.proxyChain) { cab.append(aProxyChain); cab.append("->"); } } if (this.targetName != null) { cab.append(this.targetName); cab.append("/"); } cab.append("["); cab.append(this.targetHost); cab.append("]"); return cab.toString(); } // default implementation of clone() is sufficient @Override public Object clone() throws CloneNotSupportedException { return super.clone(); } } httpclient5/src/main/java/org/apache/hc/client5/http/UserTokenHandler.java0100664 0000000 0000000 00000006021 14666635064 025531 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; /** * A handler for determining if the given execution context is user specific * or not. The token object returned by this handler is expected to uniquely * identify the current user if the context is user specific or to be * {@code null} if the context does not contain any resources or details * specific to the current user. *

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

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface UserTokenHandler { /** * The token object returned by this method is expected to uniquely * identify the current user if the context is user specific or to be * {@code null} if it is not. * * @param route HTTP route * @param context the execution context * * @return user token that uniquely identifies the user or * {@code null} if the context is not user specific. */ Object getUserToken(HttpRoute route, HttpContext context); /** * The token object returned by this method is expected to uniquely * identify the current user if the context is user specific or to be * {@code null} if it is not. * * @param route HTTP route * @param request HTTP request * @param context the execution context * * @return user token that uniquely identifies the user or * {@code null} if the context is not user specific. * * @since 5.2 */ default Object getUserToken(HttpRoute route, HttpRequest request, HttpContext context) { return getUserToken(route, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/CircularRedirectException.java0100664 0000000 0000000 00000004344 14666635064 027427 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; /** * Signals a circular redirect * * @since 4.0 */ public class CircularRedirectException extends RedirectException { private static final long serialVersionUID = 6830063487001091803L; /** * Creates a new CircularRedirectException with a {@code null} detail message. */ public CircularRedirectException() { super(); } /** * Creates a new CircularRedirectException with the specified detail message. * * @param message The exception detail message */ public CircularRedirectException(final String message) { super(message); } /** * Creates a new CircularRedirectException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public CircularRedirectException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/RedirectException.java0100664 0000000 0000000 00000004412 14666635064 025736 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.core5.http.ProtocolException; /** * Signals violation of HTTP specification caused by an invalid redirect * * @since 4.0 */ public class RedirectException extends ProtocolException { private static final long serialVersionUID = 4418824536372559326L; /** * Creates a new RedirectException with a {@code null} detail message. */ public RedirectException() { super(); } /** * Creates a new RedirectException with the specified detail message. * * @param message The exception detail message */ public RedirectException(final String message) { super(message); } /** * Creates a new RedirectException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public RedirectException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/HttpRequestRetryStrategy.java0100664 0000000 0000000 00000010044 15036651120 027334 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.io.IOException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.TimeValue; /** * Strategy interface that allows API users to plug in their own logic to * control whether or not a retry should automatically be done, how many times * it should be done and so on. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface HttpRequestRetryStrategy { /** * Determines if a method should be retried after an I/O exception * occurred during execution. * * @param request the request failed due to an I/O exception * @param exception the exception that occurred * @param execCount the number of times this method has been * unsuccessfully executed * @param context the context for the request execution * * @return {@code true} if the request should be retried, {@code false} * otherwise */ boolean retryRequest(HttpRequest request, IOException exception, int execCount, HttpContext context); /** * Determines if a method should be retried given the response from * the target server. * * @param response the response from the target server * @param execCount the number of times this method has been * unsuccessfully executed * @param context the context for the request execution * * @return {@code true} if the request should be retried, {@code false} * otherwise */ boolean retryRequest(HttpResponse response, int execCount, HttpContext context); /** * Determines the retry interval between subsequent retries. * * @param request the request failed due to an I/O exception * @param exception the exception that occurred * @param execCount the number of times this method has been * unsuccessfully executed * @param context the context for the request execution * * @return the retry interval between subsequent retries */ default TimeValue getRetryInterval(HttpRequest request, IOException exception, int execCount, HttpContext context) { return TimeValue.ZERO_MILLISECONDS; } /** * Determines the retry interval between subsequent retries. * * @param response the response from the target server * @param execCount the number of times this method has been * unsuccessfully executed * @param context the context for the request execution * * @return the retry interval between subsequent retries */ TimeValue getRetryInterval(HttpResponse response, int execCount, HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/0040775 0000000 0000000 00000000000 15063503632 022241 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/ssl/package-info.java0100664 0000000 0000000 00000002354 14666635064 025446 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client TLS/SSL support. */ package org.apache.hc.client5.http.ssl; httpclient5/src/main/java/org/apache/hc/client5/http/ssl/ConscryptClientTlsStrategy.java0100664 0000000 0000000 00000012657 15063503632 030445 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLEngine; import javax.net.ssl.SSLParameters; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.reactor.ssl.SSLBufferMode; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.ssl.SSLContexts; import org.conscrypt.Conscrypt; /** * TLS upgrade strategy for non-blocking client connections using Conscrypt TLS library. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class ConscryptClientTlsStrategy extends AbstractClientTlsStrategy { public static TlsStrategy getDefault() { return new ConscryptClientTlsStrategy( SSLContexts.createDefault(), HostnameVerificationPolicy.BOTH, HttpsSupport.getDefaultHostnameVerifier()); } public static TlsStrategy getSystemDefault() { return new ConscryptClientTlsStrategy( SSLContexts.createSystemDefault(), HttpsSupport.getSystemProtocols(), HttpsSupport.getSystemCipherSuits(), SSLBufferMode.STATIC, HostnameVerificationPolicy.BOTH, HttpsSupport.getDefaultHostnameVerifier()); } public ConscryptClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerifier hostnameVerifier) { this(sslContext, supportedProtocols, supportedCipherSuites, sslBufferManagement, HostnameVerificationPolicy.CLIENT, hostnameVerifier); } /** * @since 5.4 */ public ConscryptClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerificationPolicy hostnameVerificationPolicy, final HostnameVerifier hostnameVerifier) { super(sslContext, supportedProtocols, supportedCipherSuites, sslBufferManagement, hostnameVerificationPolicy, hostnameVerifier); } public ConscryptClientTlsStrategy( final SSLContext sslContext, final HostnameVerifier hostnameVerifier) { this(sslContext, null, null, SSLBufferMode.STATIC, hostnameVerifier); } /** * @since 5.4 */ public ConscryptClientTlsStrategy( final SSLContext sslContext, final HostnameVerificationPolicy hostnameVerificationPolicy, final HostnameVerifier hostnameVerifier) { this(sslContext, null, null, SSLBufferMode.STATIC, hostnameVerificationPolicy, hostnameVerifier); } public ConscryptClientTlsStrategy(final SSLContext sslContext) { this(sslContext, HttpsSupport.getDefaultHostnameVerifier()); } @Override void applyParameters(final SSLEngine sslEngine, final SSLParameters sslParameters, final String[] appProtocols) { if (Conscrypt.isConscrypt(sslEngine)) { sslEngine.setSSLParameters(sslParameters); Conscrypt.setApplicationProtocols(sslEngine, appProtocols); } else { sslParameters.setApplicationProtocols(appProtocols); sslEngine.setSSLParameters(sslParameters); } } @Override TlsDetails createTlsDetails(final SSLEngine sslEngine) { if (Conscrypt.isConscrypt(sslEngine)) { return new TlsDetails(sslEngine.getSession(), Conscrypt.getApplicationProtocol(sslEngine)); } return null; } public static boolean isSupported() { try { final Class clazz = Class.forName("org.conscrypt.Conscrypt"); final Method method = clazz.getMethod("isAvailable"); return ((Boolean) method.invoke(null)).booleanValue(); } catch (final ClassNotFoundException | NoSuchMethodException | IllegalAccessException | InvocationTargetException e) { return false; } } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/SubjectName.java0100664 0000000 0000000 00000003652 14666635064 025324 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import org.apache.hc.core5.util.Args; final class SubjectName { static final int DNS = 2; static final int IP = 7; private final String value; private final int type; static SubjectName IP(final String value) { return new SubjectName(value, IP); } static SubjectName DNS(final String value) { return new SubjectName(value, DNS); } SubjectName(final String value, final int type) { this.value = Args.notNull(value, "Value"); this.type = Args.positive(type, "Type"); } public int getType() { return type; } public String getValue() { return value; } @Override public String toString() { return value; } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/TrustAllStrategy.java0100664 0000000 0000000 00000004570 14704162040 026377 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.security.cert.CertificateException; import java.security.cert.X509Certificate; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.ssl.TrustStrategy; /** * A trust strategy that accepts all certificates as trusted. * *

Security Warning

* This trust strategy effectively disables trust verification of SSL / TLS, * and allows man-in-the-middle attacks. If possible avoid this trust strategy * and use more secure alternatives. For example, for self-signed certificates * prefer specifying a keystore containing the certificate chain when calling * the {@link org.apache.hc.core5.ssl.SSLContextBuilder} {@code loadTrustMaterial} * methods. * * @since 4.5.4 * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class TrustAllStrategy implements TrustStrategy { /** * Default instance of {@link TrustAllStrategy}. */ public static final TrustAllStrategy INSTANCE = new TrustAllStrategy(); @Override public boolean isTrusted(final X509Certificate[] chain, final String authType) throws CertificateException { return true; } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/TrustSelfSignedStrategy.java0100664 0000000 0000000 00000005203 14704162040 027704 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.security.cert.CertificateException; import java.security.cert.X509Certificate; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.ssl.TrustStrategy; /** * A trust strategy that accepts self-signed certificates as trusted. Verification of all other * certificates is done by the trust manager configured in the SSL context. * *

Security Warning

* This acts like {@link TrustAllStrategy}, with the only restriction that the certificate chain * must have length 1. This means this trust strategy does not protect against man-in-the-middle * attacks. See the {@link TrustAllStrategy} for more information and more secure alternatives. * * @deprecated * For self-signed certificates prefer specifying a keystore containing the certificate when * calling the {@link org.apache.hc.core5.ssl.SSLContextBuilder} {@code loadTrustMaterial} * methods. * @since 4.1 */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public class TrustSelfSignedStrategy implements TrustStrategy { /** * Default instance of {@link TrustSelfSignedStrategy} */ public static final TrustSelfSignedStrategy INSTANCE = new TrustSelfSignedStrategy(); @Override public boolean isTrusted( final X509Certificate[] chain, final String authType) throws CertificateException { return chain.length == 1; } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/TlsSocketStrategy.java0100664 0000000 0000000 00000004314 14704162040 026534 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.io.IOException; import java.net.Socket; import javax.net.ssl.SSLSocket; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * TLS protocol upgrade strategy for blocking {@link Socket}s. * * @since 5.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface TlsSocketStrategy { /** * Upgrades the given plain socket and executes the TLS handshake over it. * * @param socket the existing plain socket * @param target the name of the target host. * @param port the port to connect to on the target host. * @param context the actual HTTP context. * @param attachment connect request attachment. * @return socket upgraded to TLS. */ SSLSocket upgrade( Socket socket, String target, int port, Object attachment, HttpContext context) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/SSLConnectionSocketFactory.java0100664 0000000 0000000 00000046057 15022276336 030302 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.io.IOException; import java.io.InputStream; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.Socket; import java.net.SocketAddress; import java.security.AccessController; import java.security.PrivilegedActionException; import java.security.PrivilegedExceptionAction; import java.security.cert.Certificate; import java.security.cert.X509Certificate; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.List; import java.util.Objects; import java.util.regex.Pattern; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLException; import javax.net.ssl.SSLHandshakeException; import javax.net.ssl.SSLPeerUnverifiedException; import javax.net.ssl.SSLSession; import javax.net.ssl.SSLSocket; import javax.security.auth.x500.X500Principal; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.http.ssl.TlsCiphers; import org.apache.hc.core5.io.Closer; import org.apache.hc.core5.ssl.SSLContexts; import org.apache.hc.core5.ssl.SSLInitializationException; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Layered socket factory for TLS/SSL connections. *

* SSLSocketFactory can be used to validate the identity of the HTTPS server against a list of * trusted certificates and to authenticate to the HTTPS server using a private key. * * @deprecated Use {@link DefaultClientTlsStrategy}. */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public class SSLConnectionSocketFactory implements org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory { private static final String WEAK_KEY_EXCHANGES = "^(TLS|SSL)_(NULL|ECDH_anon|DH_anon|DH_anon_EXPORT|DHE_RSA_EXPORT|DHE_DSS_EXPORT|" + "DSS_EXPORT|DH_DSS_EXPORT|DH_RSA_EXPORT|RSA_EXPORT|KRB5_EXPORT)_(.*)"; private static final String WEAK_CIPHERS = "^(TLS|SSL)_(.*)_WITH_(NULL|DES_CBC|DES40_CBC|DES_CBC_40|3DES_EDE_CBC|RC4_128|RC4_40|RC2_CBC_40)_(.*)"; private static final List WEAK_CIPHER_SUITE_PATTERNS = Collections.unmodifiableList(Arrays.asList( Pattern.compile(WEAK_KEY_EXCHANGES, Pattern.CASE_INSENSITIVE), Pattern.compile(WEAK_CIPHERS, Pattern.CASE_INSENSITIVE))); private static final Logger LOG = LoggerFactory.getLogger(SSLConnectionSocketFactory.class); /** * Obtains default SSL socket factory with an SSL context based on the standard JSSE * trust material ({@code cacerts} file in the security properties directory). * System properties are not taken into consideration. * * @return default SSL socket factory */ public static SSLConnectionSocketFactory getSocketFactory() throws SSLInitializationException { return new SSLConnectionSocketFactory(SSLContexts.createDefault(), HttpsSupport.getDefaultHostnameVerifier()); } /** * Obtains default SSL socket factory with an SSL context based on system properties * as described in * * Java™ Secure Socket Extension (JSSE) Reference Guide. * * @return default system SSL socket factory */ public static SSLConnectionSocketFactory getSystemSocketFactory() throws SSLInitializationException { return new SSLConnectionSocketFactory( (javax.net.ssl.SSLSocketFactory) javax.net.ssl.SSLSocketFactory.getDefault(), HttpsSupport.getSystemProtocols(), HttpsSupport.getSystemCipherSuits(), HttpsSupport.getDefaultHostnameVerifier()); } static boolean isWeakCipherSuite(final String cipherSuite) { for (final Pattern pattern : WEAK_CIPHER_SUITE_PATTERNS) { if (pattern.matcher(cipherSuite).matches()) { return true; } } return false; } private final javax.net.ssl.SSLSocketFactory socketFactory; private final HostnameVerifier hostnameVerifier; private final String[] supportedProtocols; private final String[] supportedCipherSuites; public SSLConnectionSocketFactory(final SSLContext sslContext) { this(sslContext, HttpsSupport.getDefaultHostnameVerifier()); } /** * @since 4.4 */ public SSLConnectionSocketFactory( final SSLContext sslContext, final HostnameVerifier hostnameVerifier) { this(Args.notNull(sslContext, "SSL context").getSocketFactory(), null, null, hostnameVerifier); } /** * @since 4.4 */ public SSLConnectionSocketFactory( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final HostnameVerifier hostnameVerifier) { this(Args.notNull(sslContext, "SSL context").getSocketFactory(), supportedProtocols, supportedCipherSuites, hostnameVerifier); } /** * @since 4.4 */ public SSLConnectionSocketFactory( final javax.net.ssl.SSLSocketFactory socketFactory, final HostnameVerifier hostnameVerifier) { this(socketFactory, null, null, hostnameVerifier); } /** * @since 4.4 */ public SSLConnectionSocketFactory( final javax.net.ssl.SSLSocketFactory socketFactory, final String[] supportedProtocols, final String[] supportedCipherSuites, final HostnameVerifier hostnameVerifier) { this.socketFactory = Args.notNull(socketFactory, "SSL socket factory"); this.supportedProtocols = supportedProtocols; this.supportedCipherSuites = supportedCipherSuites; this.hostnameVerifier = hostnameVerifier != null ? hostnameVerifier : HttpsSupport.getDefaultHostnameVerifier(); } /** * @deprecated Use {@link #prepareSocket(SSLSocket, HttpContext)} */ @Deprecated protected void prepareSocket(final SSLSocket socket) throws IOException { } /** * Performs any custom initialization for a newly created SSLSocket * (before the SSL handshake happens). * * The default implementation is a no-op, but could be overridden to, e.g., * call {@link javax.net.ssl.SSLSocket#setEnabledCipherSuites(String[])}. * @throws IOException may be thrown if overridden */ @SuppressWarnings("deprecation") protected void prepareSocket(final SSLSocket socket, final HttpContext context) throws IOException { prepareSocket(socket); } @Override public Socket createSocket(final HttpContext context) throws IOException { return new Socket(); } @Override public Socket createSocket(final Proxy proxy, final HttpContext context) throws IOException { return proxy != null ? new Socket(proxy) : createSocket(context); } @Override public Socket connectSocket( final TimeValue connectTimeout, final Socket socket, final HttpHost host, final InetSocketAddress remoteAddress, final InetSocketAddress localAddress, final HttpContext context) throws IOException { final Timeout timeout = connectTimeout != null ? Timeout.of(connectTimeout.getDuration(), connectTimeout.getTimeUnit()) : null; return connectSocket(socket, host, remoteAddress, localAddress, timeout, timeout, context); } @Override public Socket connectSocket( final Socket socket, final HttpHost host, final InetSocketAddress remoteAddress, final InetSocketAddress localAddress, final Timeout connectTimeout, final Object attachment, final HttpContext context) throws IOException { Args.notNull(host, "HTTP host"); Args.notNull(remoteAddress, "Remote address"); final Socket sock = socket != null ? socket : createSocket(context); if (localAddress != null) { sock.bind(localAddress); } try { connectSocket(sock, remoteAddress, connectTimeout, context); } catch (final IOException ex) { Closer.closeQuietly(sock); throw ex; } // Setup SSL layering if necessary if (sock instanceof SSLSocket) { final SSLSocket sslsock = (SSLSocket) sock; executeHandshake(sslsock, host.getHostName(), attachment, context); return sock; } return createLayeredSocket(sock, host.getHostName(), remoteAddress.getPort(), attachment, context); } /** * Connects the socket to the target host with the given resolved remote address using * {@link Socket#connect(SocketAddress, int)}. This method may be overridden to customize * how precisely {@link Socket#connect(SocketAddress, int)} is handled without impacting * other connection establishment code within {@link #executeHandshake(SSLSocket, String, Object, HttpContext)}, * for example. * * @param sock the socket to connect. * @param remoteAddress the resolved remote address to connect to. * @param connectTimeout connect timeout. * @param context the actual HTTP context. * @throws IOException if an I/O error occurs */ protected void connectSocket( final Socket sock, final InetSocketAddress remoteAddress, final Timeout connectTimeout, final HttpContext context) throws IOException { Args.notNull(sock, "Socket"); Args.notNull(remoteAddress, "Remote address"); if (LOG.isDebugEnabled()) { LOG.debug("Connecting socket to {} with timeout {}", remoteAddress, connectTimeout); } // Run this under a doPrivileged to support lib users that run under a SecurityManager this allows granting connect permissions // only to this library try { AccessController.doPrivileged((PrivilegedExceptionAction) () -> { sock.connect(remoteAddress, Timeout.defaultsToDisabled(connectTimeout).toMillisecondsIntBound()); return null; }); } catch (final PrivilegedActionException e) { Asserts.check(e.getCause() instanceof IOException, "method contract violation only checked exceptions are wrapped: " + e.getCause()); // only checked exceptions are wrapped - error and RTExceptions are rethrown by doPrivileged throw (IOException) e.getCause(); } } @Override public Socket createLayeredSocket( final Socket socket, final String target, final int port, final HttpContext context) throws IOException { return createLayeredSocket(socket, target, port, null, context); } @Override public Socket createLayeredSocket( final Socket socket, final String target, final int port, final Object attachment, final HttpContext context) throws IOException { final SSLSocket sslsock = (SSLSocket) this.socketFactory.createSocket( socket, target, port, true); executeHandshake(sslsock, target, attachment, context); return sslsock; } private void executeHandshake( final SSLSocket sslsock, final String target, final Object attachment, final HttpContext context) throws IOException { final TlsConfig tlsConfig = attachment instanceof TlsConfig ? (TlsConfig) attachment : TlsConfig.DEFAULT; if (supportedProtocols != null) { sslsock.setEnabledProtocols(supportedProtocols); } else { sslsock.setEnabledProtocols(TLS.excludeWeak(sslsock.getEnabledProtocols())); } if (supportedCipherSuites != null) { sslsock.setEnabledCipherSuites(supportedCipherSuites); } else { sslsock.setEnabledCipherSuites(TlsCiphers.excludeWeak(sslsock.getEnabledCipherSuites())); } final Timeout handshakeTimeout = tlsConfig.getHandshakeTimeout(); if (handshakeTimeout != null) { sslsock.setSoTimeout(handshakeTimeout.toMillisecondsIntBound()); } prepareSocket(sslsock, context); if (LOG.isDebugEnabled()) { LOG.debug("Enabled protocols: {}", (Object) sslsock.getEnabledProtocols()); LOG.debug("Enabled cipher suites: {}", (Object) sslsock.getEnabledCipherSuites()); LOG.debug("Starting handshake ({})", handshakeTimeout); } sslsock.startHandshake(); verifyHostname(sslsock, target); } private void verifyHostname(final SSLSocket sslsock, final String hostname) throws IOException { try { SSLSession session = sslsock.getSession(); if (session == null) { // In our experience this only happens under IBM 1.4.x when // spurious (unrelated) certificates show up in the server' // chain. Hopefully this will unearth the real problem: final InputStream in = sslsock.getInputStream(); in.available(); // If ssl.getInputStream().available() didn't cause an // exception, maybe at least now the session is available? session = sslsock.getSession(); if (session == null) { // If it's still null, probably a startHandshake() will // unearth the real problem. sslsock.startHandshake(); session = sslsock.getSession(); } } if (session == null) { throw new SSLHandshakeException("SSL session not available"); } verifySession(hostname, session); } catch (final IOException iox) { // close the socket before re-throwing the exception Closer.closeQuietly(sslsock); throw iox; } } protected void verifySession( final String hostname, final SSLSession sslSession) throws SSLException { verifySession(hostname, sslSession, hostnameVerifier); } void verifySession( final String hostname, final SSLSession sslsession, final HostnameVerifier hostnameVerifier) throws SSLException { if (LOG.isDebugEnabled()) { LOG.debug("Secure session established"); LOG.debug(" negotiated protocol: {}", sslsession.getProtocol()); LOG.debug(" negotiated cipher suite: {}", sslsession.getCipherSuite()); try { final Certificate[] certs = sslsession.getPeerCertificates(); final Certificate cert = certs[0]; if (cert instanceof X509Certificate) { final X509Certificate x509 = (X509Certificate) cert; final X500Principal peer = x509.getSubjectX500Principal(); LOG.debug(" peer principal: {}", peer); final Collection> altNames1 = x509.getSubjectAlternativeNames(); if (altNames1 != null) { final List altNames = new ArrayList<>(); for (final List aC : altNames1) { if (!aC.isEmpty()) { altNames.add(Objects.toString(aC.get(1), null)); } } LOG.debug(" peer alternative names: {}", altNames); } final X500Principal issuer = x509.getIssuerX500Principal(); LOG.debug(" issuer principal: {}", issuer); final Collection> altNames2 = x509.getIssuerAlternativeNames(); if (altNames2 != null) { final List altNames = new ArrayList<>(); for (final List aC : altNames2) { if (!aC.isEmpty()) { altNames.add(Objects.toString(aC.get(1), null)); } } LOG.debug(" issuer alternative names: {}", altNames); } } } catch (final Exception ignore) { } } if (hostnameVerifier != null) { final Certificate[] certs = sslsession.getPeerCertificates(); if (certs.length < 1) { throw new SSLPeerUnverifiedException("Peer certificate chain is empty"); } final Certificate peerCertificate = certs[0]; final X509Certificate x509Certificate; if (peerCertificate instanceof X509Certificate) { x509Certificate = (X509Certificate) peerCertificate; } else { throw new SSLPeerUnverifiedException("Unexpected certificate type: " + peerCertificate.getType()); } if (hostnameVerifier instanceof HttpClientHostnameVerifier) { ((HttpClientHostnameVerifier) hostnameVerifier).verify(hostname, x509Certificate); } else if (!hostnameVerifier.verify(hostname, sslsession)) { final List subjectAlts = DefaultHostnameVerifier.getSubjectAltNames(x509Certificate); throw new SSLPeerUnverifiedException("Certificate for <" + hostname + "> doesn't match any " + "of the subject alternative names: " + subjectAlts); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/HostnameVerificationPolicy.java0100664 0000000 0000000 00000003347 14704162040 030404 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; /** * Hostname verification policy. * * @see javax.net.ssl.HostnameVerifier * @see DefaultHostnameVerifier * * @since 5.4 */ public enum HostnameVerificationPolicy { /** * Hostname verification is delegated to the JSSE provider, usually executed during the TLS handshake. */ BUILTIN, /** * Hostname verification is executed by HttpClient post TLS handshake. */ CLIENT, /** * Hostname verification is executed by the JSSE provider and by HttpClient post TLS handshake. */ BOTH } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/DefaultHostnameVerifier.java0100664 0000000 0000000 00000034766 15005672035 027700 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.net.InetAddress; import java.net.UnknownHostException; import java.security.cert.Certificate; import java.security.cert.CertificateParsingException; import java.security.cert.X509Certificate; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.LinkedList; import java.util.List; import javax.net.ssl.SSLException; import javax.net.ssl.SSLPeerUnverifiedException; import javax.net.ssl.SSLSession; import javax.security.auth.x500.X500Principal; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.apache.hc.client5.http.utils.DnsUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.net.InetAddressUtils; import org.apache.hc.core5.util.TextUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Default {@link javax.net.ssl.HostnameVerifier} implementation. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public final class DefaultHostnameVerifier implements HttpClientHostnameVerifier { enum HostNameType { IPv4(7), IPv6(7), DNS(2); final int subjectType; HostNameType(final int subjectType) { this.subjectType = subjectType; } } private static final Logger LOG = LoggerFactory.getLogger(DefaultHostnameVerifier.class); private final PublicSuffixMatcher publicSuffixMatcher; /** * Constructs new instance with a PublicSuffixMatcher. * * @param publicSuffixMatcher a PublicSuffixMatcher. */ public DefaultHostnameVerifier(final PublicSuffixMatcher publicSuffixMatcher) { this.publicSuffixMatcher = publicSuffixMatcher; } /** * Constructs new instance without a PublicSuffixMatcher. */ public DefaultHostnameVerifier() { this(null); } @Override public boolean verify(final String host, final SSLSession session) { try { final Certificate[] certs = session.getPeerCertificates(); final X509Certificate x509 = (X509Certificate) certs[0]; verify(host, x509); return true; } catch (final SSLException ex) { if (LOG.isDebugEnabled()) { LOG.debug(ex.getMessage(), ex); } return false; } } @Override public void verify(final String host, final X509Certificate cert) throws SSLException { final HostNameType hostType = determineHostFormat(host); switch (hostType) { case IPv4: matchIPAddress(host, getSubjectAltNames(cert, SubjectName.IP)); break; case IPv6: matchIPv6Address(host, getSubjectAltNames(cert, SubjectName.IP)); break; default: final List subjectAlts = getSubjectAltNames(cert, SubjectName.DNS); if (subjectAlts.isEmpty()) { // CN matching has been deprecated by rfc2818 and can be used // as fallback only when no subjectAlts of type SubjectName.DNS are available matchCN(host, cert, this.publicSuffixMatcher); } else { matchDNSName(host, subjectAlts, this.publicSuffixMatcher); } } } static void matchIPAddress(final String host, final List subjectAlts) throws SSLPeerUnverifiedException { for (final SubjectName subjectAlt : subjectAlts) { if (subjectAlt.getType() == SubjectName.IP) { if (host.equals(subjectAlt.getValue())) { return; } } } throw new SSLPeerUnverifiedException("Certificate for <" + host + "> doesn't match any " + "of the subject alternative names: " + subjectAlts); } static void matchIPv6Address(final String host, final List subjectAlts) throws SSLPeerUnverifiedException { final String normalisedHost = normaliseAddress(host); for (final SubjectName subjectAlt : subjectAlts) { if (subjectAlt.getType() == SubjectName.IP) { final String normalizedSubjectAlt = normaliseAddress(subjectAlt.getValue()); if (normalisedHost.equals(normalizedSubjectAlt)) { return; } } } throw new SSLPeerUnverifiedException("Certificate for <" + host + "> doesn't match any " + "of the subject alternative names: " + subjectAlts); } static void matchDNSName(final String host, final List subjectAlts, final PublicSuffixMatcher publicSuffixMatcher) throws SSLPeerUnverifiedException { final String normalizedHost = DnsUtils.normalizeUnicode(host); for (final SubjectName subjectAlt : subjectAlts) { if (subjectAlt.getType() == SubjectName.DNS) { final String normalizedSubjectAlt = DnsUtils.normalizeUnicode(subjectAlt.getValue()); if (matchIdentity(normalizedHost, normalizedSubjectAlt, publicSuffixMatcher, true)) { return; } } } throw new SSLPeerUnverifiedException("Certificate for <" + host + "> doesn't match any " + "of the subject alternative names: " + subjectAlts); } static void matchCN(final String host, final X509Certificate cert, final PublicSuffixMatcher publicSuffixMatcher) throws SSLException { final X500Principal subjectPrincipal = cert.getSubjectX500Principal(); final String cn = extractCN(subjectPrincipal.getName(X500Principal.RFC2253)); if (cn == null) { throw new SSLPeerUnverifiedException("Certificate subject for <" + host + "> doesn't contain " + "a common name and does not have alternative names"); } final String normalizedHost = DnsUtils.normalizeUnicode(host); final String normalizedCn = DnsUtils.normalizeUnicode(cn); if (!matchIdentity(normalizedHost, normalizedCn, publicSuffixMatcher, true)) { throw new SSLPeerUnverifiedException("Certificate for <" + host + "> doesn't match " + "common name of the certificate subject: " + cn); } } static List parseFQDN(final CharSequence s) { if (s == null) { return null; } final LinkedList elements = new LinkedList<>(); int pos = 0; for (int i = 0; i < s.length(); i++) { final char ch = s.charAt(i); if (ch == '.') { elements.addFirst(s.subSequence(pos, i)); pos = i + 1; } } elements.addFirst(s.subSequence(pos, s.length())); return elements; } static boolean matchDomainRoot(final String host, final String domainRoot) { if (domainRoot == null) { return false; } final List hostElements = parseFQDN(host); final List rootElements = parseFQDN(domainRoot); if (hostElements.size() >= rootElements.size()) { for (int i = 0; i < rootElements.size(); i++) { final CharSequence s1 = rootElements.get(i); final CharSequence s2 = hostElements.get(i); if (!s1.equals(s2)) { return false; } } return true; } return false; } static boolean matchIdentity(final String host, final String identity, final PublicSuffixMatcher publicSuffixMatcher, final boolean strict) { if (publicSuffixMatcher != null && host.contains(".")) { if (!publicSuffixMatcher.verifyInternal(identity)) { if (LOG.isDebugEnabled()) { LOG.debug("Public Suffix List verification failed for identity '{}'", identity); } return false; } } // RFC 2818, 3.1. Server Identity // "...Names may contain the wildcard // character * which is considered to match any single domain name // component or component fragment..." // Based on this statement presuming only singular wildcard is legal final int asteriskIdx = identity.indexOf('*'); if (asteriskIdx != -1) { final String prefix = identity.substring(0, asteriskIdx); final String suffix = identity.substring(asteriskIdx + 1); if (!prefix.isEmpty() && !host.startsWith(prefix)) { return false; } if (!suffix.isEmpty() && !host.endsWith(suffix)) { return false; } // Additional sanity checks on content selected by wildcard can be done here if (strict) { final String remainder = host.substring( prefix.length(), host.length() - suffix.length() ); return !remainder.contains("."); } return true; } // Direct Unicode comparison return host.equalsIgnoreCase(identity); } static String extractCN(final String subjectPrincipal) throws SSLException { if (subjectPrincipal == null) { return null; } final List attributes = DistinguishedNameParser.INSTANCE.parse(subjectPrincipal); for (final NameValuePair attribute: attributes) { if (TextUtils.isBlank(attribute.getName()) || attribute.getValue() == null) { throw new SSLException(subjectPrincipal + " is not a valid X500 distinguished name"); } if (attribute.getName().equalsIgnoreCase("cn")) { return attribute.getValue(); } } return null; } static HostNameType determineHostFormat(final String host) { if (InetAddressUtils.isIPv4(host)) { return HostNameType.IPv4; } String s = host; if (s.startsWith("[") && s.endsWith("]")) { s = host.substring(1, host.length() - 1); } if (InetAddressUtils.isIPv6(s)) { return HostNameType.IPv6; } return HostNameType.DNS; } static List getSubjectAltNames(final X509Certificate cert) { return getSubjectAltNames(cert, -1); } static List getSubjectAltNames(final X509Certificate cert, final int subjectName) { try { final Collection> entries = cert.getSubjectAlternativeNames(); if (entries == null) { return Collections.emptyList(); } final List result = new ArrayList<>(); for (final List entry : entries) { final Integer type = entry.size() >= 2 ? (Integer) entry.get(0) : null; if (type != null) { if (type == subjectName || -1 == subjectName) { final Object o = entry.get(1); if (o instanceof String) { result.add(new SubjectName((String) o, type)); } else if (o instanceof byte[]) { final byte[] bytes = (byte[]) o; if (type == SubjectName.IP) { if (bytes.length == 4) { result.add(new SubjectName(byteArrayToIp(bytes), type)); // IPv4 } else if (bytes.length == 16) { result.add(new SubjectName(byteArrayToIPv6(bytes), type)); // IPv6 } } } } } } return result; } catch (final CertificateParsingException ignore) { return Collections.emptyList(); } } /* * Normalize IPv6 or DNS name. */ static String normaliseAddress(final String hostname) { if (hostname == null) { return hostname; } try { final InetAddress inetAddress = InetAddress.getByName(hostname); return inetAddress.getHostAddress(); } catch (final UnknownHostException unexpected) { // Should not happen, because we check for IPv6 address above return hostname; } } private static String byteArrayToIp(final byte[] bytes) { if (bytes.length != 4) { throw new IllegalArgumentException("Invalid byte array length for IPv4 address"); } return (bytes[0] & 0xFF) + "." + (bytes[1] & 0xFF) + "." + (bytes[2] & 0xFF) + "." + (bytes[3] & 0xFF); } private static String byteArrayToIPv6(final byte[] bytes) { if (bytes.length != 16) { throw new IllegalArgumentException("Invalid byte array length for IPv6 address"); } final StringBuilder sb = new StringBuilder(); for (int i = 0; i < bytes.length; i += 2) { sb.append(String.format("%02x%02x", bytes[i], bytes[i + 1])); if (i < bytes.length - 2) { sb.append(":"); } } return sb.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/DistinguishedNameParser.java0100664 0000000 0000000 00000011611 15005672016 027661 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.util.ArrayList; import java.util.List; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.Tokenizer; final class DistinguishedNameParser { /** * Default instance of {@link DistinguishedNameParser}. */ public final static DistinguishedNameParser INSTANCE = new DistinguishedNameParser(); private static final Tokenizer.Delimiter EQUAL_OR_COMMA_OR_PLUS = Tokenizer.delimiters('=', ',', '+'); private static final Tokenizer.Delimiter COMMA_OR_PLUS = Tokenizer.delimiters(',', '+'); private final Tokenizer tokenParser = new InternalTokenParser(); private DistinguishedNameParser() { // empty } private String parseToken(final CharArrayBuffer buf, final Tokenizer.Cursor cursor, final Tokenizer.Delimiter delimiters) { return tokenParser.parseToken(buf, cursor, delimiters); } private String parseValue(final CharArrayBuffer buf, final Tokenizer.Cursor cursor, final Tokenizer.Delimiter delimiters) { return tokenParser.parseValue(buf, cursor, delimiters); } private NameValuePair parseParameter(final CharArrayBuffer buf, final Tokenizer.Cursor cursor) { final String name = parseToken(buf, cursor, EQUAL_OR_COMMA_OR_PLUS); if (cursor.atEnd()) { return new BasicNameValuePair(name, null); } final int delim = buf.charAt(cursor.getPos()); cursor.updatePos(cursor.getPos() + 1); if (delim == ',') { return new BasicNameValuePair(name, null); } final String value = parseValue(buf, cursor, COMMA_OR_PLUS); if (!cursor.atEnd()) { cursor.updatePos(cursor.getPos() + 1); } return new BasicNameValuePair(name, value); } List parse(final CharArrayBuffer buf, final Tokenizer.Cursor cursor) { final List params = new ArrayList<>(); tokenParser.skipWhiteSpace(buf, cursor); while (!cursor.atEnd()) { final NameValuePair param = parseParameter(buf, cursor); params.add(param); } return params; } List parse(final String s) { if (s == null) { return null; } final CharArrayBuffer buffer = new CharArrayBuffer(s.length()); buffer.append(s); final Tokenizer.Cursor cursor = new Tokenizer.Cursor(0, s.length()); return parse(buffer, cursor); } static class InternalTokenParser extends Tokenizer { @Override public void copyUnquotedContent( final CharSequence buf, final Tokenizer.Cursor cursor, final Tokenizer.Delimiter delimiters, final StringBuilder dst) { int pos = cursor.getPos(); final int indexFrom = cursor.getPos(); final int indexTo = cursor.getUpperBound(); boolean escaped = false; for (int i = indexFrom; i < indexTo; i++, pos++) { final char current = buf.charAt(i); if (escaped) { dst.append(current); escaped = false; } else { if (delimiters != null && delimiters.test(current) || Tokenizer.isWhitespace(current) || current == '\"') { break; } else if (current == '\\') { escaped = true; } else { dst.append(current); } } } cursor.updatePos(pos); } } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/SSLConnectionSocketFactoryBuilder.java0100664 0000000 0000000 00000012745 14704162040 031576 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.ssl.SSLContexts; /** * Builder for {@link SSLConnectionSocketFactory} instances. *

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

*
    *
  • ssl.TrustManagerFactory.algorithm
    • *
  • javax.net.ssl.trustStoreType
    • *
  • javax.net.ssl.trustStore
    • *
  • javax.net.ssl.trustStoreProvider
    • *
  • javax.net.ssl.trustStorePassword
    • *
  • ssl.KeyManagerFactory.algorithm
    • *
  • javax.net.ssl.keyStoreType
    • *
  • javax.net.ssl.keyStore
    • *
  • javax.net.ssl.keyStoreProvider
    • *
  • javax.net.ssl.keyStorePassword
    • *
  • https.protocols
    • *
  • https.cipherSuites
    • *
* * @deprecated Use {@link DefaultClientTlsStrategy} */ @Deprecated public class SSLConnectionSocketFactoryBuilder { public static SSLConnectionSocketFactoryBuilder create() { return new SSLConnectionSocketFactoryBuilder(); } private SSLContext sslContext; private String[] tlsVersions; private String[] ciphers; private HostnameVerifier hostnameVerifier; private boolean systemProperties; /** * Sets {@link SSLContext} instance. * * @return this instance. */ public SSLConnectionSocketFactoryBuilder setSslContext(final SSLContext sslContext) { this.sslContext = sslContext; return this; } /** * Sets enabled {@code TLS} versions. * * @return this instance. */ public final SSLConnectionSocketFactoryBuilder setTlsVersions(final String... tlslVersions) { this.tlsVersions = tlslVersions; return this; } /** * Sets enabled {@code TLS} versions. * * @return this instance. */ public final SSLConnectionSocketFactoryBuilder setTlsVersions(final TLS... tlslVersions) { this.tlsVersions = new String[tlslVersions.length]; for (int i = 0; i < tlslVersions.length; i++) { this.tlsVersions[i] = tlslVersions[i].id; } return this; } /** * Sets enabled ciphers. * * @return this instance. */ public final SSLConnectionSocketFactoryBuilder setCiphers(final String... ciphers) { this.ciphers = ciphers; return this; } /** * Sets {@link HostnameVerifier} instance. * * @return this instance. */ public SSLConnectionSocketFactoryBuilder setHostnameVerifier(final HostnameVerifier hostnameVerifier) { this.hostnameVerifier = hostnameVerifier; return this; } /** * Use system properties when creating and configuring default * implementations. * * @return this instance. */ public final SSLConnectionSocketFactoryBuilder useSystemProperties() { this.systemProperties = true; return this; } public SSLConnectionSocketFactory build() { final javax.net.ssl.SSLSocketFactory socketFactory; if (sslContext != null) { socketFactory = sslContext.getSocketFactory(); } else { if (systemProperties) { socketFactory = (javax.net.ssl.SSLSocketFactory) javax.net.ssl.SSLSocketFactory.getDefault(); } else { socketFactory = SSLContexts.createDefault().getSocketFactory(); } } final String[] tlsVersionsCopy; if (tlsVersions != null) { tlsVersionsCopy = tlsVersions; } else { tlsVersionsCopy = systemProperties ? HttpsSupport.getSystemProtocols() : null; } final String[] ciphersCopy; if (ciphers != null) { ciphersCopy = ciphers; } else { ciphersCopy = systemProperties ? HttpsSupport.getSystemCipherSuits() : null; } return new SSLConnectionSocketFactory( socketFactory, tlsVersionsCopy, ciphersCopy, hostnameVerifier != null ? hostnameVerifier : HttpsSupport.getDefaultHostnameVerifier()); } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/HttpClientHostnameVerifier.java0100664 0000000 0000000 00000003631 14666635064 030372 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.security.cert.X509Certificate; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Extended {@link HostnameVerifier} interface. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface HttpClientHostnameVerifier extends HostnameVerifier { /** * Verifies the supplied server {@link X509Certificate} and ensures it matches * the original host name. * * @param host the original host name. * @param cert the server certificate; */ void verify(String host, X509Certificate cert) throws SSLException; } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/DefaultClientTlsStrategy.java0100664 0000000 0000000 00000013624 15063503632 030040 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLEngine; import javax.net.ssl.SSLParameters; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.function.Factory; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.reactor.ssl.SSLBufferMode; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.ssl.SSLContexts; /** * TLS upgrade strategy for non-blocking client connections. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultClientTlsStrategy extends AbstractClientTlsStrategy { /** * @since 5.4 */ public static DefaultClientTlsStrategy createDefault() { return new DefaultClientTlsStrategy( SSLContexts.createDefault(), HostnameVerificationPolicy.BOTH, HttpsSupport.getDefaultHostnameVerifier()); } /** * @since 5.4 */ public static DefaultClientTlsStrategy createSystemDefault() { return new DefaultClientTlsStrategy( SSLContexts.createSystemDefault(), HttpsSupport.getSystemProtocols(), HttpsSupport.getSystemCipherSuits(), SSLBufferMode.STATIC, HostnameVerificationPolicy.BOTH, HttpsSupport.getDefaultHostnameVerifier()); } /** * @deprecated Use {@link #createDefault()}. */ @Deprecated public static TlsStrategy getDefault() { return createDefault(); } /** * @deprecated Use {@link #createSystemDefault()}. */ @Deprecated public static TlsStrategy getSystemDefault() { return createSystemDefault(); } /** * @deprecated To be removed. */ @Deprecated private Factory tlsDetailsFactory; /** * @deprecated Use {@link DefaultClientTlsStrategy#DefaultClientTlsStrategy(SSLContext, String[], String[], SSLBufferMode, HostnameVerifier)} */ @Deprecated public DefaultClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerifier hostnameVerifier, final Factory tlsDetailsFactory) { super(sslContext, supportedProtocols, supportedCipherSuites, sslBufferManagement, HostnameVerificationPolicy.CLIENT, hostnameVerifier); this.tlsDetailsFactory = tlsDetailsFactory; } /** * @since 5.4 */ public DefaultClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerificationPolicy hostnameVerificationPolicy, final HostnameVerifier hostnameVerifier) { super(sslContext, supportedProtocols, supportedCipherSuites, sslBufferManagement, hostnameVerificationPolicy, hostnameVerifier); } public DefaultClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerifier hostnameVerifier) { this(sslContext, supportedProtocols, supportedCipherSuites, sslBufferManagement, HostnameVerificationPolicy.CLIENT, hostnameVerifier); } public DefaultClientTlsStrategy( final SSLContext sslContext, final HostnameVerifier hostnameVerifier) { this(sslContext, null, null, SSLBufferMode.STATIC, hostnameVerifier); } /** * @since 5.4 */ public DefaultClientTlsStrategy( final SSLContext sslContext, final HostnameVerificationPolicy hostnameVerificationPolicy, final HostnameVerifier hostnameVerifier) { this(sslContext, null, null, SSLBufferMode.STATIC, hostnameVerificationPolicy, hostnameVerifier); } public DefaultClientTlsStrategy(final SSLContext sslContext) { this(sslContext, HttpsSupport.getDefaultHostnameVerifier()); } @Override void applyParameters(final SSLEngine sslEngine, final SSLParameters sslParameters, final String[] appProtocols) { sslParameters.setApplicationProtocols(appProtocols); sslEngine.setSSLParameters(sslParameters); } @Override @SuppressWarnings("deprecated") TlsDetails createTlsDetails(final SSLEngine sslEngine) { return tlsDetailsFactory != null ? tlsDetailsFactory.create(sslEngine) : null; } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/ClientTlsStrategyBuilder.java0100664 0000000 0000000 00000017411 15063503632 030040 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLEngine; import org.apache.hc.core5.function.Factory; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.reactor.ssl.SSLBufferMode; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.ssl.SSLContexts; /** * Builder for client TLS strategy instances. *

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

*
    *
  • ssl.TrustManagerFactory.algorithm
    • *
  • javax.net.ssl.trustStoreType
    • *
  • javax.net.ssl.trustStore
    • *
  • javax.net.ssl.trustStoreProvider
    • *
  • javax.net.ssl.trustStorePassword
    • *
  • ssl.KeyManagerFactory.algorithm
    • *
  • javax.net.ssl.keyStoreType
    • *
  • javax.net.ssl.keyStore
    • *
  • javax.net.ssl.keyStoreProvider
    • *
  • javax.net.ssl.keyStorePassword
    • *
  • https.protocols
    • *
  • https.cipherSuites
    • *
* * @since 5.0 */ public class ClientTlsStrategyBuilder { public static ClientTlsStrategyBuilder create() { return new ClientTlsStrategyBuilder(); } private SSLContext sslContext; private String[] tlsVersions; private String[] ciphers; private SSLBufferMode sslBufferMode; private HostnameVerificationPolicy hostnameVerificationPolicy; private HostnameVerifier hostnameVerifier; private boolean systemProperties; /** * Sets {@link SSLContext} instance. * * @return this instance. */ public ClientTlsStrategyBuilder setSslContext(final SSLContext sslContext) { this.sslContext = sslContext; return this; } /** * Sets enabled {@code TLS} versions. * * @return this instance. */ public final ClientTlsStrategyBuilder setTlsVersions(final String... tlslVersions) { this.tlsVersions = tlslVersions; return this; } /** * Sets enabled {@code TLS} versions. * * @return this instance. */ public final ClientTlsStrategyBuilder setTlsVersions(final TLS... tlslVersions) { this.tlsVersions = new String[tlslVersions.length]; for (int i = 0; i < tlslVersions.length; i++) { this.tlsVersions[i] = tlslVersions[i].id; } return this; } /** * Sets enabled ciphers. * * @return this instance. */ public final ClientTlsStrategyBuilder setCiphers(final String... ciphers) { this.ciphers = ciphers; return this; } /** * Sets {@link SSLBufferMode} value. * * @return this instance. */ public ClientTlsStrategyBuilder setSslBufferMode(final SSLBufferMode sslBufferMode) { this.sslBufferMode = sslBufferMode; return this; } /** * Sets {@link HostnameVerificationPolicy} value. * * @deprecated Use #setHostVerificationPolicy */ @Deprecated public void setHostnameVerificationPolicy(final HostnameVerificationPolicy hostnameVerificationPolicy) { this.hostnameVerificationPolicy = hostnameVerificationPolicy; } /** * Sets {@link HostnameVerificationPolicy} value. * * @since 5.5 */ public ClientTlsStrategyBuilder setHostVerificationPolicy(final HostnameVerificationPolicy hostnameVerificationPolicy) { this.hostnameVerificationPolicy = hostnameVerificationPolicy; return this; } /** * Sets {@link HostnameVerifier} instance. * * @return this instance. */ public ClientTlsStrategyBuilder setHostnameVerifier(final HostnameVerifier hostnameVerifier) { this.hostnameVerifier = hostnameVerifier; return this; } /** * Sets {@link TlsDetails} {@link Factory} instance. * * @return this instance. * @deprecated Do not use. This method has no effect. */ @Deprecated public ClientTlsStrategyBuilder setTlsDetailsFactory(final Factory tlsDetailsFactory) { return this; } /** * Use system properties when creating and configuring default * implementations. * * @return this instance. */ public final ClientTlsStrategyBuilder useSystemProperties() { this.systemProperties = true; return this; } /** * @deprecated Use {@link #buildAsync()} or {@link #buildClassic()}. */ @Deprecated public TlsStrategy build() { return buildImpl(); } /** * @since 5.5 */ public TlsStrategy buildAsync() { return buildImpl(); } /** * @since 5.5 */ public TlsSocketStrategy buildClassic() { return buildImpl(); } private DefaultClientTlsStrategy buildImpl() { final SSLContext sslContextCopy; if (sslContext != null) { sslContextCopy = sslContext; } else { sslContextCopy = systemProperties ? SSLContexts.createSystemDefault() : SSLContexts.createDefault(); } final String[] tlsVersionsCopy; if (tlsVersions != null) { tlsVersionsCopy = tlsVersions; } else { tlsVersionsCopy = systemProperties ? HttpsSupport.getSystemProtocols() : null; } final String[] ciphersCopy; if (ciphers != null) { ciphersCopy = ciphers; } else { ciphersCopy = systemProperties ? HttpsSupport.getSystemCipherSuits() : null; } final HostnameVerificationPolicy hostnameVerificationPolicyCopy = hostnameVerificationPolicy != null ? hostnameVerificationPolicy : (hostnameVerifier == null ? HostnameVerificationPolicy.BUILTIN : HostnameVerificationPolicy.BOTH); final HostnameVerifier hostnameVerifierCopy = hostnameVerifier != null ? hostnameVerifier : (hostnameVerificationPolicyCopy == HostnameVerificationPolicy.CLIENT || hostnameVerificationPolicyCopy == HostnameVerificationPolicy.BOTH ? HttpsSupport.getDefaultHostnameVerifier() : NoopHostnameVerifier.INSTANCE); return new DefaultClientTlsStrategy( sslContextCopy, tlsVersionsCopy, ciphersCopy, sslBufferMode != null ? sslBufferMode : SSLBufferMode.STATIC, hostnameVerificationPolicyCopy, hostnameVerifierCopy); } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/HttpsSupport.java0100664 0000000 0000000 00000004340 14666635064 025616 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.security.AccessController; import java.security.PrivilegedAction; import javax.net.ssl.HostnameVerifier; import org.apache.hc.client5.http.psl.PublicSuffixMatcherLoader; import org.apache.hc.core5.util.TextUtils; /** * HTTPS configuration support methods. * * @since 5.0 */ public final class HttpsSupport { private static String[] split(final String s) { if (TextUtils.isBlank(s)) { return null; } return s.split(" *, *"); } private static String getProperty(final String key) { return AccessController.doPrivileged((PrivilegedAction) () -> System.getProperty(key)); } public static String[] getSystemProtocols() { return split(getProperty("https.protocols")); } public static String[] getSystemCipherSuits() { return split(getProperty("https.cipherSuites")); } public static HostnameVerifier getDefaultHostnameVerifier() { return new DefaultHostnameVerifier(PublicSuffixMatcherLoader.getDefault()); } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/AbstractClientTlsStrategy.java0100664 0000000 0000000 00000037247 15063503632 030226 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.io.IOException; import java.net.Socket; import java.net.SocketAddress; import java.security.cert.Certificate; import java.security.cert.X509Certificate; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.List; import java.util.Objects; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLEngine; import javax.net.ssl.SSLException; import javax.net.ssl.SSLHandshakeException; import javax.net.ssl.SSLParameters; import javax.net.ssl.SSLPeerUnverifiedException; import javax.net.ssl.SSLSession; import javax.net.ssl.SSLSocket; import javax.security.auth.x500.X500Principal; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.http.ssl.TlsCiphers; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.ssl.ApplicationProtocol; import org.apache.hc.core5.http2.ssl.H2TlsSupport; import org.apache.hc.core5.io.Closer; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.ssl.SSLBufferMode; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @Contract(threading = ThreadingBehavior.STATELESS) abstract class AbstractClientTlsStrategy implements TlsStrategy, TlsSocketStrategy { private static final Logger LOG = LoggerFactory.getLogger(AbstractClientTlsStrategy.class); private final SSLContext sslContext; private final String[] supportedProtocols; private final String[] supportedCipherSuites; private final SSLBufferMode sslBufferManagement; private final HostnameVerificationPolicy hostnameVerificationPolicy; private final HostnameVerifier hostnameVerifier; AbstractClientTlsStrategy( final SSLContext sslContext, final String[] supportedProtocols, final String[] supportedCipherSuites, final SSLBufferMode sslBufferManagement, final HostnameVerificationPolicy hostnameVerificationPolicy, final HostnameVerifier hostnameVerifier) { super(); this.sslContext = Args.notNull(sslContext, "SSL context"); this.supportedProtocols = supportedProtocols; this.supportedCipherSuites = supportedCipherSuites; this.sslBufferManagement = sslBufferManagement != null ? sslBufferManagement : SSLBufferMode.STATIC; this.hostnameVerificationPolicy = hostnameVerificationPolicy != null ? hostnameVerificationPolicy : HostnameVerificationPolicy.BOTH; this.hostnameVerifier = hostnameVerifier != null ? hostnameVerifier : (this.hostnameVerificationPolicy == HostnameVerificationPolicy.BUILTIN ? NoopHostnameVerifier.INSTANCE : HttpsSupport.getDefaultHostnameVerifier()); } /** * @deprecated use {@link #upgrade(TransportSecurityLayer, NamedEndpoint, Object, Timeout, FutureCallback)} */ @Deprecated @Override public boolean upgrade( final TransportSecurityLayer tlsSession, final HttpHost host, final SocketAddress localAddress, final SocketAddress remoteAddress, final Object attachment, final Timeout handshakeTimeout) { upgrade(tlsSession, host, attachment, handshakeTimeout, null); return true; } @Override public void upgrade( final TransportSecurityLayer tlsSession, final NamedEndpoint endpoint, final Object attachment, final Timeout handshakeTimeout, final FutureCallback callback) { tlsSession.startTls(sslContext, endpoint, sslBufferManagement, (e, sslEngine) -> { final TlsConfig tlsConfig = attachment instanceof TlsConfig ? (TlsConfig) attachment : TlsConfig.DEFAULT; final HttpVersionPolicy versionPolicy = tlsConfig.getHttpVersionPolicy(); final SSLParameters sslParameters = sslEngine.getSSLParameters(); final String[] supportedProtocols = tlsConfig.getSupportedProtocols(); if (supportedProtocols != null) { sslParameters.setProtocols(supportedProtocols); } else if (this.supportedProtocols != null) { sslParameters.setProtocols(this.supportedProtocols); } else if (versionPolicy != HttpVersionPolicy.FORCE_HTTP_1) { sslParameters.setProtocols(TLS.excludeWeak(sslParameters.getProtocols())); } final String[] supportedCipherSuites = tlsConfig.getSupportedCipherSuites(); if (supportedCipherSuites != null) { sslParameters.setCipherSuites(supportedCipherSuites); } else if (this.supportedCipherSuites != null) { sslParameters.setCipherSuites(this.supportedCipherSuites); } else if (versionPolicy == HttpVersionPolicy.FORCE_HTTP_2) { sslParameters.setCipherSuites(TlsCiphers.excludeH2Blacklisted(sslParameters.getCipherSuites())); } if (versionPolicy != HttpVersionPolicy.FORCE_HTTP_1) { H2TlsSupport.setEnableRetransmissions(sslParameters, false); } applyParameters(sslEngine, sslParameters, H2TlsSupport.selectApplicationProtocols(versionPolicy)); if (hostnameVerificationPolicy == HostnameVerificationPolicy.BUILTIN || hostnameVerificationPolicy == HostnameVerificationPolicy.BOTH) { sslParameters.setEndpointIdentificationAlgorithm(URIScheme.HTTPS.id); } initializeEngine(sslEngine); if (LOG.isDebugEnabled()) { LOG.debug("Enabled protocols: {}", Arrays.asList(sslEngine.getEnabledProtocols())); LOG.debug("Enabled cipher suites: {}", Arrays.asList(sslEngine.getEnabledCipherSuites())); LOG.debug("Starting handshake ({})", handshakeTimeout); } }, (e, sslEngine) -> { verifySession(endpoint.getHostName(), sslEngine.getSession()); final TlsDetails tlsDetails = createTlsDetails(sslEngine); final String negotiatedCipherSuite = sslEngine.getSession().getCipherSuite(); if (tlsDetails != null && ApplicationProtocol.HTTP_2.id.equals(tlsDetails.getApplicationProtocol())) { if (TlsCiphers.isH2Blacklisted(negotiatedCipherSuite)) { throw new SSLHandshakeException("Cipher suite `" + negotiatedCipherSuite + "` does not provide adequate security for HTTP/2"); } } return tlsDetails; }, handshakeTimeout, callback); } abstract void applyParameters(SSLEngine sslEngine, SSLParameters sslParameters, String[] appProtocols); abstract TlsDetails createTlsDetails(SSLEngine sslEngine); protected void initializeEngine(final SSLEngine sslEngine) { } protected void initializeSocket(final SSLSocket socket) { } protected void verifySession( final String hostname, final SSLSession sslsession) throws SSLException { verifySession(hostname, sslsession, hostnameVerificationPolicy == HostnameVerificationPolicy.CLIENT || hostnameVerificationPolicy == HostnameVerificationPolicy.BOTH ? hostnameVerifier : null); } @Override public SSLSocket upgrade(final Socket socket, final String target, final int port, final Object attachment, final HttpContext context) throws IOException { final SSLSocket upgradedSocket = (SSLSocket) sslContext.getSocketFactory().createSocket( socket, target, port, false); try { executeHandshake(upgradedSocket, target, attachment); return upgradedSocket; } catch (IOException | RuntimeException ex) { Closer.closeQuietly(upgradedSocket); throw ex; } } private void executeHandshake( final SSLSocket upgradedSocket, final String target, final Object attachment) throws IOException { final SSLParameters sslParameters = upgradedSocket.getSSLParameters(); if (supportedProtocols != null) { sslParameters.setProtocols(supportedProtocols); } else { sslParameters.setProtocols(TLS.excludeWeak(upgradedSocket.getEnabledProtocols())); } if (supportedCipherSuites != null) { sslParameters.setCipherSuites(supportedCipherSuites); } else { sslParameters.setCipherSuites(TlsCiphers.excludeWeak(upgradedSocket.getEnabledCipherSuites())); } if (hostnameVerificationPolicy == HostnameVerificationPolicy.BUILTIN || hostnameVerificationPolicy == HostnameVerificationPolicy.BOTH) { sslParameters.setEndpointIdentificationAlgorithm(URIScheme.HTTPS.id); } upgradedSocket.setSSLParameters(sslParameters); initializeSocket(upgradedSocket); if (LOG.isDebugEnabled()) { LOG.debug("Enabled protocols: {}", (Object) upgradedSocket.getEnabledProtocols()); LOG.debug("Enabled cipher suites: {}", (Object) upgradedSocket.getEnabledCipherSuites()); } upgradedSocket.startHandshake(); verifySession(target, upgradedSocket.getSession()); } void verifySession( final String hostname, final SSLSession sslsession, final HostnameVerifier hostnameVerifier) throws SSLException { if (LOG.isDebugEnabled()) { LOG.debug("Secure session established"); LOG.debug(" negotiated protocol: {}", sslsession.getProtocol()); LOG.debug(" negotiated cipher suite: {}", sslsession.getCipherSuite()); try { final Certificate[] certs = sslsession.getPeerCertificates(); final Certificate cert = certs[0]; if (cert instanceof X509Certificate) { final X509Certificate x509 = (X509Certificate) cert; final X500Principal peer = x509.getSubjectX500Principal(); LOG.debug("Peer principal: {}", toEscapedString(peer)); final Collection> altNames1 = x509.getSubjectAlternativeNames(); if (altNames1 != null) { final List altNames = new ArrayList<>(); for (final List aC : altNames1) { if (!aC.isEmpty()) { altNames.add(Objects.toString(aC.get(1), null)); } } LOG.debug(" peer alternative names: {}", altNames); } final X500Principal issuer = x509.getIssuerX500Principal(); LOG.debug("Issuer principal: {}", toEscapedString(issuer)); final Collection> altNames2 = x509.getIssuerAlternativeNames(); if (altNames2 != null) { final List altNames = new ArrayList<>(); for (final List aC : altNames2) { if (!aC.isEmpty()) { altNames.add(Objects.toString(aC.get(1), null)); } } LOG.debug(" issuer alternative names: {}", altNames); } } } catch (final Exception ignore) { } } if (hostnameVerifier != null) { final Certificate[] certs = sslsession.getPeerCertificates(); if (certs.length < 1) { throw new SSLPeerUnverifiedException("Peer certificate chain is empty"); } final Certificate peerCertificate = certs[0]; final X509Certificate x509Certificate; if (peerCertificate instanceof X509Certificate) { x509Certificate = (X509Certificate) peerCertificate; } else { throw new SSLPeerUnverifiedException("Unexpected certificate type: " + peerCertificate.getType()); } if (hostnameVerifier instanceof HttpClientHostnameVerifier) { ((HttpClientHostnameVerifier) hostnameVerifier).verify(hostname, x509Certificate); } else if (!hostnameVerifier.verify(hostname, sslsession)) { final List subjectAlts = DefaultHostnameVerifier.getSubjectAltNames(x509Certificate); throw new SSLPeerUnverifiedException("Certificate for <" + hostname + "> doesn't match any " + "of the subject alternative names: " + subjectAlts); } } } /** * Converts an X500Principal to a cleaned string by escaping control characters. *

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

* *

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

* * @param principal the X500Principal to escape * @return the escaped string representation of the X500Principal */ @Internal String toEscapedString(final X500Principal principal) { final String principalValue = principal.getName(X500Principal.RFC2253); final StringBuilder sanitizedPrincipal = new StringBuilder(principalValue.length()); for (final char c : principalValue.toCharArray()) { if (Character.isISOControl(c)) { sanitizedPrincipal.append(String.format("\\x%02x", (int) c)); } else { sanitizedPrincipal.append(c); } } return sanitizedPrincipal.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/ssl/NoopHostnameVerifier.java0100664 0000000 0000000 00000004000 14704162040 027174 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLSession; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * The NO_OP HostnameVerifier essentially turns hostname verification * off. This implementation is a no-op, and never throws the SSLException. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class NoopHostnameVerifier implements HostnameVerifier { /** * Default instance of {@link NoopHostnameVerifier}. */ public static final NoopHostnameVerifier INSTANCE = new NoopHostnameVerifier(); @Override public boolean verify(final String s, final SSLSession sslSession) { return true; } @Override public final String toString() { return "NO_OP"; } } httpclient5/src/main/java/org/apache/hc/client5/http/psl/0040775 0000000 0000000 00000000000 15005672035 022236 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/psl/package-info.java0100664 0000000 0000000 00000002440 14666635064 025437 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Public Suffix List support classes. */ package org.apache.hc.client5.http.psl; httpclient5/src/main/java/org/apache/hc/client5/http/psl/PublicSuffixListParser.java0100664 0000000 0000000 00000013755 14704162040 027520 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.psl; import java.io.BufferedReader; import java.io.IOException; import java.io.Reader; import java.util.ArrayList; import java.util.List; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Parses the list from publicsuffix.org * and configures a PublicSuffixFilter. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public final class PublicSuffixListParser { /** * Default instance of {@link PublicSuffixListParser}. * * @since 5.2 */ public static final PublicSuffixListParser INSTANCE = new PublicSuffixListParser(); public PublicSuffixListParser() { } /** * Parses the public suffix list format. *

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

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

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

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

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

* * @since 5.5 */ public boolean verify(final String domain) { if (domain == null) { return false; } return verifyInternal(domain.startsWith(".") ? domain.substring(1) : domain); } @Internal public boolean verifyInternal(final String domain) { final DomainRootInfo domainRootInfo = resolveDomainRoot(domain, null); if (domainRootInfo == null) { return false; } return domainRootInfo.root != null || domainRootInfo.domainType == DomainType.PRIVATE && domainRootInfo.matchingKey != null; } } httpclient5/src/main/java/org/apache/hc/client5/http/psl/PublicSuffixList.java0100664 0000000 0000000 00000005316 14666635064 026357 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.psl; import java.util.Collections; import java.util.List; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Public suffix is a set of DNS names or wildcards concatenated with dots. It represents * the part of a domain name which is not under the control of the individual registrant *

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

* * @since 4.4 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class PublicSuffixList { private final DomainType type; private final List rules; private final List exceptions; /** * @since 4.5 */ public PublicSuffixList(final DomainType type, final List rules, final List exceptions) { this.type = Args.notNull(type, "Domain type"); this.rules = Collections.unmodifiableList(Args.notNull(rules, "Domain suffix rules")); this.exceptions = Collections.unmodifiableList(exceptions != null ? exceptions : Collections.emptyList()); } public PublicSuffixList(final List rules, final List exceptions) { this(DomainType.UNKNOWN, rules, exceptions); } /** * @since 4.5 */ public DomainType getType() { return type; } public List getRules() { return rules; } public List getExceptions() { return exceptions; } } httpclient5/src/main/java/org/apache/hc/client5/http/psl/PublicSuffixMatcherLoader.java0100664 0000000 0000000 00000007523 15005672035 030143 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.psl; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.net.URL; import java.nio.charset.StandardCharsets; import java.util.Collections; import java.util.List; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * {@link PublicSuffixMatcher} loader. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE) public final class PublicSuffixMatcherLoader { private static final String PUBLIC_SUFFIX_LIST = "/org/publicsuffix/list/effective_tld_names.dat"; private static final Logger LOG = LoggerFactory.getLogger(PublicSuffixMatcherLoader.class); private static final ReentrantLock lock = new ReentrantLock(); private static PublicSuffixMatcher load(final InputStream in) throws IOException { final List lists = PublicSuffixListParser.INSTANCE.parseByType( new InputStreamReader(in, StandardCharsets.UTF_8)); return new PublicSuffixMatcher(lists); } public static PublicSuffixMatcher load(final URL url) throws IOException { Args.notNull(url, "URL"); try (InputStream in = url.openStream()) { return load(in); } } public static PublicSuffixMatcher load(final File file) throws IOException { Args.notNull(file, "File"); try (InputStream in = new FileInputStream(file)) { return load(in); } } private static volatile PublicSuffixMatcher DEFAULT_INSTANCE; public static PublicSuffixMatcher getDefault() { if (DEFAULT_INSTANCE == null) { lock.lock(); try { if (DEFAULT_INSTANCE == null) { final URL url = PublicSuffixMatcherLoader.class.getResource(PUBLIC_SUFFIX_LIST); if (url != null) { try { DEFAULT_INSTANCE = load(url); } catch (final IOException ex) { // Should never happen LOG.warn("Failure loading public suffix list from default resource", ex); } } else { DEFAULT_INSTANCE = new PublicSuffixMatcher(DomainType.ICANN, Collections.singletonList("com"), null); } } } finally { lock.unlock(); } } return DEFAULT_INSTANCE; } } httpclient5/src/main/java/org/apache/hc/client5/http/EndpointInfo.java0100664 0000000 0000000 00000003745 14704162040 024700 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import javax.net.ssl.SSLSession; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.ProtocolVersion; /** * @since 5.4 */ public final class EndpointInfo { private final ProtocolVersion protocol; private final SSLSession sslSession; @Internal public EndpointInfo(final ProtocolVersion protocol, final SSLSession sslSession) { this.protocol = protocol; this.sslSession = sslSession; } public ProtocolVersion getProtocol() { return protocol; } public SSLSession getSslSession() { return sslSession; } @Override public String toString() { return "EndpointInfo{" + "protocol=" + protocol + ", sslSession=" + sslSession + '}'; } } httpclient5/src/main/java/org/apache/hc/client5/http/HttpResponseException.java0100664 0000000 0000000 00000007055 14666635064 026641 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.TextUtils; /** * Signals a non 2xx HTTP response. * * @since 4.0 */ public class HttpResponseException extends ClientProtocolException { private static final long serialVersionUID = -7186627969477257933L; private final int statusCode; private final String reasonPhrase; private final byte[] contentBytes; private final ContentType contentType; /** * Constructs a new instance of {@code HttpResponseException} with the given * status code and reason phrase, and no content bytes or content type. * * @param statusCode the HTTP status code * @param reasonPhrase the reason phrase associated with the HTTP status code */ public HttpResponseException(final int statusCode, final String reasonPhrase) { this(statusCode, reasonPhrase, null, null); } /** * Constructs a new instance of {@code HttpResponseException} with the given * status code, reason phrase, content bytes, and content type. * * @param statusCode the HTTP status code * @param reasonPhrase the reason phrase associated with the HTTP status code * @param contentBytes the content bytes of the HTTP response * @param contentType the content type of the HTTP response */ public HttpResponseException(final int statusCode, final String reasonPhrase, final byte[] contentBytes, final ContentType contentType) { super(String.format("status code: %d" + (TextUtils.isBlank(reasonPhrase) ? "" : ", reason phrase: %s") + (contentBytes == null ? "" : ", content: %s"), statusCode, reasonPhrase, contentBytes == null || contentType == null || contentType.getCharset() == null ? null : new String(contentBytes, contentType.getCharset()))); this.statusCode = statusCode; this.reasonPhrase = reasonPhrase; this.contentBytes = contentBytes; this.contentType = contentType; } public int getStatusCode() { return this.statusCode; } public String getReasonPhrase() { return this.reasonPhrase; } public byte[] getContentBytes() { return contentBytes; } public ContentType getContentType() { return contentType; } } httpclient5/src/main/java/org/apache/hc/client5/http/ConnectTimeoutException.java0100664 0000000 0000000 00000004467 14704162040 027125 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.SocketTimeoutException; import org.apache.hc.core5.net.NamedEndpoint; /** * A timeout while connecting to an HTTP server or waiting for an available connection from a connection manager. * * @since 4.0 */ public class ConnectTimeoutException extends SocketTimeoutException { private static final long serialVersionUID = -4816682903149535989L; private final NamedEndpoint namedEndpoint; /** * Creates a ConnectTimeoutException with the specified detail message. * * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method). */ public ConnectTimeoutException(final String message) { super(message); this.namedEndpoint = null; } public ConnectTimeoutException(final String message, final NamedEndpoint namedEndpoint) { super(message); this.namedEndpoint = namedEndpoint; } /** * Gets the named endpoint. * * @return the named endpoint, may be {@code null}. * @since 5.0 */ public NamedEndpoint getHost() { return this.namedEndpoint; } } httpclient5/src/main/java/org/apache/hc/client5/http/socket/0040775 0000000 0000000 00000000000 15063503632 022730 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/socket/package-info.java0100664 0000000 0000000 00000002366 14666635064 026140 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client connection socket APIs. */ package org.apache.hc.client5.http.socket; httpclient5/src/main/java/org/apache/hc/client5/http/socket/PlainConnectionSocketFactory.java0100664 0000000 0000000 00000010571 15005672016 031357 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.socket; import java.io.IOException; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.Socket; import java.security.AccessController; import java.security.PrivilegedActionException; import java.security.PrivilegedExceptionAction; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.Closer; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.TimeValue; /** * The default class for creating plain (unencrypted) sockets. * * @deprecated Use {@link org.apache.hc.client5.http.io.DetachedSocketFactory}. * Please note this interface is considered internal. * * @see org.apache.hc.client5.http.impl.io.DefaultHttpClientConnectionOperator * @see org.apache.hc.client5.http.io.DetachedSocketFactory */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public class PlainConnectionSocketFactory implements ConnectionSocketFactory { /** * Default instance of {@link PlainConnectionSocketFactory}. */ public static final PlainConnectionSocketFactory INSTANCE = new PlainConnectionSocketFactory(); public static PlainConnectionSocketFactory getSocketFactory() { return INSTANCE; } public PlainConnectionSocketFactory() { super(); } @Override public Socket createSocket(final Proxy proxy, final HttpContext context) throws IOException { return proxy != null ? new Socket(proxy) : createSocket(context); } @Override public Socket createSocket(final HttpContext context) throws IOException { return new Socket(); } @Override public Socket connectSocket( final TimeValue connectTimeout, final Socket socket, final HttpHost host, final InetSocketAddress remoteAddress, final InetSocketAddress localAddress, final HttpContext context) throws IOException { final Socket sock = socket != null ? socket : createSocket(context); if (localAddress != null) { sock.bind(localAddress); } try { // Run this under a doPrivileged to support lib users that run under a SecurityManager this allows granting connect permissions // only to this library try { AccessController.doPrivileged((PrivilegedExceptionAction) () -> { sock.connect(remoteAddress, TimeValue.isPositive(connectTimeout) ? connectTimeout.toMillisecondsIntBound() : 0); return null; }); } catch (final PrivilegedActionException e) { Asserts.check(e.getCause() instanceof IOException, "method contract violation only checked exceptions are wrapped: " + e.getCause()); // only checked exceptions are wrapped - error and RTExceptions are rethrown by doPrivileged throw (IOException) e.getCause(); } } catch (final IOException ex) { Closer.closeQuietly(sock); throw ex; } return sock; } } httpclient5/src/main/java/org/apache/hc/client5/http/socket/LayeredConnectionSocketFactory.java0100664 0000000 0000000 00000006344 14704162040 031700 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.socket; import java.io.IOException; import java.net.Socket; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * Extended {@link ConnectionSocketFactory} interface for layered sockets such as SSL/TLS. * * @deprecated Use {@link org.apache.hc.client5.http.ssl.TlsSocketStrategy}. */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public interface LayeredConnectionSocketFactory extends ConnectionSocketFactory { /** * Returns a socket connected to the given host that is layered over an * existing socket. Used primarily for creating secure sockets through * proxies. * * @param socket the existing socket * @param target the name of the target host. * @param port the port to connect to on the target host. * @param context the actual HTTP context. * * @return Socket a new socket * * @throws IOException if an I/O error occurs while creating the socket */ Socket createLayeredSocket( Socket socket, String target, int port, HttpContext context) throws IOException; /** * Returns a socket connected to the given host that is layered over an * existing socket. Used primarily for creating secure sockets through * proxies. * * @param socket the existing socket * @param target the name of the target host. * @param port the port to connect to on the target host. * @param context the actual HTTP context. * @param attachment connect request attachment. * * @return Socket a new socket * * @throws IOException if an I/O error occurs while creating the socket * * @since 5.2 */ default Socket createLayeredSocket( Socket socket, String target, int port, Object attachment, HttpContext context) throws IOException { return createLayeredSocket(socket, target, port, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/socket/ConnectionSocketFactory.java0100664 0000000 0000000 00000011732 14704162040 030367 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.socket; import java.io.IOException; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.Socket; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * A factory for creating and connecting connection sockets. * * @deprecated Do not use. */ @Contract(threading = ThreadingBehavior.STATELESS) @Deprecated public interface ConnectionSocketFactory { /** * Creates new, unconnected socket. The socket should subsequently be passed to * {@link #connectSocket(TimeValue, Socket, HttpHost, InetSocketAddress, InetSocketAddress, * HttpContext) connectSocket} method. */ Socket createSocket(HttpContext context) throws IOException; /** * Creates new, unconnected socket via a proxy (generally SOCKS is expected). * The socket should subsequently be passed to {@link #connectSocket(TimeValue, Socket, * HttpHost, InetSocketAddress, InetSocketAddress, HttpContext) connectSocket} method. * * @since 5.2 */ @Internal default Socket createSocket(Proxy proxy, HttpContext context) throws IOException { return createSocket(context); } /** * Connects the socket to the target host with the given resolved remote address. * * @param connectTimeout connect timeout. * @param socket the socket to connect, as obtained from {@link #createSocket(HttpContext)}. * {@code null} indicates that a new socket should be created and connected. * @param host target host as specified by the caller (end user). * @param remoteAddress the resolved remote address to connect to. * @param localAddress the local address to bind the socket to, or {@code null} for any. * @param context the actual HTTP context. * * @return the connected socket. The returned object may be different * from the {@code sock} argument if this factory supports * a layered protocol. * * @throws IOException if an I/O error occurs */ Socket connectSocket( TimeValue connectTimeout, Socket socket, HttpHost host, InetSocketAddress remoteAddress, InetSocketAddress localAddress, HttpContext context) throws IOException; /** * Connects the socket to the target host with the given resolved remote address. * * @param socket the socket to connect, as obtained from {@link #createSocket(HttpContext)}. * {@code null} indicates that a new socket should be created and connected. * @param host target host as specified by the caller (end user). * @param remoteAddress the resolved remote address to connect to. * @param localAddress the local address to bind the socket to, or {@code null} for any. * @param connectTimeout connect timeout. * @param attachment connect request attachment. * @param context the actual HTTP context. * * @return the connected socket. The returned object may be different * from the {@code sock} argument if this factory supports * a layered protocol. * * @throws IOException if an I/O error occurs * * @since 5.2 */ default Socket connectSocket( Socket socket, HttpHost host, InetSocketAddress remoteAddress, InetSocketAddress localAddress, Timeout connectTimeout, Object attachment, HttpContext context) throws IOException { return connectSocket(connectTimeout, socket, host, remoteAddress, localAddress, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/io/0040775 0000000 0000000 00000000000 15063503632 022047 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/io/package-info.java0100664 0000000 0000000 00000002431 14666635064 025250 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Connection management APIs based on the classic (blocking) I/O model. */ package org.apache.hc.client5.http.io; httpclient5/src/main/java/org/apache/hc/client5/http/io/ManagedHttpClientConnection.java0100664 0000000 0000000 00000006610 14704162040 030260 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.io.IOException; import java.net.Socket; import javax.net.ssl.SSLSession; import javax.net.ssl.SSLSocket; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.io.HttpClientConnection; /** * Represents a managed connection whose state and life cycle is managed by * a connection manager. This interface extends {@link HttpClientConnection} * with methods to bind the connection to an arbitrary socket and * to obtain SSL session details. * * @since 4.3 */ @Internal public interface ManagedHttpClientConnection extends HttpClientConnection { /** * Binds this connection to the given socket. The connection * is considered open if it is bound and the underlying socket * is connection to a remote host. * * @param socket the socket to bind the connection to. */ void bind(Socket socket) throws IOException; /** * Binds this connection to the SSL given socket and the underlying network * socket. The connection is considered open if it is bound, the underlying * network socket is connection to a remote host and the SSL socket is * fully initialized (TLS handshake has been successfully executed). * * @param sslSocket the SSL socket to bind the connection to. * @param socket the underlying network socket of the SSL socket. * * @since 5.4 */ default void bind(SSLSocket sslSocket, Socket socket) throws IOException { bind(sslSocket); } /** * Returns the underlying socket. */ Socket getSocket(); /** * Obtains the SSL session of the underlying connection, if any. * If this connection is open, and the underlying socket is an * {@link javax.net.ssl.SSLSocket SSLSocket}, the SSL session of * that socket is obtained. This is a potentially blocking operation. * * @return the underlying SSL session if available, * {@code null} otherwise */ @Override SSLSession getSSLSession(); /** * Puts the connection into idle mode. * * @since 5.0 */ void passivate(); /** * Restores the connection from idle mode. * * @since 5.0 */ void activate(); } httpclient5/src/main/java/org/apache/hc/client5/http/io/DetachedSocketFactory.java0100664 0000000 0000000 00000003370 15005672016 027113 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.io.IOException; import java.net.Proxy; import java.net.Socket; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * @since 5.4 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) public interface DetachedSocketFactory { Socket create(Proxy proxy) throws IOException; /** * @since 5.5 */ default Socket create(String schemeName, Proxy proxy) throws IOException { return create(proxy); } } httpclient5/src/main/java/org/apache/hc/client5/http/io/HttpClientConnectionManager.java0100664 0000000 0000000 00000011246 14666635064 030321 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.io.IOException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Represents a manager of persistent client connections. *

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

*

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

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

* Please note that newly allocated endpoints can be leased * {@link ConnectionEndpoint#isConnected() disconnected}. The consumer of the endpoint * is responsible for fully establishing the route to the endpoint target * by calling {@link #connect(ConnectionEndpoint, TimeValue, HttpContext)} * in order to connect directly to the target or to the first proxy hop, * and optionally calling {@link #upgrade(ConnectionEndpoint, HttpContext)} method * to upgrade the underlying transport to Transport Layer Security after having * executed a {@code CONNECT} method to all intermediate proxy hops. * * @param id unique operation ID or {@code null}. * @param route HTTP route of the requested connection. * @param requestTimeout lease request timeout. * @param state expected state of the connection or {@code null} * if the connection is not expected to carry any state. * @since 5.0 */ LeaseRequest lease(String id, HttpRoute route, Timeout requestTimeout, Object state); /** * Releases the endpoint back to the manager making it potentially * re-usable by other consumers. Optionally, the maximum period * of how long the manager should keep the connection alive can be * defined using {@code validDuration} and {@code timeUnit} * parameters. * * @param endpoint the managed endpoint. * @param newState the new connection state of {@code null} if state-less. * @param validDuration the duration of time this connection is valid for reuse. */ void release(ConnectionEndpoint endpoint, Object newState, TimeValue validDuration); /** * Connects the endpoint to the initial hop (connection target in case * of a direct route or to the first proxy hop in case of a route via a proxy * or multiple proxies). * * @param endpoint the managed endpoint. * @param connectTimeout connect timeout. * @param context the actual HTTP context. */ void connect(ConnectionEndpoint endpoint, TimeValue connectTimeout, HttpContext context) throws IOException; /** * Upgrades transport security of the given endpoint by using the TLS security protocol. * * @param endpoint the managed endpoint. * @param context the actual HTTP context. */ void upgrade(ConnectionEndpoint endpoint, HttpContext context) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/io/LeaseRequest.java0100664 0000000 0000000 00000004671 14666635064 025336 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeoutException; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.util.Timeout; /** * Represents a request for a {@link ConnectionEndpoint} whose life cycle * is managed by a connection manager. * * @since 5.0 */ public interface LeaseRequest extends Cancellable { /** * Returns {@link ConnectionEndpoint} within a given time. * This method will block until a connection becomes available, * the timeout expires, or the connection manager is shut down. * Timeouts are handled with millisecond precision. * * If {@link #cancel()} is called while this is blocking or * before this began, an {@link InterruptedException} will * be thrown. * * @param timeout the operation timeout. * * @return a connection that can be used to communicate * along the given route * * @throws TimeoutException * in case of a timeout * @throws InterruptedException * if the calling thread is interrupted while waiting */ ConnectionEndpoint get(Timeout timeout) throws InterruptedException, ExecutionException, TimeoutException; }httpclient5/src/main/java/org/apache/hc/client5/http/io/HttpClientConnectionOperator.java0100664 0000000 0000000 00000011673 15063503632 030531 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.io.IOException; import java.net.InetSocketAddress; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Connection operator that performs connection connect and upgrade operations. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public interface HttpClientConnectionOperator { /** * Connect the given managed connection to the remote endpoint. * * @param conn the managed connection. * @param host the address of the opposite endpoint. * @param localAddress the address of the local endpoint. * @param connectTimeout the timeout of the connect operation. * @param socketConfig the socket configuration. * @param context the execution context. */ void connect( ManagedHttpClientConnection conn, HttpHost host, InetSocketAddress localAddress, TimeValue connectTimeout, SocketConfig socketConfig, HttpContext context) throws IOException; /** * Connect the given managed connection to the remote endpoint. * * @param conn the managed connection. * @param endpointHost the address of the remote endpoint. * @param endpointName the name of the remote endpoint, if different from the endpoint host name, * {@code null} otherwise. Usually taken from the request URU authority. * @param localAddress the address of the local endpoint. * @param connectTimeout the timeout of the connect operation. * @param socketConfig the socket configuration. * @param attachment connect request attachment. * @param context the execution context. * * @since 5.4 */ default void connect( ManagedHttpClientConnection conn, HttpHost endpointHost, NamedEndpoint endpointName, InetSocketAddress localAddress, Timeout connectTimeout, SocketConfig socketConfig, Object attachment, HttpContext context) throws IOException { connect(conn, endpointHost, localAddress, connectTimeout, socketConfig, context); } /** * Upgrades transport security of the given managed connection * by using the TLS security protocol. * * @param conn the managed connection. * @param host the address of the opposite endpoint with TLS security. * @param context the execution context. */ void upgrade( ManagedHttpClientConnection conn, HttpHost host, HttpContext context) throws IOException; /** * Upgrades transport security of the given managed connection * by using the TLS security protocol. * * @param conn the managed connection. * @param endpointHost the address of the remote endpoint. * @param endpointName the name of the remote endpoint, if different from the endpoint host name, * {@code null} otherwise. Usually taken from the request URU authority. * @param attachment connect request attachment. * @param context the execution context. * * @since 5.2 */ default void upgrade( ManagedHttpClientConnection conn, HttpHost endpointHost, NamedEndpoint endpointName, Object attachment, HttpContext context) throws IOException { upgrade(conn, endpointHost, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/io/ConnectionEndpoint.java0100664 0000000 0000000 00000010170 14704162040 026501 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.io; import java.io.IOException; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpClientConnection; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.util.Timeout; /** * Client endpoint leased from a connection manager. Client points can be used * to execute HTTP requests. *

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

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

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

* * @param id unique operation ID or {@code null}. * @param request the request message. * @param requestExecutor the request executor. * @param context the execution context. * * @since 5.4 */ // In the next major release this method must be made abstract. public ClassicHttpResponse execute( final String id, final ClassicHttpRequest request, final RequestExecutor requestExecutor, final HttpContext context) throws IOException, HttpException { return requestExecutor.execute(request,null, context); } /** * Determines if the connection to the remote endpoint is still open and valid. */ public abstract boolean isConnected(); /** * Sets the socket timeout value. * * @param timeout timeout value */ public abstract void setSocketTimeout(Timeout timeout); /** * Returns information about the endpoint or {@code null} when not connected. * * @since 5.4 */ public EndpointInfo getInfo() { return null; } /** * @since 5.4 */ @Internal public interface RequestExecutor { ClassicHttpResponse execute( ClassicHttpRequest request, HttpClientConnection conn, HttpContext context) throws IOException, HttpException; } } httpclient5/src/main/java/org/apache/hc/client5/http/AbstractClientContextBuilder.java0100664 0000000 0000000 00000011724 14704162040 030056 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.util.HashMap; import java.util.Map; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.auth.BasicScheme; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.util.Args; /** * Abstract {@link HttpClientContext} builder. * * @param The HttpClientContext type or subtype. * @since 5.4 */ public abstract class AbstractClientContextBuilder { private final SchemePortResolver schemePortResolver; private Lookup cookieSpecRegistry; private Lookup authSchemeRegistry; private CookieStore cookieStore; private CredentialsProvider credentialsProvider; private AuthCache authCache; private Map authSchemeMap; protected AbstractClientContextBuilder(final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; } public AbstractClientContextBuilder useCookieSpecRegistry(final Lookup cookieSpecRegistry) { this.cookieSpecRegistry = cookieSpecRegistry; return this; } public AbstractClientContextBuilder useAuthSchemeRegistry(final Lookup authSchemeRegistry) { this.authSchemeRegistry = authSchemeRegistry; return this; } public AbstractClientContextBuilder useCookieStore(final CookieStore cookieStore) { this.cookieStore = cookieStore; return this; } public AbstractClientContextBuilder useCredentialsProvider(final CredentialsProvider credentialsProvider) { this.credentialsProvider = credentialsProvider; return this; } public AbstractClientContextBuilder useAuthCache(final AuthCache authCache) { this.authCache = authCache; return this; } public AbstractClientContextBuilder preemptiveAuth(final HttpHost host, final AuthScheme authScheme) { Args.notNull(host, "HTTP host"); if (authSchemeMap == null) { authSchemeMap = new HashMap<>(); } authSchemeMap.put(RoutingSupport.normalize(host, schemePortResolver), authScheme); return this; } public AbstractClientContextBuilder preemptiveBasicAuth(final HttpHost host, final UsernamePasswordCredentials credentials) { Args.notNull(host, "HTTP host"); final BasicScheme authScheme = new BasicScheme(); authScheme.initPreemptive(credentials); preemptiveAuth(host, authScheme); return this; } protected abstract T createContext(); public T build() { final T context = createContext(); context.setCookieSpecRegistry(cookieSpecRegistry); context.setAuthSchemeRegistry(authSchemeRegistry); context.setCookieStore(cookieStore); context.setCredentialsProvider(credentialsProvider); context.setAuthCache(authCache); if (authSchemeMap != null) { for (final Map.Entry entry : authSchemeMap.entrySet()) { context.resetAuthExchange(entry.getKey(), entry.getValue()); } } return context; } } httpclient5/src/main/java/org/apache/hc/client5/http/validator/0040775 0000000 0000000 00000000000 14704162040 023420 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/validator/ETag.java0100664 0000000 0000000 00000013147 14704162040 025106 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.validator; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.MessageHeaders; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.LangUtils; import org.apache.hc.core5.util.Tokenizer; /** * Represents ETag value. * * @since 5.4 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class ETag { private final String value; private final ValidatorType type; public ETag(final String value, final ValidatorType type) { this.value = Args.notNull(value, "Value"); this.type = Args.notNull(type, "Validator type"); } public ETag(final String value) { this(value, ValidatorType.STRONG); } public ValidatorType getType() { return type; } public String getValue() { return value; } public static boolean strongCompare(final ETag t1, final ETag t2) { if (t1 == null || t2 == null) { return false; } return t1.type == ValidatorType.STRONG && t1.type == t2.type && t1.value.equals(t2.value); } public static boolean weakCompare(final ETag t1, final ETag t2) { if (t1 == null || t2 == null) { return false; } return t1.value.equals(t2.value); } static ETag parse(final CharSequence buf, final Tokenizer.Cursor cursor) { final Tokenizer tokenizer = Tokenizer.INSTANCE; tokenizer.skipWhiteSpace(buf, cursor); ValidatorType type = ValidatorType.STRONG; if (!cursor.atEnd() && buf.charAt(cursor.getPos()) == 'W') { cursor.updatePos(cursor.getPos() + 1); if (!cursor.atEnd() && buf.charAt(cursor.getPos()) == '/') { type = ValidatorType.WEAK; cursor.updatePos(cursor.getPos() + 1); } else { return null; } } String value = null; if (!cursor.atEnd() && buf.charAt(cursor.getPos()) == '"') { cursor.updatePos(cursor.getPos() + 1); final StringBuilder sb = new StringBuilder(); for (;;) { if (cursor.atEnd()) { return null; } final char ch = buf.charAt(cursor.getPos()); cursor.updatePos(cursor.getPos() + 1); if (ch == '"') { break; } sb.append(ch); } value = sb.toString(); } tokenizer.skipWhiteSpace(buf, cursor); if (!cursor.atEnd()) { return null; } return new ETag(value, type); } public static ETag parse(final String s) { if (s == null) { return null; } final Tokenizer.Cursor cursor = new Tokenizer.Cursor(0, s.length()); return parse(s, cursor); } public static ETag parse(final Header h) { if (h == null) { return null; } final String value = h.getValue(); if (value == null) { return null; } return parse(value); } public static ETag get(final MessageHeaders message) { if (message == null) { return null; } return parse(message.getFirstHeader(HttpHeaders.ETAG)); } @Internal public void format(final CharArrayBuffer buf) { if (buf == null) { return; } if (type == ValidatorType.WEAK) { buf.append("W/"); } buf.append('"'); buf.append(value); buf.append('"'); } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o instanceof ETag) { final ETag that = (ETag) o; return this.type == that.type && this.value.equals(that.value); } return false; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, type); hash = LangUtils.hashCode(hash, value); return hash; } @Override public String toString() { final CharArrayBuffer buf = new CharArrayBuffer(64); format(buf); return buf.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/validator/ValidatorType.java0100664 0000000 0000000 00000002426 14704162040 027053 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.validator; /** * @since 5.4 */ public enum ValidatorType { STRONG, WEAK }httpclient5/src/main/java/org/apache/hc/client5/http/entity/0040775 0000000 0000000 00000000000 15063503632 022754 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/entity/package-info.java0100664 0000000 0000000 00000002404 14666635064 026155 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client specific HTTP entity implementations. */ package org.apache.hc.client5.http.entity; httpclient5/src/main/java/org/apache/hc/client5/http/entity/EntityBuilder.java0100664 0000000 0000000 00000030344 15063503632 026403 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.File; import java.io.InputStream; import java.io.Serializable; import java.util.Arrays; import java.util.List; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.io.entity.AbstractHttpEntity; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.FileEntity; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.io.entity.SerializableEntity; import org.apache.hc.core5.http.io.entity.StringEntity; /** * Builder for {@link HttpEntity} instances. *

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

*
    *
  • {@link #setText(String)}
    • *
  • {@link #setBinary(byte[])}
    • *
  • {@link #setStream(java.io.InputStream)}
    • *
  • {@link #setSerializable(java.io.Serializable)}
    • *
  • {@link #setParameters(java.util.List)}
    • *
  • {@link #setParameters(NameValuePair...)}
    • *
  • {@link #setFile(java.io.File)}
    • *
* * @since 4.3 */ public class EntityBuilder { private String text; private byte[] binary; private InputStream stream; private List parameters; private Serializable serializable; private File file; private ContentType contentType; private String contentEncoding; private boolean chunked; private boolean gzipCompressed; EntityBuilder() { super(); } public static EntityBuilder create() { return new EntityBuilder(); } private void clearContent() { this.text = null; this.binary = null; this.stream = null; this.parameters = null; this.serializable = null; this.file = null; } /** * Gets the entity content as a string if set using {@link #setText(String)}. * * @return the entity content as a string, may be null. */ public String getText() { return text; } /** * Sets entity content as a string. This method is mutually exclusive with * {@link #setBinary(byte[])}, * {@link #setStream(java.io.InputStream)}, * {@link #setSerializable(java.io.Serializable)}, * {@link #setParameters(java.util.List)}, * {@link #setParameters(NameValuePair...)} * {@link #setFile(java.io.File)} methods. * * @param text entity content as a string. * @return this instance. */ public EntityBuilder setText(final String text) { clearContent(); this.text = text; return this; } /** * Gets entity content as a byte array if set using * {@link #setBinary(byte[])}. * * @return entity content as a byte array. */ public byte[] getBinary() { return binary; } /** * Sets entity content as a byte array. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setStream(java.io.InputStream)}, * {@link #setSerializable(java.io.Serializable)}, * {@link #setParameters(java.util.List)}, * {@link #setParameters(NameValuePair...)} * {@link #setFile(java.io.File)}. * * @param binary The new entity content as a byte array. * @return this instance. */ public EntityBuilder setBinary(final byte[] binary) { clearContent(); this.binary = binary; return this; } /** * Gets entity content as an {@link InputStream} if set using * {@link #setStream(java.io.InputStream)} method. * * @return entity content as an {@link InputStream} */ public InputStream getStream() { return stream; } /** * Sets entity content as an {@link InputStream}. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setBinary(byte[])}, * {@link #setSerializable(java.io.Serializable)}, * {@link #setParameters(java.util.List)}, * {@link #setParameters(NameValuePair...)} * {@link #setFile(java.io.File)}. * * @param stream The new entity content as an InputStream. * @return this instance. */ public EntityBuilder setStream(final InputStream stream) { clearContent(); this.stream = stream; return this; } /** * Gets entity content as a parameter list if set using * {@link #setParameters(java.util.List)} or * {@link #setParameters(NameValuePair...)}. * * @return entity content as a parameter list. */ public List getParameters() { return parameters; } /** * Sets entity content as a parameter list. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setBinary(byte[])}, * {@link #setStream(java.io.InputStream)}, * {@link #setSerializable(java.io.Serializable)}, * {@link #setFile(java.io.File)}. * * @param parameters entity content as a parameter list. * @return this instance. */ public EntityBuilder setParameters(final List parameters) { clearContent(); this.parameters = parameters; return this; } /** * Sets entity content as a parameter list. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setBinary(byte[])}, * {@link #setStream(java.io.InputStream)}, * {@link #setSerializable(java.io.Serializable)}, * {@link #setFile(java.io.File)}. * * @param parameters entity content as a parameter list. * @return this */ public EntityBuilder setParameters(final NameValuePair... parameters) { return setParameters(Arrays.asList(parameters)); } /** * Gets entity content as a {@link Serializable} if set using * {@link #setSerializable(java.io.Serializable)} method. * * @return entity content as a {@link Serializable}. */ public Serializable getSerializable() { return serializable; } /** * Sets entity content as a {@link Serializable}. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setBinary(byte[])}, * {@link #setStream(java.io.InputStream)}, * {@link #setParameters(java.util.List)}, * {@link #setParameters(NameValuePair...)} * {@link #setFile(java.io.File)}. * * @param serializable entity content as a {@link Serializable}. * @return this instance. */ public EntityBuilder setSerializable(final Serializable serializable) { clearContent(); this.serializable = serializable; return this; } /** * Gets the entity content as a {@link File} if set using * {@link #setFile(java.io.File)}. * * @return Gets the entity content as a {@link File}. */ public File getFile() { return file; } /** * Sets entity content as a {@link File}. This method is mutually exclusive with * {@link #setText(String)}, * {@link #setBinary(byte[])}, * {@link #setStream(java.io.InputStream)}, * {@link #setParameters(java.util.List)}, * {@link #setParameters(NameValuePair...)} * {@link #setSerializable(java.io.Serializable)}. * * @param file entity content as a {@link File}. * @return this instance. */ public EntityBuilder setFile(final File file) { clearContent(); this.file = file; return this; } /** * Gets the {@link ContentType} of the entity, may be null. * * @return the {@link ContentType} of the entity, may be null. */ public ContentType getContentType() { return contentType; } /** * Sets the {@link ContentType} of the entity. * * @param contentType the {@link ContentType} of the entity, may be null. * @return this instance. */ public EntityBuilder setContentType(final ContentType contentType) { this.contentType = contentType; return this; } /** * Gets the content encoding of the entity, may be null. * * @return the content encoding of the entity, may be null. */ public String getContentEncoding() { return contentEncoding; } /** * Sets the content encoding of the entity. * * @param contentEncoding the content encoding of the entity, may be null. * @return this instance. */ public EntityBuilder setContentEncoding(final String contentEncoding) { this.contentEncoding = contentEncoding; return this; } /** * Tests if the entity is to be chunk coded ({@code true}), or not ({@code false}). * * @return {@code true} if entity is to be chunk coded, {@code false} otherwise. */ public boolean isChunked() { return chunked; } /** * Sets entities to be chunked. * @return this instance. */ public EntityBuilder chunked() { this.chunked = true; return this; } /** * Tests if entities are to be GZIP compressed ({@code true}), or not ({@code false}). * * @return {@code true} if entity is to be GZIP compressed, {@code false} otherwise. */ public boolean isGzipCompressed() { return gzipCompressed; } /** * Sets entities to be GZIP compressed. * * @return this instance. */ public EntityBuilder gzipCompressed() { this.gzipCompressed = true; return this; } private ContentType getContentOrDefault(final ContentType def) { return this.contentType != null ? this.contentType : def; } /** * Builds a new instance of {@link HttpEntity} based on the current state. * * @return a new instance. */ public HttpEntity build() { final AbstractHttpEntity e; if (this.text != null) { e = new StringEntity(this.text, getContentOrDefault(ContentType.DEFAULT_TEXT), this.contentEncoding, this.chunked); } else if (this.binary != null) { e = new ByteArrayEntity(this.binary, getContentOrDefault(ContentType.DEFAULT_BINARY), this.contentEncoding, this.chunked); } else if (this.stream != null) { e = new InputStreamEntity(this.stream, -1, getContentOrDefault(ContentType.DEFAULT_BINARY), this.contentEncoding); } else if (this.parameters != null) { e = new UrlEncodedFormEntity(this.parameters, this.contentType != null ? this.contentType.getCharset() : null); } else if (this.serializable != null) { e = new SerializableEntity(this.serializable, ContentType.DEFAULT_BINARY, this.contentEncoding); } else if (this.file != null) { e = new FileEntity(this.file, getContentOrDefault(ContentType.DEFAULT_BINARY), this.contentEncoding); } else { throw new IllegalStateException("No entity set"); } if (this.gzipCompressed) { return new GzipCompressingEntity(e); } return e; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/UrlEncodedFormEntity.java0100664 0000000 0000000 00000006173 15005672016 027667 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.nio.charset.Charset; import java.util.List; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.net.WWWFormCodec; /** * An entity composed of a list of url-encoded pairs. * This is typically useful while sending an HTTP POST request. * * @since 4.0 */ public class UrlEncodedFormEntity extends StringEntity { /** * Constructs a new {@link UrlEncodedFormEntity} with the list * of parameters in the specified encoding. * * @param parameters iterable collection of name/value pairs * @param charset encoding the name/value pairs be encoded with * * @since 4.2 */ public UrlEncodedFormEntity( final Iterable parameters, final Charset charset) { super(WWWFormCodec.format( parameters, charset != null ? charset : ContentType.APPLICATION_FORM_URLENCODED.getCharset()), charset != null ? ContentType.APPLICATION_FORM_URLENCODED.withCharset(charset) : ContentType.APPLICATION_FORM_URLENCODED); } /** * Constructs a new {@link UrlEncodedFormEntity} with the list * of parameters with the default encoding of {@link ContentType#APPLICATION_FORM_URLENCODED} * * @param parameters list of name/value pairs */ public UrlEncodedFormEntity(final List parameters) { this(parameters, null); } /** * Constructs a new {@link UrlEncodedFormEntity} with the list * of parameters with the default encoding of {@link ContentType#APPLICATION_FORM_URLENCODED} * * @param parameters iterable collection of name/value pairs * * @since 4.2 */ public UrlEncodedFormEntity( final Iterable parameters) { this(parameters, null); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateInputStream.java0100664 0000000 0000000 00000005707 15012321476 027363 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.FilterInputStream; import java.io.IOException; import java.io.InputStream; import java.io.PushbackInputStream; import java.util.zip.Deflater; import java.util.zip.Inflater; import java.util.zip.InflaterInputStream; import java.util.zip.ZipException; /** * Deflates an input stream. This class includes logic needed for various RFCs in order * to reasonably implement the "deflate" compression algorithm. */ public class DeflateInputStream extends FilterInputStream { public DeflateInputStream(final InputStream wrapped) throws IOException { super(null); final PushbackInputStream pushback = new PushbackInputStream(wrapped, 2); final int i1 = pushback.read(); final int i2 = pushback.read(); if (i1 == -1 || i2 == -1) { throw new ZipException("Unexpected end of stream"); } pushback.unread(i2); pushback.unread(i1); boolean nowrap = true; final int b1 = i1 & 0xFF; final int compressionMethod = b1 & 0xF; final int compressionInfo = b1 >> 4 & 0xF; final int b2 = i2 & 0xFF; if (compressionMethod == Deflater.DEFLATED && compressionInfo <= 7 && ((b1 << 8) | b2) % 31 == 0) { nowrap = false; } in = new DeflateStream(pushback, new Inflater(nowrap)); } private static class DeflateStream extends InflaterInputStream { private boolean closed; private DeflateStream(final InputStream in, final Inflater inflater) { super(in, inflater); } @Override public void close() throws IOException { if (closed) { return; } closed = true; inf.end(); super.close(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/GzipDecompressingEntity.java0100664 0000000 0000000 00000003442 15063503632 030450 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import org.apache.hc.core5.http.HttpEntity; /** * {@link org.apache.hc.core5.http.io.entity.HttpEntityWrapper} for handling * gzip Content Coded responses. * * @since 4.1 */ public class GzipDecompressingEntity extends DecompressingEntity { /** * Creates a new {@link GzipDecompressingEntity} which will wrap the * specified {@link HttpEntity}. * * @param entity * the non-null {@link HttpEntity} to be wrapped */ public GzipDecompressingEntity(final HttpEntity entity) { super(entity, GZIPInputStreamFactory.getInstance()); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/BrotliDecompressingEntity.java0100664 0000000 0000000 00000004001 15063503632 030762 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import org.apache.hc.core5.http.HttpEntity; /** * {@link org.apache.hc.core5.http.io.entity.HttpEntityWrapper} responsible for * handling br Content Coded responses. * * @see GzipDecompressingEntity * @since 5.2 */ public class BrotliDecompressingEntity extends DecompressingEntity { /** * Creates a new {@link DecompressingEntity}. * * @param entity factory to create decompressing stream. */ public BrotliDecompressingEntity(final HttpEntity entity) { super(entity, BrotliInputStreamFactory.getInstance()); } public static boolean isAvailable() { try { Class.forName("org.brotli.dec.BrotliInputStream"); return true; } catch (final ClassNotFoundException | NoClassDefFoundError e) { return false; } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateInputStreamFactory.java0100664 0000000 0000000 00000004131 15063503632 030703 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * {@link InputStreamFactory} for handling Deflate Content Coded responses. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DeflateInputStreamFactory implements InputStreamFactory { /** * Default instance of {@link DeflateInputStreamFactory}. */ private static final DeflateInputStreamFactory INSTANCE = new DeflateInputStreamFactory(); /** * Gets the singleton instance. * * @return the singleton instance. */ public static DeflateInputStreamFactory getInstance() { return INSTANCE; } @Override public InputStream create(final InputStream inputStream) throws IOException { return new DeflateInputStream(inputStream); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/DeflateDecompressingEntity.java0100664 0000000 0000000 00000004533 15063503632 031105 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import org.apache.hc.core5.http.HttpEntity; /** * {@link org.apache.hc.core5.http.io.entity.HttpEntityWrapper} responsible for * handling deflate Content Coded responses. In RFC2616 terms, {@code deflate} * means a {@code zlib} stream as defined in RFC1950. Some server * implementations have misinterpreted RFC2616 to mean that a * {@code deflate} stream as defined in RFC1951 should be used * (or maybe they did that since that's how IE behaves?). It's confusing * that {@code deflate} in HTTP 1.1 means {@code zlib} streams * rather than {@code deflate} streams. We handle both types in here, * since that's what is seen on the internet. Moral - prefer * {@code gzip}! * * @see GzipDecompressingEntity * * @since 4.1 */ public class DeflateDecompressingEntity extends DecompressingEntity { /** * Creates a new {@link DeflateDecompressingEntity} which will wrap the specified * {@link HttpEntity}. * * @param entity * a non-null {@link HttpEntity} to be wrapped */ public DeflateDecompressingEntity(final HttpEntity entity) { super(entity, DeflateInputStreamFactory.getInstance()); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/GzipCompressingEntity.java0100664 0000000 0000000 00000005030 15012321476 030130 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.util.zip.GZIPOutputStream; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.HttpEntityWrapper; import org.apache.hc.core5.util.Args; /** * Wrapping entity that compresses content when {@link #writeTo writing}. * * * @since 4.0 */ public class GzipCompressingEntity extends HttpEntityWrapper { private static final String GZIP_CODEC = "gzip"; public GzipCompressingEntity(final HttpEntity entity) { super(entity); } @Override public String getContentEncoding() { return GZIP_CODEC; } @Override public long getContentLength() { return -1; } @Override public boolean isChunked() { // force content chunking return true; } @Override public InputStream getContent() throws IOException { throw new UnsupportedOperationException(); } @Override public void writeTo(final OutputStream outStream) throws IOException { Args.notNull(outStream, "Output stream"); final GZIPOutputStream gzip = new GZIPOutputStream(outStream); super.writeTo(gzip); // Only close output stream if the wrapped entity has been // successfully written out gzip.close(); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/0040775 0000000 0000000 00000000000 15063503632 023703 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/package-info.java0100664 0000000 0000000 00000002404 14666635064 027104 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * MIME coded HTTP entity implementations. */ package org.apache.hc.client5.http.entity.mime; httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/AbstractMultipartFormat.java0100664 0000000 0000000 00000023242 14666635064 031401 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.OutputStream; import java.nio.ByteBuffer; import java.nio.CharBuffer; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.util.List; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.ByteArrayBuffer; /** * HttpMultipart represents a collection of MIME multipart encoded content bodies. * * @since 4.3 */ abstract class AbstractMultipartFormat { /** * The preamble to be included before the multipart content. */ private String preamble; /** * The epilogue to be included after the multipart content. */ private String epilogue; static ByteArrayBuffer encode( final Charset charset, final CharSequence string) { final ByteBuffer encoded = charset.encode(CharBuffer.wrap(string)); final ByteArrayBuffer bab = new ByteArrayBuffer(encoded.remaining()); bab.append(encoded.array(), encoded.arrayOffset() + encoded.position(), encoded.remaining()); return bab; } static void writeBytes( final ByteArrayBuffer b, final OutputStream out) throws IOException { out.write(b.array(), 0, b.length()); } static void writeBytes( final CharSequence s, final Charset charset, final OutputStream out) throws IOException { final ByteArrayBuffer b = encode(charset, s); writeBytes(b, out); } static void writeBytes( final CharSequence s, final OutputStream out) throws IOException { final ByteArrayBuffer b = encode(StandardCharsets.ISO_8859_1, s); writeBytes(b, out); } static boolean isLineBreak(final char ch) { return ch == '\r' || ch == '\n' || ch == '\f' || ch == 11; } static CharSequence stripLineBreaks(final CharSequence s) { if (s == null) { return null; } boolean requiresRewrite = false; int n = 0; for (; n < s.length(); n++) { final char ch = s.charAt(n); if (isLineBreak(ch)) { requiresRewrite = true; break; } } if (!requiresRewrite) { return s; } final StringBuilder buf = new StringBuilder(); buf.append(s, 0, n); for (; n < s.length(); n++) { final char ch = s.charAt(n); if (isLineBreak(ch)) { buf.append(' '); } else { buf.append(ch); } } return buf.toString(); } static void writeField( final MimeField field, final OutputStream out) throws IOException { writeBytes(stripLineBreaks(field.getName()), out); writeBytes(FIELD_SEP, out); writeBytes(stripLineBreaks(field.getBody()), out); writeBytes(CR_LF, out); } static void writeField( final MimeField field, final Charset charset, final OutputStream out) throws IOException { writeBytes(stripLineBreaks(field.getName()), charset, out); writeBytes(FIELD_SEP, out); writeBytes(stripLineBreaks(field.getBody()), charset, out); writeBytes(CR_LF, out); } static final ByteArrayBuffer FIELD_SEP = encode(StandardCharsets.ISO_8859_1, ": "); static final ByteArrayBuffer CR_LF = encode(StandardCharsets.ISO_8859_1, "\r\n"); static final ByteArrayBuffer TWO_HYPHENS = encode(StandardCharsets.ISO_8859_1, "--"); final Charset charset; final String boundary; /** * Creates an instance with the specified settings. * * @param charset the character set to use. May be {@code null}, in which case {@link StandardCharsets#ISO_8859_1} is used. * @param boundary to use - must not be {@code null} * @throws IllegalArgumentException if charset is null or boundary is null */ public AbstractMultipartFormat(final Charset charset, final String boundary) { super(); Args.notNull(boundary, "Multipart boundary"); this.charset = charset != null ? charset : StandardCharsets.ISO_8859_1; this.boundary = boundary; } /* */ /** * Constructs a new instance of {@code AbstractMultipartFormat} with the given charset, boundary, preamble, and epilogue. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param preamble the preamble string to use. Can be {@code null}. * @param epilogue the epilogue string to use. Can be {@code null}. * @throws IllegalArgumentException if the boundary string is {@code null}. */ public AbstractMultipartFormat(final Charset charset, final String boundary, final String preamble, final String epilogue) { super(); Args.notNull(boundary, "Multipart boundary"); this.charset = charset != null ? charset : StandardCharsets.ISO_8859_1; this.boundary = boundary; this.preamble = preamble; this.epilogue = epilogue; } public AbstractMultipartFormat(final String boundary) { this(null, boundary); } public abstract List getParts(); /** * Writes the multipart message to the specified output stream. *

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

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

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

* * @return total length of the multipart entity if known, {@code -1} * otherwise. */ public long getTotalLength() { long contentLen = 0; for (final MultipartPart part : getParts()) { final ContentBody body = part.getBody(); final long len = body.getContentLength(); if (len >= 0) { contentLen += len; } else { return -1; } } final ByteArrayOutputStream out = new ByteArrayOutputStream(); try { doWriteTo(out, false); final byte[] extra = out.toByteArray(); return contentLen + extra.length; } catch (final IOException ex) { // Should never happen return -1; } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/FormBodyPartBuilder.java0100664 0000000 0000000 00000020145 15005672035 030424 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.nio.charset.CharsetEncoder; import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.List; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.net.PercentCodec; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; /** * Builder for individual {@link org.apache.hc.client5.http.entity.mime.FormBodyPart}s. * * @since 4.4 */ public class FormBodyPartBuilder { private String name; private ContentBody body; private final Header header; /** * The multipart mode determining how filenames are encoded in the {@code Content-Disposition} * header, defaults to {@link HttpMultipartMode#STRICT}. * * @since 5.5 */ private HttpMultipartMode mode; /** * Encoder used to check if strings can be encoded in ISO-8859-1, supporting filename * compatibility determinations in multipart form data. */ private CharsetEncoder iso8859_1Encoder; /** * Creates a new builder instance with the specified name, content body, and multipart mode. * * @param name the name of the form field * @param body the content body of the part * @param mode the {@link HttpMultipartMode} to use, determining filename encoding behavior; * * @return a new {@code FormBodyPartBuilder} instance * @since 5.5 */ public static FormBodyPartBuilder create(final String name, final ContentBody body, final HttpMultipartMode mode) { return new FormBodyPartBuilder(name, body, mode); } public static FormBodyPartBuilder create(final String name, final ContentBody body) { return new FormBodyPartBuilder(name, body, HttpMultipartMode.STRICT); } public static FormBodyPartBuilder create() { return new FormBodyPartBuilder(); } FormBodyPartBuilder(final String name, final ContentBody body, final HttpMultipartMode mode) { this(); this.name = name; this.body = body; this.mode = mode != null ? mode : HttpMultipartMode.STRICT; } FormBodyPartBuilder() { this.header = new Header(); this.mode = HttpMultipartMode.STRICT; } public FormBodyPartBuilder setName(final String name) { this.name = name; return this; } public FormBodyPartBuilder setBody(final ContentBody body) { this.body = body; return this; } /** * @since 4.6 */ public FormBodyPartBuilder addField(final String name, final String value, final List parameters) { Args.notNull(name, "Field name"); this.header.addField(new MimeField(name, value, parameters)); return this; } public FormBodyPartBuilder addField(final String name, final String value) { Args.notNull(name, "Field name"); this.header.addField(new MimeField(name, value)); return this; } public FormBodyPartBuilder setField(final String name, final String value) { Args.notNull(name, "Field name"); this.header.setField(new MimeField(name, value)); return this; } public FormBodyPartBuilder removeFields(final String name) { Args.notNull(name, "Field name"); this.header.removeFields(name); return this; } /** * Determines whether the given string can be encoded in ISO-8859-1 without loss of data. * This is used to decide whether the {@code filename} parameter can be used as-is or if * the {@code filename*} parameter is needed for non-ISO-8859-1 characters. * * @param input the string to check, must not be {@code null} * @return {@code true} if the string can be encoded in ISO-8859-1, {@code false} otherwise * @since 5.5 */ private boolean canEncodeToISO8859_1(final String input) { if (iso8859_1Encoder == null) { iso8859_1Encoder = StandardCharsets.ISO_8859_1.newEncoder(); } return iso8859_1Encoder.canEncode(input); } /** * Encodes the given filename according to RFC 5987, prefixing it with {@code UTF-8''} and * applying percent-encoding to non-ASCII characters. This is used for the {@code filename*} * parameter in the {@code Content-Disposition} header when non-ISO-8859-1 characters are present. * * @param filename the filename to encode, must not be {@code null} * @return the RFC 5987-encoded string, e.g., {@code UTF-8''example%20text} * @since 5.5 */ private static String encodeRFC5987(final String filename) { return "UTF-8''" + PercentCodec.RFC5987.encode(filename); } public FormBodyPart build() { Asserts.notBlank(this.name, "Name"); Asserts.notNull(this.body, "Content body"); final Header headerCopy = new Header(); final List fields = this.header.getFields(); for (final MimeField field: fields) { headerCopy.addField(field); } if (headerCopy.getField(MimeConsts.CONTENT_DISPOSITION) == null) { final List fieldParameters = new ArrayList<>(); fieldParameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_NAME, this.name)); if (this.body.getFilename() != null) { final String filename = this.body.getFilename(); fieldParameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_FILENAME, filename)); // Add filename* only if non-ISO-8859-1 and not in LEGACY mode if (mode != HttpMultipartMode.LEGACY && !canEncodeToISO8859_1(filename)) { fieldParameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_FILENAME_START, encodeRFC5987(filename))); } } headerCopy.addField(new MimeField(MimeConsts.CONTENT_DISPOSITION, "form-data", fieldParameters)); } if (headerCopy.getField(MimeConsts.CONTENT_TYPE) == null) { final ContentType contentType; if (body instanceof AbstractContentBody) { contentType = ((AbstractContentBody) body).getContentType(); } else { contentType = null; } if (contentType != null) { headerCopy.addField(new MimeField(MimeConsts.CONTENT_TYPE, contentType.toString())); } else { final StringBuilder buffer = new StringBuilder(); buffer.append(this.body.getMimeType()); // MimeType cannot be null if (this.body.getCharset() != null) { // charset may legitimately be null buffer.append("; charset="); buffer.append(this.body.getCharset()); } headerCopy.addField(new MimeField(MimeConsts.CONTENT_TYPE, buffer.toString())); } } return new FormBodyPart(this.name, this.body, headerCopy); } }httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/ByteArrayBody.java0100664 0000000 0000000 00000005752 14666635064 027311 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * Binary body part backed by a byte array. * * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder * * @since 4.1 */ public class ByteArrayBody extends AbstractContentBody { /** * The contents of the file contained in this part. */ private final byte[] data; /** * The name of the file contained in this part. */ private final String filename; /** * @since 4.3 */ public ByteArrayBody(final byte[] data, final ContentType contentType, final String filename) { super(contentType); this.data = Args.notNull(data, "data"); this.filename = filename; } /** * Public constructor that creates a new ByteArrayBody. * * @param contentType the {@link ContentType} * @param data the array of byte. * * @since 5.2 */ public ByteArrayBody(final byte[] data, final ContentType contentType) { this(data, contentType, null); } /** * Creates a new ByteArrayBody. * * @param data The contents of the file contained in this part. * @param filename The name of the file contained in this part. */ public ByteArrayBody(final byte[] data, final String filename) { this(data, ContentType.APPLICATION_OCTET_STREAM, filename); } @Override public String getFilename() { return filename; } @Override public void writeTo(final OutputStream out) throws IOException { out.write(data); } @Override public String getCharset() { return null; } @Override public long getContentLength() { return data.length; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MultipartFormEntity.java0100664 0000000 0000000 00000007302 14704162040 030542 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.util.List; import java.util.Objects; import java.util.Set; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.ContentTooLongException; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; class MultipartFormEntity implements HttpEntity { private final AbstractMultipartFormat multipart; private final ContentType contentType; private final long contentLength; MultipartFormEntity( final AbstractMultipartFormat multipart, final ContentType contentType, final long contentLength) { super(); this.multipart = multipart; this.contentType = contentType; this.contentLength = contentLength; } AbstractMultipartFormat getMultipart() { return this.multipart; } @Override public boolean isRepeatable() { return this.contentLength != -1; } @Override public boolean isChunked() { return !isRepeatable(); } @Override public boolean isStreaming() { return !isRepeatable(); } @Override public long getContentLength() { return this.contentLength; } @Override public String getContentType() { return Objects.toString(contentType, null); } @Override public String getContentEncoding() { return null; } @Override public InputStream getContent() throws IOException { if (this.contentLength < 0) { throw new ContentTooLongException("Content length is unknown"); } else if (this.contentLength > 25 * 1024) { throw new ContentTooLongException("Content length is too long: " + this.contentLength); } final ByteArrayOutputStream outStream = new ByteArrayOutputStream(); writeTo(outStream); outStream.flush(); return new ByteArrayInputStream(outStream.toByteArray()); } @Override public void writeTo(final OutputStream outStream) throws IOException { this.multipart.writeTo(outStream); } @Override public Supplier> getTrailers() { return null; } @Override public Set getTrailerNames() { return null; } @Override public void close() throws IOException { } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/FormBodyPart.java0100664 0000000 0000000 00000004017 14666635064 027132 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import org.apache.hc.core5.util.Args; /** * FormBodyPart class represents a content body that can be used as a part of multipart encoded * entities. This class automatically populates the header with standard fields based on * the content description of the enclosed body. * * @since 4.0 */ public class FormBodyPart extends MultipartPart { private final String name; FormBodyPart(final String name, final ContentBody body, final Header header) { super(body, header); Args.notNull(name, "Name"); Args.notNull(body, "Body"); this.name = name; } public String getName() { return this.name; } @Override public void addField(final String name, final String value) { Args.notNull(name, "Field name"); super.addField(name, value); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/AbstractContentBody.java0100664 0000000 0000000 00000005102 14666635064 030472 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.nio.charset.Charset; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * * @since 4.0 */ public abstract class AbstractContentBody implements ContentBody { private final ContentType contentType; /** * @since 4.3 */ public AbstractContentBody(final ContentType contentType) { super(); Args.notNull(contentType, "Content type"); this.contentType = contentType; } /** * @since 4.3 */ public ContentType getContentType() { return this.contentType; } @Override public String getMimeType() { return this.contentType.getMimeType(); } @Override public String getMediaType() { final String mimeType = this.contentType.getMimeType(); final int i = mimeType.indexOf('/'); if (i != -1) { return mimeType.substring(0, i); } return mimeType; } @Override public String getSubType() { final String mimeType = this.contentType.getMimeType(); final int i = mimeType.indexOf('/'); if (i != -1) { return mimeType.substring(i + 1); } return null; } @Override public String getCharset() { final Charset charset = this.contentType.getCharset(); return charset != null ? charset.name() : null; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MimeField.java0100664 0000000 0000000 00000010004 14704162040 026364 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.util.ArrayList; import java.util.Collections; import java.util.List; import org.apache.hc.core5.http.NameValuePair; /** * Minimal MIME field. * * @since 4.0 */ public class MimeField { private final String name; private final String value; private final List parameters; /** * Constructs a new instance. * * @param name the field name. * @param value the field value. */ public MimeField(final String name, final String value) { super(); this.name = name; this.value = value; this.parameters = Collections.emptyList(); } /** * Constructs a new instance. * * @param name the field name. * @param value the field value. * @param parameters the field parameters. * @since 4.6 */ public MimeField(final String name, final String value, final List parameters) { this.name = name; this.value = value; this.parameters = parameters != null ? Collections.unmodifiableList(new ArrayList<>(parameters)) : Collections.emptyList(); } /** * Constructs a new instance by copying another's properties. * * @param from the source field. */ public MimeField(final MimeField from) { this(from.name, from.value, from.parameters); } /** * Gets the field name. * * @return the field name. */ public String getName() { return this.name; } /** * Gets the field value. * * @return the field value. * @since 4.6 */ public String getValue() { return this.value; } /** * Converts this instance to a body String. * * @return this instance as a body String. */ public String getBody() { final StringBuilder sb = new StringBuilder(); sb.append(this.value); parameters.forEach(parameter -> { sb.append("; "); sb.append(parameter.getName()); sb.append("=\""); final String v = parameter.getValue(); for (int n = 0; n < v.length(); n++) { final char ch = v.charAt(n); if (ch == '"' || ch == '\\' ) { sb.append("\\"); } sb.append(ch); } sb.append("\""); }); return sb.toString(); } /** * Gets the field parameters. * * @return the field parameters. */ public List getParameters() { return this.parameters; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append(this.name); buffer.append(": "); buffer.append(this.getBody()); return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/HttpRFC6532Multipart.java0100664 0000000 0000000 00000006320 14666635064 030255 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.util.List; class HttpRFC6532Multipart extends AbstractMultipartFormat { private final List parts; /** * Constructs a new instance of {@code HttpRFC6532Multipart}. * * @param charset The charset to use for the message. * @param boundary The boundary string to use for the message. * @param parts The list of parts that make up the message. * @param preamble The preamble to include at the beginning of the message, or {@code null} if none. * @param epilogue The epilogue to include at the end of the message, or {@code null} if none. */ public HttpRFC6532Multipart( final Charset charset, final String boundary, final List parts, final String preamble, final String epilogue) { super(charset, boundary, preamble, epilogue); this.parts = parts; } /** * Constructs a new instance of {@code HttpRFC6532Multipart} with the given charset, boundary, and parts. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param parts the list of parts to include in the multipart message. */ public HttpRFC6532Multipart( final Charset charset, final String boundary, final List parts) { this(charset,boundary,parts,null, null); } @Override public List getParts() { return this.parts; } @Override protected void formatMultipartHeader( final MultipartPart part, final OutputStream out) throws IOException { // For RFC6532, we output all fields with UTF-8 encoding. final Header header = part.getHeader(); for (final MimeField field: header) { writeField(field, StandardCharsets.UTF_8, out); } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MultipartPart.java0100664 0000000 0000000 00000004072 14666635064 027373 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; /** * MultipartPart class represents a content body that can be used as a part of multipart encoded * entities. This class automatically populates the header with standard fields based on * the content description of the enclosed body. * * @since 5.0 */ public class MultipartPart { private final Header header; private final ContentBody body; MultipartPart(final ContentBody body, final Header header) { super(); this.body = body; this.header = header != null ? header : new Header(); } public ContentBody getBody() { return this.body; } public Header getHeader() { return this.header; } void addField(final String name, final String value) { addField(new MimeField(name, value)); } void addField(final MimeField field) { this.header.addField(field); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MultipartEntityBuilder.java0100664 0000000 0000000 00000027555 15063503632 031246 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.File; import java.io.InputStream; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.UUID; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Builder for multipart {@link HttpEntity}s. *

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

*

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

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

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

*

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

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

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

*/ private String getRandomBoundary() { return BOUNDARY_PREFIX + UUID.randomUUID(); } /** * Adds a preamble to the multipart entity being constructed. The preamble is the text that appears before the first * boundary delimiter. The preamble is optional and may be null. * * @param preamble The preamble text to add to the multipart entity * @return this instance. * * @since 5.3 */ public MultipartEntityBuilder addPreamble(final String preamble) { this.preamble = preamble; return this; } /** * Adds an epilogue to the multipart entity being constructed. The epilogue is the text that appears after the last * boundary delimiter. The epilogue is optional and may be null. * * @param epilogue The epilogue text to add to the multipart entity * @return this instance. * @since 5.3 */ public MultipartEntityBuilder addEpilogue(final String epilogue) { this.epilogue = epilogue; return this; } MultipartFormEntity buildEntity() { String boundaryCopy = boundary; if (boundaryCopy == null && contentType != null) { boundaryCopy = contentType.getParameter("boundary"); } if (boundaryCopy == null) { boundaryCopy = getRandomBoundary(); } Charset charsetCopy = charset; if (charsetCopy == null && contentType != null) { charsetCopy = contentType.getCharset(); } final NameValuePair[] params = new NameValuePair[]{new BasicNameValuePair("boundary", boundaryCopy)}; final ContentType contentTypeCopy; if (contentType != null) { contentTypeCopy = contentType.withParameters(params); } else { boolean formData = false; if (multipartParts != null) { for (final MultipartPart multipartPart : multipartParts) { if (multipartPart instanceof FormBodyPart) { formData = true; break; } } } if (formData) { contentTypeCopy = ContentType.MULTIPART_FORM_DATA.withParameters(params); } else { contentTypeCopy = ContentType.create("multipart/mixed", params); } } final List multipartPartsCopy = multipartParts != null ? new ArrayList<>(multipartParts) : Collections.emptyList(); final HttpMultipartMode modeCopy = mode != null ? mode : HttpMultipartMode.STRICT; final AbstractMultipartFormat form; switch (modeCopy) { case LEGACY: form = new LegacyMultipart(charsetCopy, boundaryCopy, multipartPartsCopy); break; case EXTENDED: if (contentTypeCopy.isSameMimeType(ContentType.MULTIPART_FORM_DATA)) { if (charsetCopy == null) { charsetCopy = StandardCharsets.UTF_8; } form = new HttpRFC7578Multipart(charsetCopy, boundaryCopy, multipartPartsCopy, preamble, epilogue, modeCopy); } else { form = new HttpRFC6532Multipart(charsetCopy, boundaryCopy, multipartPartsCopy, preamble, epilogue); } break; default: form = new HttpStrictMultipart(StandardCharsets.US_ASCII, boundaryCopy, multipartPartsCopy, preamble, epilogue); } return new MultipartFormEntity(form, contentTypeCopy, form.getTotalLength()); } public HttpEntity build() { return buildEntity(); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/Header.java0100664 0000000 0000000 00000010477 14666635064 025761 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; import java.util.Iterator; import java.util.LinkedList; import java.util.List; import java.util.Locale; import java.util.Map; /** * The header of a MIME entity. */ public class Header implements Iterable { private final List fields; private final Map> fieldMap; public Header() { super(); this.fields = new LinkedList<>(); this.fieldMap = new HashMap<>(); } public void addField(final MimeField field) { if (field == null) { return; } final String key = field.getName().toLowerCase(Locale.ROOT); final List values = this.fieldMap.computeIfAbsent(key, k -> new LinkedList<>()); values.add(field); this.fields.add(field); } public List getFields() { return new ArrayList<>(this.fields); } public MimeField getField(final String name) { if (name == null) { return null; } final String key = name.toLowerCase(Locale.ROOT); final List list = this.fieldMap.get(key); if (list != null && !list.isEmpty()) { return list.get(0); } return null; } public List getFields(final String name) { if (name == null) { return null; } final String key = name.toLowerCase(Locale.ROOT); final List list = this.fieldMap.get(key); if (list == null || list.isEmpty()) { return Collections.emptyList(); } return new ArrayList<>(list); } public int removeFields(final String name) { if (name == null) { return 0; } final String key = name.toLowerCase(Locale.ROOT); final List removed = fieldMap.remove(key); if (removed == null || removed.isEmpty()) { return 0; } this.fields.removeAll(removed); return removed.size(); } public void setField(final MimeField field) { if (field == null) { return; } final String key = field.getName().toLowerCase(Locale.ROOT); final List list = fieldMap.get(key); if (list == null || list.isEmpty()) { addField(field); return; } list.clear(); list.add(field); int firstOccurrence = -1; int index = 0; for (final Iterator it = this.fields.iterator(); it.hasNext(); index++) { final MimeField f = it.next(); if (f.getName().equalsIgnoreCase(field.getName())) { it.remove(); if (firstOccurrence == -1) { firstOccurrence = index; } } } this.fields.add(firstOccurrence, field); } @Override public Iterator iterator() { return Collections.unmodifiableList(fields).iterator(); } @Override public String toString() { return this.fields.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/StringBody.java0100664 0000000 0000000 00000005230 14666635064 026644 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStreamReader; import java.io.OutputStream; import java.io.Reader; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * Text body part backed by a byte array. * * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder * * @since 4.0 */ public class StringBody extends AbstractContentBody { private final byte[] content; /** * @since 4.3 */ public StringBody(final String text, final ContentType contentType) { super(contentType); Args.notNull(text, "Text"); final Charset charset = contentType.getCharset(); this.content = text.getBytes(charset != null ? charset : StandardCharsets.US_ASCII); } public Reader getReader() { final Charset charset = getContentType().getCharset(); return new InputStreamReader( new ByteArrayInputStream(this.content), charset != null ? charset : StandardCharsets.US_ASCII); } @Override public void writeTo(final OutputStream out) throws IOException { Args.notNull(out, "Output stream"); out.write(this.content); } @Override public long getContentLength() { return this.content.length; } @Override public String getFilename() { return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/LegacyMultipart.java0100664 0000000 0000000 00000005251 14666635064 027671 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; import java.nio.charset.Charset; import java.util.List; /** * HttpBrowserCompatibleMultipart represents a collection of MIME multipart encoded * content bodies. This class is emulates browser compatibility, e.g. IE 5 or earlier. * * @since 4.3 */ class LegacyMultipart extends AbstractMultipartFormat { private final List parts; public LegacyMultipart( final Charset charset, final String boundary, final List parts) { super(charset, boundary); this.parts = parts; } @Override public List getParts() { return this.parts; } /** * Write the multipart header fields; depends on the style. */ @Override protected void formatMultipartHeader( final MultipartPart part, final OutputStream out) throws IOException { // For browser-compatible, only write Content-Disposition // Use content charset final Header header = part.getHeader(); final MimeField cd = header.getField(MimeConsts.CONTENT_DISPOSITION); if (cd != null) { writeField(cd, this.charset, out); } final String filename = part.getBody().getFilename(); if (filename != null) { final MimeField ct = header.getField(MimeConsts.CONTENT_TYPE); writeField(ct, this.charset, out); } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/HttpStrictMultipart.java0100664 0000000 0000000 00000006114 14666635064 030574 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; import java.nio.charset.Charset; import java.util.List; class HttpStrictMultipart extends AbstractMultipartFormat { private final List parts; /** * Constructs a new instance of {@code HttpStrictMultipart} with the given charset, boundary, and parts. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param parts the list of parts to include in the multipart message. */ public HttpStrictMultipart( final Charset charset, final String boundary, final List parts) { this(charset,boundary,parts,null, null); } /** * Constructs a new instance of {@code HttpStrictMultipart} with the given charset, boundary, parts, preamble, and epilogue. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param parts the list of parts to include in the multipart message. * @param preamble the preamble string to use. * @param epilogue the epilogue string to use. */ public HttpStrictMultipart( final Charset charset, final String boundary, final List parts, final String preamble, final String epilogue) { super(charset, boundary, preamble, epilogue); this.parts = parts; } @Override public List getParts() { return this.parts; } @Override protected void formatMultipartHeader( final MultipartPart part, final OutputStream out) throws IOException { // For strict, we output all fields with MIME-standard encoding. final Header header = part.getHeader(); for (final MimeField field: header) { writeField(field, out); } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MimeConsts.java0100664 0000000 0000000 00000003077 15005672016 026632 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; final class MimeConsts { public static final String CONTENT_TYPE = "Content-Type"; public static final String CONTENT_DISPOSITION = "Content-Disposition"; public static final String FIELD_PARAM_NAME = "name"; public static final String FIELD_PARAM_FILENAME = "filename"; public static final String FIELD_PARAM_FILENAME_START = "filename*"; } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/HttpMultipartMode.java0100664 0000000 0000000 00000003563 14666635064 030215 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; /** * MIME compliance mode. * * @since 4.0 */ public enum HttpMultipartMode { /** * Legacy compatibility mode. *

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

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

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

* Presently conforms to RFC 6532 and RFC 7578. */ EXTENDED, } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/HttpRFC7578Multipart.java0100664 0000000 0000000 00000012402 15063503632 030251 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.util.List; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.net.PercentCodec; class HttpRFC7578Multipart extends AbstractMultipartFormat { private final List parts; private final HttpMultipartMode mode; /** * Constructs a new instance of {@code HttpRFC7578Multipart} with the given charset, boundary, parts, preamble, and epilogue. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param parts the list of parts to include in the multipart message. * @param preamble the optional preamble string to include before the first part. May be {@code null}. * @param epilogue the optional epilogue string to include after the last part. May be {@code null}. */ public HttpRFC7578Multipart( final Charset charset, final String boundary, final List parts, final String preamble, final String epilogue, final HttpMultipartMode mode) { super(charset, boundary, preamble, epilogue); this.parts = parts; this.mode = mode != null ? mode : HttpMultipartMode.STRICT; // Default to STRICT } /** * Constructs a new instance of {@code HttpRFC7578Multipart} with the given charset, boundary, and parts. * * @param charset the charset to use. * @param boundary the boundary string to use. * @param parts the list of parts to include in the multipart message. */ public HttpRFC7578Multipart( final Charset charset, final String boundary, final List parts, final HttpMultipartMode mode) { this(charset,boundary,parts,null, null, mode); } @Override public List getParts() { return parts; } @Override protected void formatMultipartHeader(final MultipartPart part, final OutputStream out) throws IOException { for (final MimeField field: part.getHeader()) { if (MimeConsts.CONTENT_DISPOSITION.equalsIgnoreCase(field.getName())) { writeBytes(field.getName(), charset, out); writeBytes(FIELD_SEP, out); writeBytes(field.getValue(), out); final List parameters = field.getParameters(); for (int i = 0; i < parameters.size(); i++) { final NameValuePair parameter = parameters.get(i); final String name = parameter.getName(); final String value = parameter.getValue(); writeBytes("; ", out); writeBytes(name, out); writeBytes("=\"", out); if (value != null) { if (name.equalsIgnoreCase(MimeConsts.FIELD_PARAM_FILENAME_START)) { final String encodedValue = "UTF-8''" + PercentCodec.RFC5987.encode(value); writeBytes(encodedValue, StandardCharsets.US_ASCII, out); } else if (name.equalsIgnoreCase(MimeConsts.FIELD_PARAM_FILENAME)) { if (mode == HttpMultipartMode.EXTENDED) { final String encodedValue = PercentCodec.RFC5987.encode(value); writeBytes(encodedValue, StandardCharsets.US_ASCII, out); } else { // Default to ISO-8859-1 for RFC 7578 compliance in STRICT/LEGACY writeBytes(value, StandardCharsets.ISO_8859_1, out); } } else { writeBytes(value, out); } } writeBytes("\"", out); } writeBytes(CR_LF, out); } else { writeField(field, charset, out); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/ContentDescriptor.java0100664 0000000 0000000 00000005645 14666635064 030243 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; /** * Represents common content properties. */ public interface ContentDescriptor { /** * Returns the body descriptors MIME type. * @see #getMediaType() * @see #getSubType() * @return The MIME type, which has been parsed from the * content-type definition. Must not be null, but * "text/plain", if no content-type was specified. */ String getMimeType(); /** * Gets the defaulted MIME media type for this content. * For example {@code TEXT}, {@code IMAGE}, {@code MULTIPART} * @see #getMimeType() * @return the MIME media type when content-type specified, * otherwise the correct default ({@code TEXT}) */ String getMediaType(); /** * Gets the defaulted MIME sub type for this content. * @see #getMimeType() * @return the MIME media type when content-type is specified, * otherwise the correct default ({@code PLAIN}) */ String getSubType(); /** *

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

*

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

* @return Character set, which has been parsed from the * content-type definition. Not null for {@code TEXT} types, when unset will * be set to default {@code us-ascii}. For other types, when unset, * null will be returned. */ String getCharset(); /** * Returns the body descriptors content-length. * @return Content length, if known, or -1, to indicate the absence of a * content-length header. */ long getContentLength(); } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/InputStreamBody.java0100664 0000000 0000000 00000006234 14666635064 027656 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * Binary body part backed by an input stream. * * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder * * @since 4.0 */ public class InputStreamBody extends AbstractContentBody { private final InputStream in; private final String filename; private final long contentLength; public InputStreamBody(final InputStream in, final String filename) { this(in, ContentType.DEFAULT_BINARY, filename); } /** * @since 4.3 */ public InputStreamBody(final InputStream in, final ContentType contentType, final String filename) { this(in, contentType, filename, -1); } /** * @since 4.6 */ public InputStreamBody(final InputStream in, final ContentType contentType, final String filename, final long contentLength) { super(contentType); Args.notNull(in, "Input stream"); this.in = in; this.filename = filename; this.contentLength = contentLength >= 0 ? contentLength : -1; } /** * @since 4.3 */ public InputStreamBody(final InputStream in, final ContentType contentType) { this(in, contentType, null); } public InputStream getInputStream() { return this.in; } @Override public void writeTo(final OutputStream out) throws IOException { Args.notNull(out, "Output stream"); try { final byte[] tmp = new byte[4096]; int l; while ((l = this.in.read(tmp)) != -1) { out.write(tmp, 0, l); } out.flush(); } finally { this.in.close(); } } @Override public long getContentLength() { return this.contentLength; } @Override public String getFilename() { return this.filename; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/ContentBody.java0100664 0000000 0000000 00000002664 14666635064 027020 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.IOException; import java.io.OutputStream; /** * * @since 4.0 */ public interface ContentBody extends ContentDescriptor { String getFilename(); void writeTo(OutputStream out) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/FileBody.java0100664 0000000 0000000 00000005774 14666635064 026272 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.util.Args; /** * Binary body part backed by a file. * * @see org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder * * @since 4.0 */ public class FileBody extends AbstractContentBody { private final File file; private final String filename; public FileBody(final File file) { this(file, ContentType.DEFAULT_BINARY, file != null ? file.getName() : null); } /** * @since 4.3 */ public FileBody(final File file, final ContentType contentType, final String filename) { super(contentType); Args.notNull(file, "File"); this.file = file; this.filename = filename == null ? file.getName() : filename; } /** * @since 4.3 */ public FileBody(final File file, final ContentType contentType) { this(file, contentType, file != null ? file.getName() : null); } public InputStream getInputStream() throws IOException { return new FileInputStream(this.file); } @Override public void writeTo(final OutputStream out) throws IOException { Args.notNull(out, "Output stream"); try (InputStream in = new FileInputStream(this.file)) { final byte[] tmp = new byte[4096]; int l; while ((l = in.read(tmp)) != -1) { out.write(tmp, 0, l); } out.flush(); } } @Override public long getContentLength() { return this.file.length(); } @Override public String getFilename() { return filename; } public File getFile() { return this.file; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/mime/MultipartPartBuilder.java0100664 0000000 0000000 00000010324 14666635064 030677 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.util.List; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; /** * Builder for individual {@link MultipartPart}s. * * @since 4.4 */ public class MultipartPartBuilder { private ContentBody body; private final Header header; public static MultipartPartBuilder create(final ContentBody body) { return new MultipartPartBuilder(body); } public static MultipartPartBuilder create() { return new MultipartPartBuilder(); } MultipartPartBuilder(final ContentBody body) { this(); this.body = body; } MultipartPartBuilder() { this.header = new Header(); } public MultipartPartBuilder setBody(final ContentBody body) { this.body = body; return this; } public MultipartPartBuilder addHeader(final String name, final String value, final List parameters) { Args.notNull(name, "Header name"); this.header.addField(new MimeField(name, value, parameters)); return this; } public MultipartPartBuilder addHeader(final String name, final String value) { Args.notNull(name, "Header name"); this.header.addField(new MimeField(name, value)); return this; } public MultipartPartBuilder setHeader(final String name, final String value) { Args.notNull(name, "Header name"); this.header.setField(new MimeField(name, value)); return this; } public MultipartPartBuilder removeHeaders(final String name) { Args.notNull(name, "Header name"); this.header.removeFields(name); return this; } public MultipartPart build() { Asserts.notNull(this.body, "Content body"); final Header headerCopy = new Header(); final List fields = this.header.getFields(); for (final MimeField field: fields) { headerCopy.addField(field); } if (headerCopy.getField(MimeConsts.CONTENT_TYPE) == null) { final ContentType contentType; if (body instanceof AbstractContentBody) { contentType = ((AbstractContentBody) body).getContentType(); } else { contentType = null; } if (contentType != null) { headerCopy.addField(new MimeField(MimeConsts.CONTENT_TYPE, contentType.toString())); } else { final StringBuilder buffer = new StringBuilder(); buffer.append(this.body.getMimeType()); // MimeType cannot be null if (this.body.getCharset() != null) { // charset may legitimately be null buffer.append("; charset="); buffer.append(this.body.getCharset()); } headerCopy.addField(new MimeField(MimeConsts.CONTENT_TYPE, buffer.toString())); } } return new MultipartPart(this.body, headerCopy); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/GZIPInputStreamFactory.java0100664 0000000 0000000 00000004151 15063503632 030112 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; import java.util.zip.GZIPInputStream; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * {@link InputStreamFactory} for handling GZIPContent Coded responses. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class GZIPInputStreamFactory implements InputStreamFactory { /** * Default instance of {@link GZIPInputStreamFactory}. */ private static final GZIPInputStreamFactory INSTANCE = new GZIPInputStreamFactory(); /** * Gets the singleton instance. * * @return the singleton instance. */ public static GZIPInputStreamFactory getInstance() { return INSTANCE; } @Override public InputStream create(final InputStream inputStream) throws IOException { return new GZIPInputStream(inputStream); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/LazyDecompressingInputStream.java0100664 0000000 0000000 00000006242 15063503632 031456 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.FilterInputStream; import java.io.IOException; import java.io.InputStream; import java.io.UncheckedIOException; import org.apache.hc.core5.io.Closer; /** * Lazy initializes from an {@link InputStream} wrapper. */ class LazyDecompressingInputStream extends FilterInputStream { private final InputStreamFactory inputStreamFactory; private InputStream wrapperStream; public LazyDecompressingInputStream( final InputStream wrappedStream, final InputStreamFactory inputStreamFactory) { super(wrappedStream); this.inputStreamFactory = inputStreamFactory; } private InputStream initWrapper() throws IOException { if (wrapperStream == null) { wrapperStream = inputStreamFactory.create(in); } return wrapperStream; } @Override public int read() throws IOException { return initWrapper().read(); } @Override public int read(final byte[] b) throws IOException { return initWrapper().read(b); } @Override public int read(final byte[] b, final int off, final int len) throws IOException { return initWrapper().read(b, off, len); } @Override public long skip(final long n) throws IOException { return initWrapper().skip(n); } @Override public boolean markSupported() { return false; } @Override public int available() throws IOException { return initWrapper().available(); } @Override public void close() throws IOException { try { Closer.close(wrapperStream); } finally { super.close(); } } @Override public void mark(final int readlimit) { try { initWrapper().mark(readlimit); } catch (final IOException e) { throw new UncheckedIOException(e); } } @Override public void reset() throws IOException { initWrapper().reset(); } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/InputStreamFactory.java0100664 0000000 0000000 00000002673 15063503632 027427 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; /** * Factory for decorated {@link InputStream}s. * * @since 4.4 */ public interface InputStreamFactory { InputStream create(InputStream inputStream) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/entity/DecompressingEntity.java0100664 0000000 0000000 00000006720 15063503632 027620 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.HttpEntityWrapper; import org.apache.hc.core5.util.Args; /** * Common base class for decompressing {@link HttpEntity} implementations. * * @since 4.4 */ public class DecompressingEntity extends HttpEntityWrapper { /** * Default buffer size. */ private static final int BUFFER_SIZE = 1024 * 2; private final InputStreamFactory inputStreamFactory; /** * {@link #getContent()} method must return the same {@link InputStream} * instance when DecompressingEntity is wrapping a streaming entity. */ private InputStream content; /** * Constructs a new {@link DecompressingEntity}. * * @param wrapped the non-null {@link HttpEntity} to be wrapped * @param inputStreamFactory factory to create decompressing stream. */ public DecompressingEntity( final HttpEntity wrapped, final InputStreamFactory inputStreamFactory) { super(wrapped); this.inputStreamFactory = inputStreamFactory; } private InputStream getDecompressingStream() throws IOException { return new LazyDecompressingInputStream(super.getContent(), inputStreamFactory); } @Override public InputStream getContent() throws IOException { if (super.isStreaming()) { if (content == null) { content = getDecompressingStream(); } return content; } return getDecompressingStream(); } @Override public void writeTo(final OutputStream outStream) throws IOException { Args.notNull(outStream, "Output stream"); try (InputStream inStream = getContent()) { final byte[] buffer = new byte[BUFFER_SIZE]; int l; while ((l = inStream.read(buffer)) != -1) { outStream.write(buffer, 0, l); } } } @Override public String getContentEncoding() { /* Content encoding is now 'identity' */ return null; } @Override public long getContentLength() { /* length of decompressed content is not known */ return -1; } } httpclient5/src/main/java/org/apache/hc/client5/http/entity/BrotliInputStreamFactory.java0100664 0000000 0000000 00000004027 15063503632 030576 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.IOException; import java.io.InputStream; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.brotli.dec.BrotliInputStream; /** * {@link InputStreamFactory} for handling Brotli Content Coded responses. * * @since 5.2 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BrotliInputStreamFactory implements InputStreamFactory { /** * Default instance of {@link BrotliInputStreamFactory}. */ private static final BrotliInputStreamFactory INSTANCE = new BrotliInputStreamFactory(); public static BrotliInputStreamFactory getInstance() { return INSTANCE; } @Override public InputStream create(final InputStream inputStream) throws IOException { return new BrotliInputStream(inputStream); } } httpclient5/src/main/java/org/apache/hc/client5/http/SystemDefaultDnsResolver.java0100664 0000000 0000000 00000006351 14740035240 027261 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.IDN; import java.net.InetAddress; import java.net.UnknownHostException; import org.apache.hc.core5.util.TextUtils; /** * DNS resolver that uses the default OS implementation for resolving host names. * * @since 4.2 */ public class SystemDefaultDnsResolver implements DnsResolver { /** * Default instance of {@link SystemDefaultDnsResolver}. */ public static final SystemDefaultDnsResolver INSTANCE = new SystemDefaultDnsResolver(); @Override public InetAddress[] resolve(final String host) throws UnknownHostException { try { String normalizedHost; if (TextUtils.isAllASCII(host)) { normalizedHost = host; } else { try { normalizedHost = IDN.toASCII(host); } catch (final IllegalArgumentException e) { normalizedHost = host; // Fall back to original hostname } } // Try resolving using the default resolver return InetAddress.getAllByName(normalizedHost); } catch (final UnknownHostException e) { // If default resolver fails, try stripping the IPv6 zone ID and resolving again String strippedHost = null; if (host.charAt(0) == '[') { final int i = host.lastIndexOf('%'); if (i != -1) { strippedHost = host.substring(0, i) + "]"; } } if (strippedHost != null) { return InetAddress.getAllByName(strippedHost); } throw e; } } @Override public String resolveCanonicalHostname(final String host) throws UnknownHostException { if (host == null) { return null; } final InetAddress in = InetAddress.getByName(host); final String canonicalServer = in.getCanonicalHostName(); if (in.getHostAddress().contentEquals(canonicalServer)) { return host; } return canonicalServer; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/0040775 0000000 0000000 00000000000 15063503632 022401 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultUserTokenHandler.java0100664 0000000 0000000 00000010566 14704162040 027766 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.security.Principal; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; /** * Default implementation of {@link UserTokenHandler}. This class will use * an instance of {@link Principal} as a state object for HTTP connections, * if it can be obtained from the given execution context. This helps ensure * persistent connections created with a particular user identity within * a particular security context can be reused by the same user only. *

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

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultUserTokenHandler implements UserTokenHandler { /** * Default instance of {@link DefaultUserTokenHandler}. */ public static final DefaultUserTokenHandler INSTANCE = new DefaultUserTokenHandler(); @Override public Object getUserToken(final HttpRoute route, final HttpContext context) { return getUserToken(route, null, context); } @Override public Object getUserToken(final HttpRoute route, final HttpRequest request, final HttpContext context) { final HttpClientContext clientContext = HttpClientContext.cast(context); final HttpHost target = request != null ? new HttpHost(request.getScheme(), request.getAuthority()) : route.getTargetHost(); final AuthExchange targetAuthExchange = clientContext.getAuthExchange(target); if (targetAuthExchange != null) { final Principal authPrincipal = getAuthPrincipal(targetAuthExchange); if (authPrincipal != null) { return authPrincipal; } } final HttpHost proxy = route.getProxyHost(); if (proxy != null) { final AuthExchange proxyAuthExchange = clientContext.getAuthExchange(proxy); if (proxyAuthExchange != null) { final Principal authPrincipal = getAuthPrincipal(proxyAuthExchange); if (authPrincipal != null) { return authPrincipal; } } } final SSLSession sslSession = clientContext.getSSLSession(); if (sslSession != null) { return sslSession.getLocalPrincipal(); } return null; } private static Principal getAuthPrincipal(final AuthExchange authExchange) { final AuthScheme scheme = authExchange.getAuthScheme(); if (scheme != null && scheme.isConnectionBased()) { return scheme.getPrincipal(); } return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/CookieSpecSupport.java0100664 0000000 0000000 00000006606 15005672016 026671 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.StandardCookieSpec; import org.apache.hc.client5.http.impl.cookie.IgnoreCookieSpecFactory; import org.apache.hc.client5.http.impl.cookie.RFC6265CookieSpecFactory; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.apache.hc.client5.http.psl.PublicSuffixMatcherLoader; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; /** * Cookie support methods. * * @since 5.0 */ @Internal public final class CookieSpecSupport { /** * Creates a builder containing the default registry entries, using the provided public suffix matcher. */ public static RegistryBuilder createDefaultBuilder(final PublicSuffixMatcher publicSuffixMatcher) { return RegistryBuilder.create() .register(StandardCookieSpec.RELAXED, new RFC6265CookieSpecFactory( RFC6265CookieSpecFactory.CompatibilityLevel.RELAXED, publicSuffixMatcher)) .register(StandardCookieSpec.STRICT, new RFC6265CookieSpecFactory( RFC6265CookieSpecFactory.CompatibilityLevel.STRICT, publicSuffixMatcher)) .register(StandardCookieSpec.IGNORE, new IgnoreCookieSpecFactory()); } /** * Creates a builder containing the default registry entries with the default public suffix matcher. */ public static RegistryBuilder createDefaultBuilder() { return createDefaultBuilder(PublicSuffixMatcherLoader.getDefault()); } /** * Creates the default registry, using the default public suffix matcher. */ public static Lookup createDefault() { return createDefault(PublicSuffixMatcherLoader.getDefault()); } /** * Creates the default registry with the provided public suffix matcher */ public static Lookup createDefault(final PublicSuffixMatcher publicSuffixMatcher) { return createDefaultBuilder(publicSuffixMatcher).build(); } private CookieSpecSupport() { } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/0040775 0000000 0000000 00000000000 15063503637 023347 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/package-info.java0100664 0000000 0000000 00000002413 14666635064 026543 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Standard and common HTTP authentication schemes. */ package org.apache.hc.client5.http.impl.auth; httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/NTLMSchemeFactory.java0100664 0000000 0000000 00000004367 14704162040 027436 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link NTLMScheme} instances configured to use the default {@link NTLMEngine} * implementation. * * @since 4.1 * @deprecated Do not use. the NTLM authentication scheme is no longer supported. * Consider using Basic or Bearer authentication with TLS instead. * * @see BasicSchemeFactory * @see BearerSchemeFactory */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public class NTLMSchemeFactory implements AuthSchemeFactory { /** * Default instance of {@link NTLMSchemeFactory}. */ public static final NTLMSchemeFactory INSTANCE = new NTLMSchemeFactory(); @Override public AuthScheme create(final HttpContext context) { return new NTLMScheme(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BasicCredentialsProvider.java0100664 0000000 0000000 00000005151 14666635064 031133 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsStore; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** * Default implementation of {@link CredentialsStore}. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.SAFE) public class BasicCredentialsProvider implements CredentialsStore { private final ConcurrentHashMap credMap; /** * Default constructor. */ public BasicCredentialsProvider() { super(); this.credMap = new ConcurrentHashMap<>(); } @Override public void setCredentials( final AuthScope authScope, final Credentials credentials) { Args.notNull(authScope, "Authentication scope"); credMap.put(authScope, credentials); } @Override public Credentials getCredentials(final AuthScope authScope, final HttpContext context) { return CredentialsMatcher.matchCredentials(this.credMap, authScope); } @Override public void clear() { this.credMap.clear(); } @Override public String toString() { return credMap.keySet().toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BearerSchemeFactory.java0100664 0000000 0000000 00000004040 14704162040 030050 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link BearerScheme} instances. * * @since 5.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BearerSchemeFactory implements AuthSchemeFactory { /** * Default instance of {@link BearerSchemeFactory}. */ public static final BearerSchemeFactory INSTANCE = new BearerSchemeFactory(); public BearerSchemeFactory() { super(); } @Override public AuthScheme create(final HttpContext context) { return new BearerScheme(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/HttpEntityDigester.java0100664 0000000 0000000 00000004523 14666635064 030026 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.IOException; import java.io.OutputStream; import java.security.MessageDigest; class HttpEntityDigester extends OutputStream { private final MessageDigest digester; private boolean closed; private byte[] digest; HttpEntityDigester(final MessageDigest digester) { super(); this.digester = digester; this.digester.reset(); } @Override public void write(final int b) throws IOException { if (this.closed) { throw new IOException("Stream has been already closed"); } this.digester.update((byte) b); } @Override public void write(final byte[] b, final int off, final int len) throws IOException { if (this.closed) { throw new IOException("Stream has been already closed"); } this.digester.update(b, off, len); } @Override public void close() throws IOException { if (this.closed) { return; } this.closed = true; this.digest = this.digester.digest(); super.close(); } public byte[] getDigest() { return this.digest; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BasicAuthCache.java0100664 0000000 0000000 00000016455 14704162040 026777 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.Serializable; import java.util.Locale; import java.util.Map; import java.util.Objects; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.StateHolder; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.LangUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Default implementation of {@link AuthCache}. This implements * expects {@link AuthScheme} to be {@link Serializable} * in order to be cacheable. *

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

* * @since 4.1 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public class BasicAuthCache implements AuthCache { private static final Logger LOG = LoggerFactory.getLogger(BasicAuthCache.class); static class Key { final String scheme; final String host; final int port; final String pathPrefix; Key(final String scheme, final String host, final int port, final String pathPrefix) { Args.notBlank(scheme, "Scheme"); Args.notBlank(host, "Scheme"); this.scheme = scheme.toLowerCase(Locale.ROOT); this.host = host.toLowerCase(Locale.ROOT); this.port = port; this.pathPrefix = pathPrefix; } @Override public boolean equals(final Object obj) { if (this == obj) { return true; } if (obj instanceof Key) { final Key that = (Key) obj; return this.scheme.equals(that.scheme) && this.host.equals(that.host) && this.port == that.port && Objects.equals(this.pathPrefix, that.pathPrefix); } return false; } @Override public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.scheme); hash = LangUtils.hashCode(hash, this.host); hash = LangUtils.hashCode(hash, this.port); hash = LangUtils.hashCode(hash, this.pathPrefix); return hash; } @Override public String toString() { final StringBuilder buf = new StringBuilder(); buf.append(scheme).append("://").append(host); if (port >= 0) { buf.append(":").append(port); } if (pathPrefix != null) { if (!pathPrefix.startsWith("/")) { buf.append("/"); } buf.append(pathPrefix); } return buf.toString(); } } static class AuthData { final Class clazz; final Object state; public AuthData(final Class clazz, final Object state) { this.clazz = clazz; this.state = state; } } private final Map map; private final SchemePortResolver schemePortResolver; /** * Default constructor. * * @since 4.3 */ public BasicAuthCache(final SchemePortResolver schemePortResolver) { super(); this.map = new ConcurrentHashMap<>(); this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; } public BasicAuthCache() { this(null); } private Key key(final String scheme, final NamedEndpoint authority, final String pathPrefix) { return new Key(scheme, authority.getHostName(), schemePortResolver.resolve(scheme, authority), pathPrefix); } private AuthData data(final AuthScheme authScheme) { return new AuthData(authScheme.getClass(), ((StateHolder) authScheme).store()); } @Override public void put(final HttpHost host, final AuthScheme authScheme) { put(host, null, authScheme); } @Override public AuthScheme get(final HttpHost host) { return get(host, null); } @Override public void remove(final HttpHost host) { remove(host, null); } @Override public void put(final HttpHost host, final String pathPrefix, final AuthScheme authScheme) { Args.notNull(host, "HTTP host"); if (authScheme == null) { return; } if (authScheme instanceof StateHolder) { this.map.put(key(host.getSchemeName(), host, pathPrefix), data(authScheme)); } else { if (LOG.isDebugEnabled()) { LOG.debug("Auth scheme {} cannot be cached", authScheme.getClass()); } } } @Override @SuppressWarnings("unchecked") public AuthScheme get(final HttpHost host, final String pathPrefix) { Args.notNull(host, "HTTP host"); final AuthData authData = this.map.get(key(host.getSchemeName(), host, pathPrefix)); if (authData != null) { try { final AuthScheme authScheme = authData.clazz.newInstance(); ((StateHolder) authScheme).restore(authData.state); return authScheme; } catch (final IllegalAccessException | InstantiationException ex) { if (LOG.isWarnEnabled()) { LOG.warn("Unexpected error while reading auth scheme state", ex); } } } return null; } @Override public void remove(final HttpHost host, final String pathPrefix) { Args.notNull(host, "HTTP host"); this.map.remove(key(host.getSchemeName(), host, pathPrefix)); } @Override public void clear() { this.map.clear(); } @Override public String toString() { return this.map.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/NTLMEngine.java0100664 0000000 0000000 00000005010 14666635064 026113 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; /** * Abstract NTLM authentication engine. The engine can be used to * generate Type1 messages and Type3 messages in response to a * Type2 challenge. * * @since 4.0 * * @deprecated Do not use. the NTLM authentication scheme is no longer supported */ @Deprecated public interface NTLMEngine { /** * Generates a Type1 message given the domain and workstation. * * @param domain Optional Windows domain name. Can be {@code null}. * @param workstation Optional Windows workstation name. Can be * {@code null}. * @return Type1 message * @throws NTLMEngineException */ String generateType1Msg( String domain, String workstation) throws NTLMEngineException; /** * Generates a Type3 message given the user credentials and the * authentication challenge. * * @param username Windows user name * @param password Password * @param domain Windows domain name * @param workstation Windows workstation name * @param challenge Type2 challenge. * @return Type3 response. * @throws NTLMEngineException */ String generateType3Msg( String username, char[] password, String domain, String workstation, String challenge) throws NTLMEngineException; } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SingleCredentialsProvider.java0100664 0000000 0000000 00000004553 14666635064 031340 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; final class SingleCredentialsProvider implements CredentialsProvider { private final AuthScope authScope; private final Credentials credentials; public SingleCredentialsProvider(final AuthScope authScope, final Credentials credentials) { super(); this.authScope = Args.notNull(authScope, "Auth scope"); this.credentials = credentials; } public SingleCredentialsProvider(final AuthScope authScope, final String username, final char[] password) { this(authScope, new UsernamePasswordCredentials(username, password)); } @Override public Credentials getCredentials(final AuthScope authScope, final HttpContext context) { return this.authScope.match(authScope) >= 0 ? credentials : null; } @Override public String toString() { return authScope.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestSchemeFactory.java0100664 0000000 0000000 00000005120 14704162040 030067 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link DigestScheme} instances. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DigestSchemeFactory implements AuthSchemeFactory { /** * Default instance of {@link DigestSchemeFactory}. */ public static final DigestSchemeFactory INSTANCE = new DigestSchemeFactory(); /** * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used. * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding * in compliance with RFC 7616 for HTTP Digest Access Authentication. Use the default constructor {@link #DigestSchemeFactory()} instead. */ @Deprecated public DigestSchemeFactory(final Charset charset) { super(); } public DigestSchemeFactory() { } @Override public AuthScheme create(final HttpContext context) { return new DigestScheme(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/FixedCredentialsProvider.java0100664 0000000 0000000 00000004115 14666635064 031150 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.Collections; import java.util.HashMap; import java.util.Map; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.core5.http.protocol.HttpContext; final class FixedCredentialsProvider implements CredentialsProvider { private final Map credMap; public FixedCredentialsProvider(final Map credMap) { super(); this.credMap = Collections.unmodifiableMap(new HashMap<>(credMap)); } @Override public Credentials getCredentials(final AuthScope authScope, final HttpContext context) { return CredentialsMatcher.matchCredentials(this.credMap, authScope); } @Override public String toString() { return credMap.keySet().toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/CredentialsMatcher.java0100664 0000000 0000000 00000004571 15005672016 027751 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.Map; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; final class CredentialsMatcher { /** * Find matching {@link Credentials credentials} for the given authentication scope. * * @param map the credentials hash map * @param authScope the {@link AuthScope authentication scope} * @return the credentials * */ static Credentials matchCredentials(final Map map, final AuthScope authScope) { // see if we get a direct hit Credentials creds = map.get(authScope); if (creds == null) { // Nope. // Do a full scan int bestMatchFactor = -1; AuthScope bestMatch = null; for (final AuthScope current: map.keySet()) { final int factor = authScope.match(current); if (factor > bestMatchFactor) { bestMatchFactor = factor; bestMatch = current; } } if (bestMatch != null) { creds = map.get(bestMatch); } } return creds; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/DigestScheme.java0100664 0000000 0000000 00000064501 15063503637 026561 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.IOException; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.io.Serializable; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.security.MessageDigest; import java.security.Principal; import java.security.SecureRandom; import java.util.ArrayList; import java.util.Formatter; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.Set; import java.util.StringTokenizer; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.utils.ByteArrayBuilder; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicHeaderValueFormatter; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.PercentCodec; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.TextUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Digest authentication scheme. * Both MD5 (default) and MD5-sess are supported. * Currently only qop=auth or no qop is supported. qop=auth-int * is unsupported. If auth and auth-int are provided, auth is * used. *

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

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

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

*

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

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

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

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

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

* * @param value The string to be checked for invalid ABNF characters. * @return {@code true} if invalid characters are found, {@code false} otherwise. * @throws IllegalArgumentException if the input string is null. */ private boolean containsInvalidABNFChars(final String value) { if (value == null) { throw new IllegalArgumentException("Input string should not be null."); } for (int i = 0; i < value.length(); i++) { final char c = value.charAt(i); // Check for control characters and DEL if (c <= 0x1F || c == 0x7F) { return true; } // Check for characters outside the range 0x20 to 0x7E if (c > 0x7E) { return true; } // Exclude double quotes and backslash if (c == '"' || c == '\\') { return true; } } return false; } /** * Enum representing supported digest algorithms for HTTP Digest Authentication, * including session-based variants. */ private enum DigestAlgorithm { /** * MD5 digest algorithm. */ MD5("MD5", false), /** * MD5 digest algorithm with session-based variant. */ MD5_SESS("MD5", true), /** * SHA-256 digest algorithm. */ SHA_256("SHA-256", false), /** * SHA-256 digest algorithm with session-based variant. */ SHA_256_SESS("SHA-256", true), /** * SHA-512/256 digest algorithm. */ SHA_512_256("SHA-512/256", false), /** * SHA-512/256 digest algorithm with session-based variant. */ SHA_512_256_SESS("SHA-512/256", true); private final String baseAlgorithm; private final boolean sessionBased; /** * Constructor for {@code DigestAlgorithm}. * * @param baseAlgorithm the base name of the algorithm, e.g., "MD5" or "SHA-256" * @param sessionBased indicates if the algorithm is session-based (i.e., includes the "-sess" suffix) */ DigestAlgorithm(final String baseAlgorithm, final boolean sessionBased) { this.baseAlgorithm = baseAlgorithm; this.sessionBased = sessionBased; } /** * Retrieves the base algorithm name without session suffix. * * @return the base algorithm name */ private String getBaseAlgorithm() { return baseAlgorithm; } /** * Checks if the algorithm is session-based. * * @return {@code true} if the algorithm includes the "-sess" suffix, otherwise {@code false} */ private boolean isSessionBased() { return sessionBased; } /** * Maps a string representation of an algorithm to the corresponding enum constant. * * @param algorithm the algorithm name, e.g., "SHA-256" or "SHA-512-256-sess" * @return the corresponding {@code DigestAlgorithm} constant * @throws UnsupportedDigestAlgorithmException if the algorithm is unsupported */ private static DigestAlgorithm fromString(final String algorithm) { switch (algorithm.toUpperCase(Locale.ROOT)) { case "MD5": return MD5; case "MD5-SESS": return MD5_SESS; case "SHA-256": return SHA_256; case "SHA-256-SESS": return SHA_256_SESS; case "SHA-512/256": case "SHA-512-256": return SHA_512_256; case "SHA-512-256-SESS": return SHA_512_256_SESS; default: throw new UnsupportedDigestAlgorithmException("Unsupported digest algorithm: " + algorithm); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/KerberosScheme.java0100664 0000000 0000000 00000005153 14744133231 027106 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.core5.annotation.Experimental; import org.ietf.jgss.GSSException; import org.ietf.jgss.Oid; /** * Kerberos authentication scheme. *

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

* * @since 4.2 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * * @see BasicScheme * @see BearerScheme */ @Deprecated @Experimental public class KerberosScheme extends GGSSchemeBase { private static final String KERBEROS_OID = "1.2.840.113554.1.2.2"; /** * @since 5.0 */ public KerberosScheme(final org.apache.hc.client5.http.auth.KerberosConfig config, final DnsResolver dnsResolver) { super(config, dnsResolver); } public KerberosScheme() { super(); } @Override public String getName() { return StandardAuthScheme.KERBEROS; } @Override protected byte[] generateToken(final byte[] input, final String serviceName, final String authServer) throws GSSException { return generateGSSToken(input, new Oid(KERBEROS_OID), serviceName, authServer); } @Override public boolean isConnectionBased() { return true; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/GGSSchemeBase.java0100664 0000000 0000000 00000025354 15005672016 026552 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.net.UnknownHostException; import java.security.Principal; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.InvalidCredentialsException; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.utils.Base64; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.ietf.jgss.GSSContext; import org.ietf.jgss.GSSCredential; import org.ietf.jgss.GSSException; import org.ietf.jgss.GSSManager; import org.ietf.jgss.GSSName; import org.ietf.jgss.Oid; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Common behavior for {@code GSS} based authentication schemes. * * @since 4.2 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. */ @Deprecated public abstract class GGSSchemeBase implements AuthScheme { enum State { UNINITIATED, CHALLENGE_RECEIVED, TOKEN_GENERATED, FAILED, } private static final Logger LOG = LoggerFactory.getLogger(GGSSchemeBase.class); private static final String NO_TOKEN = ""; private static final String KERBEROS_SCHEME = "HTTP"; private final org.apache.hc.client5.http.auth.KerberosConfig config; private final DnsResolver dnsResolver; /** Authentication process state */ private State state; private GSSCredential gssCredential; private String challenge; private byte[] token; GGSSchemeBase(final org.apache.hc.client5.http.auth.KerberosConfig config, final DnsResolver dnsResolver) { super(); this.config = config != null ? config : org.apache.hc.client5.http.auth.KerberosConfig.DEFAULT; this.dnsResolver = dnsResolver != null ? dnsResolver : SystemDefaultDnsResolver.INSTANCE; this.state = State.UNINITIATED; } GGSSchemeBase(final org.apache.hc.client5.http.auth.KerberosConfig config) { this(config, SystemDefaultDnsResolver.INSTANCE); } GGSSchemeBase() { this(org.apache.hc.client5.http.auth.KerberosConfig.DEFAULT, SystemDefaultDnsResolver.INSTANCE); } @Override public String getRealm() { return null; } @Override public void processChallenge( final AuthChallenge authChallenge, final HttpContext context) throws MalformedChallengeException { Args.notNull(authChallenge, "AuthChallenge"); this.challenge = authChallenge.getValue() != null ? authChallenge.getValue() : NO_TOKEN; if (state == State.UNINITIATED) { token = Base64.decodeBase64(challenge.getBytes()); state = State.CHALLENGE_RECEIVED; } else { if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} Authentication already attempted", exchangeId); } state = State.FAILED; } } protected GSSManager getManager() { return GSSManager.getInstance(); } /** * @since 4.4 */ protected byte[] generateGSSToken( final byte[] input, final Oid oid, final String serviceName, final String authServer) throws GSSException { final GSSManager manager = getManager(); final GSSName serverName = manager.createName(serviceName + "@" + authServer, GSSName.NT_HOSTBASED_SERVICE); final GSSContext gssContext = createGSSContext(manager, oid, serverName, gssCredential); if (input != null) { return gssContext.initSecContext(input, 0, input.length); } return gssContext.initSecContext(new byte[] {}, 0, 0); } /** * @since 5.0 */ protected GSSContext createGSSContext( final GSSManager manager, final Oid oid, final GSSName serverName, final GSSCredential gssCredential) throws GSSException { final GSSContext gssContext = manager.createContext(serverName.canonicalize(oid), oid, gssCredential, GSSContext.DEFAULT_LIFETIME); gssContext.requestMutualAuth(true); if (config.getRequestDelegCreds() != org.apache.hc.client5.http.auth.KerberosConfig.Option.DEFAULT) { gssContext.requestCredDeleg(config.getRequestDelegCreds() == org.apache.hc.client5.http.auth.KerberosConfig.Option.ENABLE); } return gssContext; } /** * @since 4.4 */ protected abstract byte[] generateToken(byte[] input, String serviceName, String authServer) throws GSSException; @Override public boolean isChallengeComplete() { return this.state == State.TOKEN_GENERATED || this.state == State.FAILED; } @Override public boolean isResponseReady( final HttpHost host, final CredentialsProvider credentialsProvider, final HttpContext context) throws AuthenticationException { Args.notNull(host, "Auth host"); Args.notNull(credentialsProvider, "CredentialsProvider"); final Credentials credentials = credentialsProvider.getCredentials( new AuthScope(host, null, getName()), context); if (credentials instanceof org.apache.hc.client5.http.auth.KerberosCredentials) { this.gssCredential = ((org.apache.hc.client5.http.auth.KerberosCredentials) credentials).getGSSCredential(); } else { this.gssCredential = null; } return true; } @Override public Principal getPrincipal() { return null; } @Override public String generateAuthResponse( final HttpHost host, final HttpRequest request, final HttpContext context) throws AuthenticationException { Args.notNull(host, "HTTP host"); Args.notNull(request, "HTTP request"); switch (state) { case UNINITIATED: throw new AuthenticationException(getName() + " authentication has not been initiated"); case FAILED: throw new AuthenticationException(getName() + " authentication has failed"); case CHALLENGE_RECEIVED: try { final String authServer; String hostname = host.getHostName(); if (config.getUseCanonicalHostname() != org.apache.hc.client5.http.auth.KerberosConfig.Option.DISABLE) { try { hostname = dnsResolver.resolveCanonicalHostname(host.getHostName()); } catch (final UnknownHostException ignore) { } } if (config.getStripPort() != org.apache.hc.client5.http.auth.KerberosConfig.Option.DISABLE) { authServer = hostname; } else { authServer = hostname + ":" + host.getPort(); } if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} init {}", exchangeId, authServer); } token = generateToken(token, KERBEROS_SCHEME, authServer); state = State.TOKEN_GENERATED; } catch (final GSSException gsse) { state = State.FAILED; if (gsse.getMajor() == GSSException.DEFECTIVE_CREDENTIAL || gsse.getMajor() == GSSException.CREDENTIALS_EXPIRED) { throw new InvalidCredentialsException(gsse.getMessage(), gsse); } if (gsse.getMajor() == GSSException.NO_CRED ) { throw new InvalidCredentialsException(gsse.getMessage(), gsse); } if (gsse.getMajor() == GSSException.DEFECTIVE_TOKEN || gsse.getMajor() == GSSException.DUPLICATE_TOKEN || gsse.getMajor() == GSSException.OLD_TOKEN) { throw new AuthenticationException(gsse.getMessage(), gsse); } // other error throw new AuthenticationException(gsse.getMessage()); } case TOKEN_GENERATED: final Base64 codec = new Base64(0); final String tokenstr = new String(codec.encode(token)); if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} Sending response '{}' back to the auth server", exchangeId, tokenstr); } return StandardAuthScheme.SPNEGO + " " + tokenstr; default: throw new IllegalStateException("Illegal state: " + state); } } @Override public String toString() { return getName() + "{" + this.state + " " + challenge + '}'; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BasicScheme.java0100664 0000000 0000000 00000022550 14704162040 026347 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.Serializable; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.security.Principal; import java.util.HashMap; import java.util.List; import java.util.Locale; import java.util.Map; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthStateCacheable; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.impl.StateHolder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.utils.Base64; import org.apache.hc.client5.http.utils.ByteArrayBuilder; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Basic authentication scheme. * * @since 4.0 */ @AuthStateCacheable public class BasicScheme implements AuthScheme, StateHolder, Serializable { private static final long serialVersionUID = -1931571557597830536L; private static final Logger LOG = LoggerFactory.getLogger(BasicScheme.class); private final Map paramMap; private transient ByteArrayBuilder buffer; private transient Base64 base64codec; private boolean complete; private UsernamePasswordCredentials credentials; /** * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding * in compliance with RFC 7617 for HTTP Basic Authentication. Use the default constructor {@link #BasicScheme()} instead. * * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used. */ @Deprecated public BasicScheme(final Charset charset) { this.paramMap = new HashMap<>(); this.complete = false; } /** * Constructs a new BasicScheme with UTF-8 as the charset. * * @since 4.3 */ public BasicScheme() { this.paramMap = new HashMap<>(); this.complete = false; } public void initPreemptive(final Credentials credentials) { if (credentials != null) { Args.check(credentials instanceof UsernamePasswordCredentials, "Unsupported credential type: " + credentials.getClass()); this.credentials = (UsernamePasswordCredentials) credentials; this.complete = true; } else { this.credentials = null; } } @Override public String getName() { return StandardAuthScheme.BASIC; } @Override public boolean isConnectionBased() { return false; } @Override public String getRealm() { return this.paramMap.get("realm"); } @Override public void processChallenge( final AuthChallenge authChallenge, final HttpContext context) throws MalformedChallengeException { this.paramMap.clear(); final List params = authChallenge.getParams(); if (params != null) { for (final NameValuePair param: params) { this.paramMap.put(param.getName().toLowerCase(Locale.ROOT), param.getValue()); } } this.complete = true; } @Override public boolean isChallengeComplete() { return this.complete; } @Override public boolean isResponseReady( final HttpHost host, final CredentialsProvider credentialsProvider, final HttpContext context) throws AuthenticationException { Args.notNull(host, "Auth host"); Args.notNull(credentialsProvider, "CredentialsProvider"); final AuthScope authScope = new AuthScope(host, getRealm(), getName()); final Credentials credentials = credentialsProvider.getCredentials( authScope, context); if (credentials instanceof UsernamePasswordCredentials) { this.credentials = (UsernamePasswordCredentials) credentials; return true; } if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} No credentials found for auth scope [{}]", exchangeId, authScope); } this.credentials = null; return false; } @Override public Principal getPrincipal() { return null; } private void validateUsername() throws AuthenticationException { if (credentials == null) { throw new AuthenticationException("User credentials not set"); } final String username = credentials.getUserName(); for (int i = 0; i < username.length(); i++) { final char ch = username.charAt(i); if (Character.isISOControl(ch)) { throw new AuthenticationException("Username must not contain any control characters"); } if (ch == ':') { throw new AuthenticationException("Username contains a colon character and is invalid"); } } } private void validatePassword() throws AuthenticationException { if (credentials == null) { throw new AuthenticationException("User credentials not set"); } final char[] password = credentials.getUserPassword(); if (password != null) { for (final char ch : password) { if (Character.isISOControl(ch)) { throw new AuthenticationException("Password must not contain any control characters"); } } } } @Override public String generateAuthResponse( final HttpHost host, final HttpRequest request, final HttpContext context) throws AuthenticationException { validateUsername(); validatePassword(); if (this.buffer == null) { this.buffer = new ByteArrayBuilder(64); } else { this.buffer.reset(); } final Charset charset = AuthSchemeSupport.parseCharset(paramMap.get("charset"), StandardCharsets.UTF_8); this.buffer.charset(charset); this.buffer.append(this.credentials.getUserName()).append(":").append(this.credentials.getUserPassword()); if (this.base64codec == null) { this.base64codec = new Base64(); } final byte[] encodedCreds = this.base64codec.encode(this.buffer.toByteArray()); this.buffer.reset(); return StandardAuthScheme.BASIC + " " + new String(encodedCreds, 0, encodedCreds.length, StandardCharsets.US_ASCII); } @Override public State store() { if (complete) { return new State(new HashMap<>(paramMap), credentials); } return null; } @Override public void restore(final State state) { if (state != null) { paramMap.clear(); paramMap.putAll(state.params); credentials = state.credentials; complete = true; } } @Override public String toString() { return getName() + this.paramMap; } @Internal public static class State { final Map params; final UsernamePasswordCredentials credentials; State(final Map params, final UsernamePasswordCredentials credentials) { this.params = params; this.credentials = credentials; } @Override public String toString() { return "State{" + "params=" + params + '}'; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/AuthenticationHandler.java0100664 0000000 0000000 00000046762 15005672016 030475 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.HashMap; import java.util.Iterator; import java.util.LinkedList; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.Queue; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.FormattedHeader; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.CharArrayBuffer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Internal utility class that implements commons aspects of the client side * HTTP authentication. * * @since 5.4 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) public class AuthenticationHandler { private static final Logger LOG = LoggerFactory.getLogger(AuthenticationHandler.class); private final AuthChallengeParser parser; public AuthenticationHandler() { this.parser = new AuthChallengeParser(); } /** * Determines whether the given response represents an authentication challenge, and updates * the {@link AuthExchange} state. * * @param host the hostname of the opposite endpoint. * @param challengeType the challenge type (target or proxy). * @param response the response message head. * @param authExchange the current authentication exchange state. Gets updated. * @param context the current execution context. * @return {@code true} if the response message represents an authentication challenge, * {@code false} otherwise. */ public boolean isChallenged( final HttpHost host, final ChallengeType challengeType, final HttpResponse response, final AuthExchange authExchange, final HttpContext context) { final HttpClientContext clientContext = HttpClientContext.cast(context); if (checkChallenged(challengeType, response, clientContext)) { return true; } switch (authExchange.getState()) { case CHALLENGED: case HANDSHAKE: if (LOG.isDebugEnabled()) { // The mutual auth may still fail LOG.debug("{} Server has accepted authentication", clientContext.getExchangeId()); } authExchange.setState(AuthExchange.State.SUCCESS); break; case SUCCESS: break; default: authExchange.setState(AuthExchange.State.UNCHALLENGED); } return false; } /** * Determines whether the given response represents an authentication challenge, without * changing the {@link AuthExchange} state. * * @param challengeType the challenge type (target or proxy). * @param response the response message head. * @param clientContext the current execution context. * @return {@code true} if the response message represents an authentication challenge, * {@code false} otherwise. */ private boolean checkChallenged( final ChallengeType challengeType, final HttpResponse response, final HttpClientContext clientContext) { final int challengeCode; switch (challengeType) { case TARGET: challengeCode = HttpStatus.SC_UNAUTHORIZED; break; case PROXY: challengeCode = HttpStatus.SC_PROXY_AUTHENTICATION_REQUIRED; break; default: throw new IllegalStateException("Unexpected challenge type: " + challengeType); } if (response.getCode() == challengeCode) { if (LOG.isDebugEnabled()) { LOG.debug("{} Authentication required", clientContext.getExchangeId()); } return true; } return false; } /** * Determines if the scheme requires an auth challenge for responses that do not * have a challenge HTTP code. (i.e whether it needs a mutual authentication token) */ public boolean isChallengeExpected(final AuthExchange authExchange) { final AuthScheme authScheme = authExchange.getAuthScheme(); return authScheme != null && authScheme.isChallengeExpected(); } public Map extractChallengeMap( final ChallengeType challengeType, final HttpResponse response, final HttpClientContext context) { final Map challengeMap = new HashMap<>(); final Iterator
headerIterator = response.headerIterator( challengeType == ChallengeType.PROXY ? HttpHeaders.PROXY_AUTHENTICATE : HttpHeaders.WWW_AUTHENTICATE); while (headerIterator.hasNext()) { final Header header = headerIterator.next(); final CharArrayBuffer buffer; final int pos; if (header instanceof FormattedHeader) { buffer = ((FormattedHeader) header).getBuffer(); pos = ((FormattedHeader) header).getValuePos(); } else { final String s = header.getValue(); if (s == null) { continue; } buffer = new CharArrayBuffer(s.length()); buffer.append(s); pos = 0; } final ParserCursor cursor = new ParserCursor(pos, buffer.length()); final List authChallenges; try { authChallenges = parser.parse(challengeType, buffer, cursor); } catch (final ParseException ex) { if (LOG.isWarnEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.warn("{} Malformed challenge: {}", exchangeId, header.getValue()); } continue; } for (final AuthChallenge authChallenge : authChallenges) { final String schemeName = authChallenge.getSchemeName().toLowerCase(Locale.ROOT); if (!challengeMap.containsKey(schemeName)) { challengeMap.put(schemeName, authChallenge); } } } return challengeMap; } /** * Handles the response from the opposite endpoint and updates the {@link AuthExchange} * state based on the challenge presented in the response message using the given * {@link AuthenticationStrategy}. * * @param host the hostname of the opposite endpoint. * @param challengeType the challenge type (target or proxy). * @param response the response message head. * @param authStrategy the authentication strategy. * @param authExchange the current authentication exchange state. * @param context the current execution context. * @return {@code true} if the request needs-to be re-sent, * {@code false} if the authentication is complete (successful or not). * * @throws AuthenticationException if the AuthScheme throws one. In most cases this indicates a * client side problem, as final server error responses are simply returned. * @throws MalformedChallengeException if the AuthScheme throws one. In most cases this indicates a * client side problem, as final server error responses are simply returned. */ public boolean handleResponse( final HttpHost host, final ChallengeType challengeType, final HttpResponse response, final AuthenticationStrategy authStrategy, final AuthExchange authExchange, final HttpContext context) throws AuthenticationException, MalformedChallengeException { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); final boolean challenged = checkChallenged(challengeType, response, clientContext); final boolean isChallengeExpected = isChallengeExpected(authExchange); if (LOG.isDebugEnabled()) { LOG.debug("{} {} requested authentication", exchangeId, host.toHostString()); } final Map challengeMap = extractChallengeMap(challengeType, response, clientContext); if (challengeMap.isEmpty()) { if (LOG.isDebugEnabled()) { LOG.debug("{} Response contains no valid authentication challenges", exchangeId); } if (!isChallengeExpected) { authExchange.reset(); return false; } } switch (authExchange.getState()) { case FAILURE: return false; case SUCCESS: if (!isChallengeExpected) { authExchange.reset(); break; } // otherwise fall through case CHALLENGED: // fall through case HANDSHAKE: Asserts.notNull(authExchange.getAuthScheme(), "AuthScheme"); // fall through case UNCHALLENGED: final AuthScheme authScheme = authExchange.getAuthScheme(); // AuthScheme is only set if we have already sent an auth response, either // because we have received a challenge for it, or preemptively. if (authScheme != null) { final String schemeName = authScheme.getName(); final AuthChallenge challenge = challengeMap.get(schemeName.toLowerCase(Locale.ROOT)); if (challenge != null || isChallengeExpected) { if (LOG.isDebugEnabled()) { LOG.debug("{} Processing authentication challenge {}", exchangeId, challenge); } try { authScheme.processChallenge(host, challenged, challenge, clientContext); } catch (final AuthenticationException | MalformedChallengeException ex) { if (LOG.isWarnEnabled()) { LOG.warn("Exception processing challenge {}", exchangeId, ex); } authExchange.reset(); authExchange.setState(AuthExchange.State.FAILURE); if (isChallengeExpected) { throw ex; } } if (authScheme.isChallengeComplete()) { if (LOG.isDebugEnabled()) { LOG.debug("{} Authentication failed", exchangeId); } authExchange.reset(); authExchange.setState(AuthExchange.State.FAILURE); return false; } if (!challenged) { // There are no more challanges sent after the 200 message, // and if we get here, then the mutual auth phase has succeeded. authExchange.setState(AuthExchange.State.SUCCESS); return false; } else { authExchange.setState(AuthExchange.State.HANDSHAKE); } return true; } authExchange.reset(); // Retry authentication with a different scheme } } // We reach this if we fell through above because the authScheme has not yet been set, or if // we receive a 401/407 response for an unexpected scheme. Normally this processes the first // 401/407 response final List preferredSchemes = authStrategy.select(challengeType, challengeMap, clientContext); final CredentialsProvider credsProvider = clientContext.getCredentialsProvider(); if (credsProvider == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Credentials provider not set in the context", exchangeId); } return false; } final Queue authOptions = new LinkedList<>(); if (LOG.isDebugEnabled()) { LOG.debug("{} Selecting authentication options", exchangeId); } for (final AuthScheme authScheme: preferredSchemes) { // We only respond to the first successfully processed challenge. However, the // original AuthScheme API does not really process the challenge at this point, // so we need to process/store each challenge here anyway. try { final String schemeName = authScheme.getName(); final AuthChallenge challenge = challengeMap.get(schemeName.toLowerCase(Locale.ROOT)); authScheme.processChallenge(host, challenged, challenge, clientContext); if (authScheme.isResponseReady(host, credsProvider, clientContext)) { authOptions.add(authScheme); } } catch (final AuthenticationException | MalformedChallengeException ex) { if (LOG.isWarnEnabled()) { LOG.warn("Exception while processing Challange", ex); } } } if (!authOptions.isEmpty()) { if (LOG.isDebugEnabled()) { LOG.debug("{} Selected authentication options: {}", exchangeId, authOptions); } authExchange.reset(); authExchange.setState(AuthExchange.State.CHALLENGED); authExchange.setOptions(authOptions); return true; } return false; } /** * Generates a response to the authentication challenge based on the actual {@link AuthExchange} state * and adds it to the given {@link HttpRequest} message . * * @param host the hostname of the opposite endpoint. * @param challengeType the challenge type (target or proxy). * @param request the request message head. * @param authExchange the current authentication exchange state. * @param context the current execution context. */ public void addAuthResponse( final HttpHost host, final ChallengeType challengeType, final HttpRequest request, final AuthExchange authExchange, final HttpContext context) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); AuthScheme authScheme = authExchange.getAuthScheme(); switch (authExchange.getState()) { case FAILURE: return; case SUCCESS: Asserts.notNull(authScheme, "AuthScheme"); if (authScheme.isConnectionBased()) { return; } break; case HANDSHAKE: Asserts.notNull(authScheme, "AuthScheme"); break; case CHALLENGED: final Queue authOptions = authExchange.getAuthOptions(); if (authOptions != null) { while (!authOptions.isEmpty()) { authScheme = authOptions.remove(); authExchange.select(authScheme); if (LOG.isDebugEnabled()) { LOG.debug("{} Generating response to an authentication challenge using {} scheme", exchangeId, authScheme.getName()); } try { final String authResponse = authScheme.generateAuthResponse(host, request, clientContext); if (authResponse != null) { final Header header = new BasicHeader( challengeType == ChallengeType.TARGET ? HttpHeaders.AUTHORIZATION : HttpHeaders.PROXY_AUTHORIZATION, authResponse); request.addHeader(header); } break; } catch (final AuthenticationException ex) { if (LOG.isWarnEnabled()) { LOG.warn("{} {} authentication error: {}", exchangeId, authScheme, ex.getMessage()); } } } return; } Asserts.notNull(authScheme, "AuthScheme"); default: } // This is the SUCCESS and HANDSHAKE states, same as the initial response. // This only happens if the handshake requires multiple requests, which is // unlikely in practice. if (authScheme != null) { try { final String authResponse = authScheme.generateAuthResponse(host, request, clientContext); final Header header = new BasicHeader( challengeType == ChallengeType.TARGET ? HttpHeaders.AUTHORIZATION : HttpHeaders.PROXY_AUTHORIZATION, authResponse); request.addHeader(header); } catch (final AuthenticationException ex) { if (LOG.isErrorEnabled()) { LOG.error("{} {} authentication error: {}", exchangeId, authScheme, ex.getMessage()); } } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/AuthSchemeSupport.java0100664 0000000 0000000 00000003556 14666635064 027653 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.nio.charset.Charset; import java.nio.charset.UnsupportedCharsetException; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.core5.annotation.Internal; /** * @since 5.2 */ @Internal public class AuthSchemeSupport { public static Charset parseCharset( final String charsetName, final Charset defaultCharset) throws AuthenticationException { try { return charsetName != null ? Charset.forName(charsetName) : defaultCharset; } catch (final UnsupportedCharsetException ex) { throw new AuthenticationException("Unsupported charset: " + charsetName); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SPNegoSchemeFactory.java0100664 0000000 0000000 00000005760 14744133231 030021 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link SPNegoScheme} instances. *

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

* * @since 4.2 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * * @see BasicSchemeFactory * @see BearerSchemeFactory */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) @Experimental public class SPNegoSchemeFactory implements AuthSchemeFactory { /** * Singleton instance for the default configuration. */ public static final SPNegoSchemeFactory DEFAULT = new SPNegoSchemeFactory(org.apache.hc.client5.http.auth.KerberosConfig.DEFAULT, SystemDefaultDnsResolver.INSTANCE); private final org.apache.hc.client5.http.auth.KerberosConfig config; private final DnsResolver dnsResolver; /** * @since 5.0 */ public SPNegoSchemeFactory(final org.apache.hc.client5.http.auth.KerberosConfig config, final DnsResolver dnsResolver) { super(); this.config = config; this.dnsResolver = dnsResolver; } @Override public AuthScheme create(final HttpContext context) { return new SPNegoScheme(this.config, this.dnsResolver); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/KerberosSchemeFactory.java0100664 0000000 0000000 00000005774 14744133231 030447 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link KerberosScheme} instances. *

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

* * @since 4.2 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * * @see BasicSchemeFactory * @see BearerSchemeFactory */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) @Experimental public class KerberosSchemeFactory implements AuthSchemeFactory { /** * Singleton instance for the default configuration. */ public static final KerberosSchemeFactory DEFAULT = new KerberosSchemeFactory(org.apache.hc.client5.http.auth.KerberosConfig.DEFAULT, SystemDefaultDnsResolver.INSTANCE); private final org.apache.hc.client5.http.auth.KerberosConfig config; private final DnsResolver dnsResolver; /** * @since 5.0 */ public KerberosSchemeFactory(final org.apache.hc.client5.http.auth.KerberosConfig config, final DnsResolver dnsResolver) { super(); this.config = config; this.dnsResolver = dnsResolver; } @Override public AuthScheme create(final HttpContext context) { return new KerberosScheme(this.config, this.dnsResolver); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BasicSchemeFactory.java0100664 0000000 0000000 00000005723 14704162040 027702 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link AuthSchemeFactory} implementation that creates and initializes * {@link BasicScheme} instances. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicSchemeFactory implements AuthSchemeFactory { /** * Default instance of {@link BasicSchemeFactory with a null Charset}. */ public static final BasicSchemeFactory INSTANCE = new BasicSchemeFactory(); private final Charset charset; /** * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding * in compliance with RFC 7617 for HTTP Basic Authentication. Use the default constructor {@link #BasicSchemeFactory()} instead. * * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used. */ @Deprecated public BasicSchemeFactory(final Charset charset) { super(); this.charset = StandardCharsets.UTF_8; // Always use UTF-8 } /** * Constructs a new {@link BasicSchemeFactory} with {@link StandardCharsets#UTF_8} as the charset. * This default setting aligns with standard practices for encoding credentials in Basic Authentication. */ public BasicSchemeFactory() { this.charset = StandardCharsets.UTF_8; } @Override public AuthScheme create(final HttpContext context) { return new BasicScheme(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/CredentialsProviderBuilder.java0100664 0000000 0000000 00000007161 14666635064 031503 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.HashMap; import java.util.Map; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.util.Args; /** * {@link CredentialsProvider} builder. * * @since 5.2 */ public final class CredentialsProviderBuilder { private final Map credMap; public static CredentialsProviderBuilder create() { return new CredentialsProviderBuilder(); } public CredentialsProviderBuilder() { super(); this.credMap = new HashMap<>(); } public CredentialsProviderBuilder add(final AuthScope authScope, final Credentials credentials) { Args.notNull(authScope, "Host"); credMap.put(authScope, credentials); return this; } public CredentialsProviderBuilder add(final AuthScope authScope, final String username, final char[] password) { Args.notNull(authScope, "Host"); credMap.put(authScope, new UsernamePasswordCredentials(username, password)); return this; } public CredentialsProviderBuilder add(final HttpHost httpHost, final Credentials credentials) { Args.notNull(httpHost, "Host"); credMap.put(new AuthScope(httpHost), credentials); return this; } public CredentialsProviderBuilder add(final HttpHost httpHost, final String username, final char[] password) { Args.notNull(httpHost, "Host"); credMap.put(new AuthScope(httpHost), new UsernamePasswordCredentials(username, password)); return this; } public CredentialsProvider build() { if (credMap.size() == 0) { return new BasicCredentialsProvider(); } else if (credMap.size() == 1) { final Map.Entry entry = credMap.entrySet().iterator().next(); return new SingleCredentialsProvider(entry.getKey(), entry.getValue()); } else { return new FixedCredentialsProvider(credMap); } } static class Entry { final AuthScope authScope; final Credentials credentials; Entry(final AuthScope authScope, final Credentials credentials) { this.authScope = authScope; this.credentials = credentials; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/NTLMEngineException.java0100664 0000000 0000000 00000004325 14666635064 030002 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthenticationException; /** * Signals NTLM protocol failure. * * @since 4.0 * * @deprecated Do not use. */ @Deprecated public class NTLMEngineException extends AuthenticationException { private static final long serialVersionUID = 6027981323731768824L; public NTLMEngineException() { super(); } /** * Creates a new NTLMEngineException with the specified message. * * @param message the exception detail message */ public NTLMEngineException(final String message) { super(message); } /** * Creates a new NTLMEngineException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public NTLMEngineException(final String message, final Throwable cause) { super(message, cause); } } ././@LongLink0100644 0000000 0000000 00000000145 15005672016 011635 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SystemDefaultCredentialsProvider.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SystemDefaultCredentialsProvider.java0100664 0000000 0000000 00000016467 15005672016 032701 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.net.Authenticator; import java.net.MalformedURLException; import java.net.PasswordAuthentication; import java.net.URI; import java.net.URISyntaxException; import java.net.URL; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsStore; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** * Implementation of {@link CredentialsStore} backed by standard * JRE {@link Authenticator}. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.SAFE) @SuppressWarnings("deprecation") public class SystemDefaultCredentialsProvider implements CredentialsStore { private final BasicCredentialsProvider internal; /** * Default constructor. */ public SystemDefaultCredentialsProvider() { super(); this.internal = new BasicCredentialsProvider(); } @Override public void setCredentials(final AuthScope authScope, final Credentials credentials) { internal.setCredentials(authScope, credentials); } private static PasswordAuthentication getSystemCreds( final String protocol, final AuthScope authScope, final Authenticator.RequestorType requestorType, final HttpClientContext context) { final HttpRequest request = context != null ? context.getRequest() : null; URL targetHostURL; try { final URI uri = request != null ? request.getUri() : null; targetHostURL = uri != null ? uri.toURL() : null; } catch (final URISyntaxException | MalformedURLException ignore) { targetHostURL = null; } // use null addr, because the authentication fails if it does not exactly match the expected realm's host return Authenticator.requestPasswordAuthentication( authScope.getHost(), null, authScope.getPort(), protocol, authScope.getRealm(), authScope.getSchemeName(), targetHostURL, requestorType); } @Override public Credentials getCredentials(final AuthScope authScope, final HttpContext context) { Args.notNull(authScope, "Auth scope"); final Credentials localcreds = internal.getCredentials(authScope, context); if (localcreds != null) { return localcreds; } final String host = authScope.getHost(); if (host != null) { final HttpClientContext clientContext = context != null ? HttpClientContext.cast(context) : null; final String protocol = authScope.getProtocol() != null ? authScope.getProtocol() : (authScope.getPort() == 443 ? URIScheme.HTTPS.id : URIScheme.HTTP.id); PasswordAuthentication systemcreds = getSystemCreds( protocol, authScope, Authenticator.RequestorType.SERVER, clientContext); if (systemcreds == null) { systemcreds = getSystemCreds( protocol, authScope, Authenticator.RequestorType.PROXY, clientContext); } if (systemcreds == null) { // Look for values given using http.proxyUser/http.proxyPassword or // https.proxyUser/https.proxyPassword. We cannot simply use the protocol from // the origin since a proxy retrieved from https.proxyHost/https.proxyPort will // still use http as protocol systemcreds = getProxyCredentials(URIScheme.HTTP.getId(), authScope); if (systemcreds == null) { systemcreds = getProxyCredentials(URIScheme.HTTPS.getId(), authScope); } } if (systemcreds != null) { final String domain = System.getProperty("http.auth.ntlm.domain"); if (domain != null) { return new org.apache.hc.client5.http.auth.NTCredentials( systemcreds.getUserName(), systemcreds.getPassword(), null, domain); } if (StandardAuthScheme.NTLM.equalsIgnoreCase(authScope.getSchemeName())) { // Domain may be specified in a fully qualified user name return new org.apache.hc.client5.http.auth.NTCredentials( systemcreds.getUserName(), systemcreds.getPassword(), null, null); } return new UsernamePasswordCredentials(systemcreds.getUserName(), systemcreds.getPassword()); } } return null; } private static PasswordAuthentication getProxyCredentials(final String protocol, final AuthScope authScope) { final String proxyHost = System.getProperty(protocol + ".proxyHost"); if (proxyHost == null) { return null; } final String proxyPort = System.getProperty(protocol + ".proxyPort"); if (proxyPort == null) { return null; } try { final AuthScope systemScope = new AuthScope(proxyHost, Integer.parseInt(proxyPort)); if (authScope.match(systemScope) >= 0) { final String proxyUser = System.getProperty(protocol + ".proxyUser"); if (proxyUser == null) { return null; } final String proxyPassword = System.getProperty(protocol + ".proxyPassword"); return new PasswordAuthentication(proxyUser, proxyPassword != null ? proxyPassword.toCharArray() : new char[] {}); } } catch (final NumberFormatException ignore) { } return null; } @Override public void clear() { internal.clear(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/AuthCacheKeeper.java0100664 0000000 0000000 00000014757 14704162040 027174 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthStateCacheable; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Utility class that implements commons aspects of the client side authentication cache keeping. * * @since 5.2 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) public final class AuthCacheKeeper { private static final Logger LOG = LoggerFactory.getLogger(AuthCacheKeeper.class); private final SchemePortResolver schemePortResolver; public AuthCacheKeeper(final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver; } public void updateOnChallenge(final HttpHost host, final String pathPrefix, final AuthExchange authExchange, final HttpContext context) { clearCache(host, pathPrefix, HttpClientContext.cast(context)); } public void updateOnNoChallenge(final HttpHost host, final String pathPrefix, final AuthExchange authExchange, final HttpContext context) { if (authExchange.getState() == AuthExchange.State.SUCCESS) { updateCache(host, pathPrefix, authExchange.getAuthScheme(), HttpClientContext.cast(context)); } } public void updateOnResponse(final HttpHost host, final String pathPrefix, final AuthExchange authExchange, final HttpContext context) { if (authExchange.getState() == AuthExchange.State.FAILURE) { clearCache(host, pathPrefix, HttpClientContext.cast(context)); } } public void loadPreemptively(final HttpHost host, final String pathPrefix, final AuthExchange authExchange, final HttpContext context) { if (authExchange.getState() == AuthExchange.State.UNCHALLENGED) { AuthScheme authScheme = loadFromCache(host, pathPrefix, HttpClientContext.cast(context)); if (authScheme == null && pathPrefix != null) { authScheme = loadFromCache(host, null, HttpClientContext.cast(context)); } if (authScheme != null) { authExchange.select(authScheme); } } } private AuthScheme loadFromCache(final HttpHost host, final String pathPrefix, final HttpClientContext clientContext) { final AuthCache authCache = clientContext.getAuthCache(); if (authCache != null) { final AuthScheme authScheme = authCache.get(host, pathPrefix); if (authScheme != null) { if (LOG.isDebugEnabled()) { final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} Re-using cached '{}' auth scheme for {}{}", exchangeId, authScheme.getName(), host, pathPrefix != null ? pathPrefix : ""); } return authScheme; } } return null; } private void updateCache(final HttpHost host, final String pathPrefix, final AuthScheme authScheme, final HttpClientContext clientContext) { final boolean cacheable = authScheme.getClass().getAnnotation(AuthStateCacheable.class) != null; if (cacheable) { AuthCache authCache = clientContext.getAuthCache(); if (authCache == null) { authCache = new BasicAuthCache(schemePortResolver); clientContext.setAuthCache(authCache); } if (LOG.isDebugEnabled()) { final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} Caching '{}' auth scheme for {}{}", exchangeId, authScheme.getName(), host, pathPrefix != null ? pathPrefix : ""); } authCache.put(host, pathPrefix, authScheme); } } private void clearCache(final HttpHost host, final String pathPrefix, final HttpClientContext clientContext) { final AuthCache authCache = clientContext.getAuthCache(); if (authCache != null) { if (LOG.isDebugEnabled()) { final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} Clearing cached auth scheme for {}{}", exchangeId, host, pathPrefix != null ? pathPrefix : ""); } authCache.remove(host, pathPrefix); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SPNegoScheme.java0100664 0000000 0000000 00000005215 14744133231 026464 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.core5.annotation.Experimental; import org.ietf.jgss.GSSException; import org.ietf.jgss.Oid; /** * SPNEGO (Simple and Protected GSSAPI Negotiation Mechanism) authentication * scheme. *

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

* * @since 4.2 * * @deprecated Do not use. The GGS based experimental authentication schemes are no longer * supported. Consider using Basic or Bearer authentication with TLS instead. * * @see BasicScheme * @see BearerScheme */ @Deprecated @Experimental public class SPNegoScheme extends GGSSchemeBase { private static final String SPNEGO_OID = "1.3.6.1.5.5.2"; /** * @since 5.0 */ public SPNegoScheme(final org.apache.hc.client5.http.auth.KerberosConfig config, final DnsResolver dnsResolver) { super(config, dnsResolver); } public SPNegoScheme() { super(); } @Override public String getName() { return StandardAuthScheme.SPNEGO; } @Override protected byte[] generateToken(final byte[] input, final String serviceName, final String authServer) throws GSSException { return generateGSSToken(input, new Oid(SPNEGO_OID), serviceName, authServer); } @Override public boolean isConnectionBased() { return true; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/BearerScheme.java0100664 0000000 0000000 00000015442 14704162040 026530 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.Serializable; import java.security.Principal; import java.util.HashMap; import java.util.List; import java.util.Locale; import java.util.Map; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthStateCacheable; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.BearerToken; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.impl.StateHolder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Bearer authentication scheme. * * @since 5.3 */ @AuthStateCacheable public class BearerScheme implements AuthScheme, StateHolder, Serializable { private static final Logger LOG = LoggerFactory.getLogger(BearerScheme.class); private final Map paramMap; private boolean complete; private BearerToken bearerToken; public BearerScheme() { this.paramMap = new HashMap<>(); this.complete = false; } @Override public String getName() { return StandardAuthScheme.BEARER; } @Override public boolean isConnectionBased() { return false; } @Override public String getRealm() { return this.paramMap.get("realm"); } @Override public void processChallenge( final AuthChallenge authChallenge, final HttpContext context) throws MalformedChallengeException { this.paramMap.clear(); final List params = authChallenge.getParams(); if (params != null) { for (final NameValuePair param: params) { this.paramMap.put(param.getName().toLowerCase(Locale.ROOT), param.getValue()); } if (LOG.isDebugEnabled()) { final String error = paramMap.get("error"); if (error != null) { final StringBuilder buf = new StringBuilder(); buf.append(error); final String desc = paramMap.get("error_description"); final String uri = paramMap.get("error_uri"); if (desc != null || uri != null) { buf.append(" ("); buf.append(desc).append("; ").append(uri); buf.append(")"); } LOG.debug(buf.toString()); } } } this.complete = true; } @Override public boolean isChallengeComplete() { return this.complete; } @Override public boolean isResponseReady( final HttpHost host, final CredentialsProvider credentialsProvider, final HttpContext context) throws AuthenticationException { Args.notNull(host, "Auth host"); Args.notNull(credentialsProvider, "Credentials provider"); final AuthScope authScope = new AuthScope(host, getRealm(), getName()); final Credentials credentials = credentialsProvider.getCredentials(authScope, context); if (credentials instanceof BearerToken) { this.bearerToken = (BearerToken) credentials; return true; } if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} No credentials found for auth scope [{}]", exchangeId, authScope); } this.bearerToken = null; return false; } @Override public Principal getPrincipal() { return null; } @Override public String generateAuthResponse( final HttpHost host, final HttpRequest request, final HttpContext context) throws AuthenticationException { Asserts.notNull(bearerToken, "Bearer token"); return StandardAuthScheme.BEARER + " " + bearerToken.getToken(); } @Override public State store() { if (complete) { return new State(new HashMap<>(paramMap), bearerToken); } return null; } @Override public void restore(final State state) { if (state != null) { paramMap.clear(); paramMap.putAll(state.params); bearerToken = state.bearerToken; complete = true; } } @Override public String toString() { return getName() + this.paramMap; } @Internal public static class State { final Map params; final BearerToken bearerToken; State(final Map params, final BearerToken bearerToken) { this.params = params; this.bearerToken = bearerToken; } @Override public String toString() { return "State{" + "params=" + params + ", bearerToken=" + bearerToken + '}'; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/NTLMScheme.java0100664 0000000 0000000 00000015667 14704162040 026113 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.security.Principal; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * NTLM is a proprietary authentication scheme developed by Microsoft * and optimized for Windows platforms. * * @since 4.0 * * @deprecated Do not use. the NTLM authentication scheme is no longer supported. * Consider using Basic or Bearer authentication with TLS instead. * * @see BasicScheme * @see BearerScheme */ @Deprecated public final class NTLMScheme implements AuthScheme { private static final Logger LOG = LoggerFactory.getLogger(NTLMScheme.class); enum State { UNINITIATED, CHALLENGE_RECEIVED, MSG_TYPE1_GENERATED, MSG_TYPE2_RECEIVED, MSG_TYPE3_GENERATED, FAILED, } private final NTLMEngine engine; private State state; private String challenge; private org.apache.hc.client5.http.auth.NTCredentials credentials; public NTLMScheme(final NTLMEngine engine) { super(); Args.notNull(engine, "NTLM engine"); this.engine = engine; this.state = State.UNINITIATED; } /** * @since 4.3 */ public NTLMScheme() { this(new NTLMEngineImpl()); } @Override public String getName() { return StandardAuthScheme.NTLM; } @Override public boolean isConnectionBased() { return true; } @Override public String getRealm() { return null; } @Override public void processChallenge( final AuthChallenge authChallenge, final HttpContext context) throws MalformedChallengeException { Args.notNull(authChallenge, "AuthChallenge"); this.challenge = authChallenge.getValue(); if (this.challenge == null || this.challenge.isEmpty()) { if (this.state == State.UNINITIATED) { this.state = State.CHALLENGE_RECEIVED; } else { this.state = State.FAILED; } } else { if (this.state.compareTo(State.MSG_TYPE1_GENERATED) < 0) { this.state = State.FAILED; throw new MalformedChallengeException("Out of sequence NTLM response message"); } else if (this.state == State.MSG_TYPE1_GENERATED) { this.state = State.MSG_TYPE2_RECEIVED; } } } @Override public boolean isResponseReady( final HttpHost host, final CredentialsProvider credentialsProvider, final HttpContext context) throws AuthenticationException { Args.notNull(host, "Auth host"); Args.notNull(credentialsProvider, "CredentialsProvider"); final AuthScope authScope = new AuthScope(host, null, getName()); final Credentials credentials = credentialsProvider.getCredentials( authScope, context); if (credentials instanceof org.apache.hc.client5.http.auth.NTCredentials) { this.credentials = (org.apache.hc.client5.http.auth.NTCredentials) credentials; return true; } if (LOG.isDebugEnabled()) { final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); LOG.debug("{} No credentials found for auth scope [{}]", exchangeId, authScope); } return false; } @Override public Principal getPrincipal() { return this.credentials != null ? this.credentials.getUserPrincipal() : null; } @Override public String generateAuthResponse( final HttpHost host, final HttpRequest request, final HttpContext context) throws AuthenticationException { if (this.credentials == null) { throw new AuthenticationException("NT credentials not available"); } final String response; if (this.state == State.FAILED) { throw new AuthenticationException("NTLM authentication failed"); } else if (this.state == State.CHALLENGE_RECEIVED) { response = this.engine.generateType1Msg( this.credentials.getNetbiosDomain(), this.credentials.getWorkstation()); this.state = State.MSG_TYPE1_GENERATED; } else if (this.state == State.MSG_TYPE2_RECEIVED) { response = this.engine.generateType3Msg( this.credentials.getUserName(), this.credentials.getPassword(), this.credentials.getNetbiosDomain(), this.credentials.getWorkstation(), this.challenge); this.state = State.MSG_TYPE3_GENERATED; } else { throw new AuthenticationException("Unexpected state: " + this.state); } return StandardAuthScheme.NTLM + " " + response; } @Override public boolean isChallengeComplete() { return this.state == State.MSG_TYPE3_GENERATED || this.state == State.FAILED; } @Override public String toString() { return getName() + "{" + this.state + " " + challenge + '}'; } } ././@LongLink0100644 0000000 0000000 00000000150 14666635064 011647 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/UnsupportedDigestAlgorithmException.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/UnsupportedDigestAlgorithmException.j0100664 0000000 0000000 00000004553 14666635064 032754 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; /** * Authentication credentials required to respond to a authentication * challenge are invalid * * @since 4.0 */ public class UnsupportedDigestAlgorithmException extends RuntimeException { private static final long serialVersionUID = 319558534317118022L; /** * Creates a new UnsupportedDigestAlgorithmException with a {@code null} detail message. */ public UnsupportedDigestAlgorithmException() { super(); } /** * Creates a new UnsupportedDigestAlgorithmException with the specified message. * * @param message the exception detail message */ public UnsupportedDigestAlgorithmException(final String message) { super(message); } /** * Creates a new UnsupportedDigestAlgorithmException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public UnsupportedDigestAlgorithmException(final String message, final Throwable cause) { super(message, cause); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/HttpAuthenticator.java0100664 0000000 0000000 00000006045 15005672016 027660 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.protocol.HttpContext; /** * @deprecated Do not use. */ @Deprecated @Contract(threading = ThreadingBehavior.STATELESS) public final class HttpAuthenticator extends AuthenticationHandler { @Override public boolean isChallenged( final HttpHost host, final ChallengeType challengeType, final HttpResponse response, final AuthExchange authExchange, final HttpContext context) { return super.isChallenged(host, challengeType, response, authExchange, context); } public boolean updateAuthState( final HttpHost host, final ChallengeType challengeType, final HttpResponse response, final AuthenticationStrategy authStrategy, final AuthExchange authExchange, final HttpContext context) { try { return handleResponse(host, challengeType, response, authStrategy, authExchange, context); } catch (final ProtocolException ex) { return false; } } @Override public void addAuthResponse( final HttpHost host, final ChallengeType challengeType, final HttpRequest request, final AuthExchange authExchange, final HttpContext context) { super.addAuthResponse(host, challengeType, request, authExchange, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/AuthChallengeParser.java0100664 0000000 0000000 00000017612 15005672016 030071 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.ArrayList; import java.util.List; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.util.TextUtils; import org.apache.hc.core5.util.Tokenizer; /** * Authentication challenge parser. * * @since 5.0 */ public class AuthChallengeParser { /** * Default instance of {@link AuthChallengeParser}. */ public static final AuthChallengeParser INSTANCE = new AuthChallengeParser(); private final Tokenizer tokenParser = Tokenizer.INSTANCE; private final static char BLANK = ' '; private final static char COMMA_CHAR = ','; private final static char EQUAL_CHAR = '='; private static final Tokenizer.Delimiter TERMINATORS = Tokenizer.delimiters(BLANK, EQUAL_CHAR, COMMA_CHAR); private static final Tokenizer.Delimiter DELIMITER = Tokenizer.delimiters(COMMA_CHAR); private static final Tokenizer.Delimiter SPACE = Tokenizer.delimiters(BLANK); static class ChallengeInt { final String schemeName; final List params; ChallengeInt(final String schemeName) { this.schemeName = schemeName; this.params = new ArrayList<>(); } @Override public String toString() { return "ChallengeInternal{" + "schemeName='" + schemeName + '\'' + ", params=" + params + '}'; } } /** * Parses the given sequence of characters into a list of {@link AuthChallenge} elements. * * @param challengeType the type of challenge (target or proxy). * @param buffer the sequence of characters to be parsed. * @param cursor the parser cursor. * @return a list of auth challenge elements. */ public List parse( final ChallengeType challengeType, final CharSequence buffer, final ParserCursor cursor) throws ParseException { tokenParser.skipWhiteSpace(buffer, cursor); if (cursor.atEnd()) { throw new ParseException("Malformed auth challenge"); } final List internalChallenges = new ArrayList<>(); final String schemeName = tokenParser.parseToken(buffer, cursor, SPACE); if (TextUtils.isBlank(schemeName)) { throw new ParseException("Malformed auth challenge"); } ChallengeInt current = new ChallengeInt(schemeName); while (current != null) { internalChallenges.add(current); current = parseChallenge(buffer, cursor, current); } final List challenges = new ArrayList<>(internalChallenges.size()); for (final ChallengeInt internal : internalChallenges) { final List params = internal.params; String token68 = null; if (params.size() == 1) { final NameValuePair param = params.get(0); if (param.getValue() == null) { token68 = param.getName(); params.clear(); } } challenges.add( new AuthChallenge(challengeType, internal.schemeName, token68, !params.isEmpty() ? params : null)); } return challenges; } ChallengeInt parseChallenge( final CharSequence buffer, final ParserCursor cursor, final ChallengeInt currentChallenge) throws ParseException { for (;;) { tokenParser.skipWhiteSpace(buffer, cursor); if (cursor.atEnd()) { return null; } final String token = parseToken(buffer, cursor); if (TextUtils.isBlank(token)) { throw new ParseException("Malformed auth challenge"); } tokenParser.skipWhiteSpace(buffer, cursor); // it gets really messy here if (cursor.atEnd()) { // at the end of the header currentChallenge.params.add(new BasicNameValuePair(token, null)); } else { char ch = buffer.charAt(cursor.getPos()); if (ch == EQUAL_CHAR) { cursor.updatePos(cursor.getPos() + 1); final String value = tokenParser.parseValue(buffer, cursor, DELIMITER); tokenParser.skipWhiteSpace(buffer, cursor); if (!cursor.atEnd()) { ch = buffer.charAt(cursor.getPos()); if (ch == COMMA_CHAR) { cursor.updatePos(cursor.getPos() + 1); } } currentChallenge.params.add(new BasicNameValuePair(token, value)); } else if (ch == COMMA_CHAR) { cursor.updatePos(cursor.getPos() + 1); currentChallenge.params.add(new BasicNameValuePair(token, null)); } else { // the token represents new challenge if (currentChallenge.params.isEmpty()) { throw new ParseException("Malformed auth challenge"); } return new ChallengeInt(token); } } } } String parseToken(final CharSequence buf, final ParserCursor cursor) { final StringBuilder dst = new StringBuilder(); while (!cursor.atEnd()) { int pos = cursor.getPos(); char current = buf.charAt(pos); if (TERMINATORS.test(current)) { // Here it gets really ugly if (current == EQUAL_CHAR) { // it can be a start of a parameter value or token68 padding // Look ahead and see if there are more '=' or at end of buffer if (pos + 1 < cursor.getUpperBound() && buf.charAt(pos + 1) != EQUAL_CHAR) { break; } do { dst.append(current); pos++; cursor.updatePos(pos); if (cursor.atEnd()) { break; } current = buf.charAt(pos); } while (current == EQUAL_CHAR); } else { break; } } else { dst.append(current); cursor.updatePos(pos + 1); } } return dst.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/NTLMEngineImpl.java0100664 0000000 0000000 00000237672 15005672016 026744 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.security.Key; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import java.security.cert.Certificate; import java.security.cert.CertificateEncodingException; import java.util.Arrays; import java.util.Locale; import java.util.Random; import javax.crypto.Cipher; import javax.crypto.spec.SecretKeySpec; import org.apache.hc.client5.http.utils.Base64; import org.apache.hc.client5.http.utils.ByteArrayBuilder; /** * Provides an implementation for NTLMv1, NTLMv2, and NTLM2 Session forms of the NTLM * authentication protocol. * * @since 4.1 * * @deprecated Do not use. */ @Deprecated final class NTLMEngineImpl implements NTLMEngine { /** Unicode encoding */ private static final Charset UNICODE_LITTLE_UNMARKED = Charset.forName("UnicodeLittleUnmarked"); /** Character encoding */ private static final Charset DEFAULT_CHARSET = StandardCharsets.US_ASCII; // Flags we use; descriptions according to: // http://davenport.sourceforge.net/ntlm.html // and // http://msdn.microsoft.com/en-us/library/cc236650%28v=prot.20%29.aspx // [MS-NLMP] section 2.2.2.5 static final int FLAG_REQUEST_UNICODE_ENCODING = 0x00000001; // Unicode string encoding requested static final int FLAG_REQUEST_OEM_ENCODING = 0x00000002; // OEM string encoding requested static final int FLAG_REQUEST_TARGET = 0x00000004; // Requests target field static final int FLAG_REQUEST_SIGN = 0x00000010; // Requests all messages have a signature attached, in NEGOTIATE message. static final int FLAG_REQUEST_SEAL = 0x00000020; // Request key exchange for message confidentiality in NEGOTIATE message. MUST be used in conjunction with 56BIT. static final int FLAG_REQUEST_LAN_MANAGER_KEY = 0x00000080; // Request Lan Manager key instead of user session key static final int FLAG_REQUEST_NTLMv1 = 0x00000200; // Request NTLMv1 security. MUST be set in NEGOTIATE and CHALLENGE both static final int FLAG_DOMAIN_PRESENT = 0x00001000; // Domain is present in message static final int FLAG_WORKSTATION_PRESENT = 0x00002000; // Workstation is present in message static final int FLAG_REQUEST_ALWAYS_SIGN = 0x00008000; // Requests a signature block on all messages. Overridden by REQUEST_SIGN and REQUEST_SEAL. static final int FLAG_REQUEST_NTLM2_SESSION = 0x00080000; // From server in challenge, requesting NTLM2 session security static final int FLAG_REQUEST_VERSION = 0x02000000; // Request protocol version static final int FLAG_TARGETINFO_PRESENT = 0x00800000; // From server in challenge message, indicating targetinfo is present static final int FLAG_REQUEST_128BIT_KEY_EXCH = 0x20000000; // Request explicit 128-bit key exchange static final int FLAG_REQUEST_EXPLICIT_KEY_EXCH = 0x40000000; // Request explicit key exchange static final int FLAG_REQUEST_56BIT_ENCRYPTION = 0x80000000; // Must be used in conjunction with SEAL // Attribute-value identifiers (AvId) // according to [MS-NLMP] section 2.2.2.1 static final int MSV_AV_EOL = 0x0000; // Indicates that this is the last AV_PAIR in the list. static final int MSV_AV_NB_COMPUTER_NAME = 0x0001; // The server's NetBIOS computer name. static final int MSV_AV_NB_DOMAIN_NAME = 0x0002; // The server's NetBIOS domain name. static final int MSV_AV_DNS_COMPUTER_NAME = 0x0003; // The fully qualified domain name (FQDN) of the computer. static final int MSV_AV_DNS_DOMAIN_NAME = 0x0004; // The FQDN of the domain. static final int MSV_AV_DNS_TREE_NAME = 0x0005; // The FQDN of the forest. static final int MSV_AV_FLAGS = 0x0006; // A 32-bit value indicating server or client configuration. static final int MSV_AV_TIMESTAMP = 0x0007; // server local time static final int MSV_AV_SINGLE_HOST = 0x0008; // A Single_Host_Data structure. static final int MSV_AV_TARGET_NAME = 0x0009; // The SPN of the target server. static final int MSV_AV_CHANNEL_BINDINGS = 0x000A; // A channel bindings hash. static final int MSV_AV_FLAGS_ACCOUNT_AUTH_CONSTAINED = 0x00000001; // Indicates to the client that the account authentication is constrained. static final int MSV_AV_FLAGS_MIC = 0x00000002; // Indicates that the client is providing message integrity in the MIC field in the AUTHENTICATE_MESSAGE. static final int MSV_AV_FLAGS_UNTRUSTED_TARGET_SPN = 0x00000004; // Indicates that the client is providing a target SPN generated from an untrusted source. /** Secure random generator */ private static final java.security.SecureRandom RND_GEN; static { java.security.SecureRandom rnd = null; try { rnd = java.security.SecureRandom.getInstance("SHA1PRNG"); } catch (final Exception ignore) { // ignore } RND_GEN = rnd; } /** The signature string as bytes in the default encoding */ private static final byte[] SIGNATURE = getNullTerminatedAsciiString("NTLMSSP"); // Key derivation magic strings for the SIGNKEY algorithm defined in // [MS-NLMP] section 3.4.5.2ASCII private static final byte[] SIGN_MAGIC_SERVER = getNullTerminatedAsciiString( "session key to server-to-client signing key magic constant"); private static final byte[] SIGN_MAGIC_CLIENT = getNullTerminatedAsciiString( "session key to client-to-server signing key magic constant"); private static final byte[] SEAL_MAGIC_SERVER = getNullTerminatedAsciiString( "session key to server-to-client sealing key magic constant"); private static final byte[] SEAL_MAGIC_CLIENT = getNullTerminatedAsciiString( "session key to client-to-server sealing key magic constant"); // prefix for GSS API channel binding private static final byte[] MAGIC_TLS_SERVER_ENDPOINT = "tls-server-end-point:".getBytes(StandardCharsets.US_ASCII); private static byte[] getNullTerminatedAsciiString( final String source ) { final byte[] bytesWithoutNull = source.getBytes(StandardCharsets.US_ASCII); final byte[] target = new byte[bytesWithoutNull.length + 1]; System.arraycopy(bytesWithoutNull, 0, target, 0, bytesWithoutNull.length); target[bytesWithoutNull.length] = (byte) 0x00; return target; } private static final String TYPE_1_MESSAGE = new Type1Message().getResponse(); NTLMEngineImpl() { } /** * Returns the response for the given message. * * @param message * the message that was received from the server. * @param username * the username to authenticate with. * @param password * the password to authenticate with. * @param host * The host. * @param domain * the NT domain to authenticate in. * @return The response. */ static String getResponseFor(final String message, final String username, final char[] password, final String host, final String domain) throws NTLMEngineException { final String response; if (message == null || message.trim().isEmpty()) { response = getType1Message(host, domain); } else { final Type2Message t2m = new Type2Message(message); response = getType3Message(username, password, host, domain, t2m.getChallenge(), t2m.getFlags(), t2m.getTarget(), t2m.getTargetInfo()); } return response; } /** * Returns the response for the given message. * * @param message * the message that was received from the server. * @param username * the username to authenticate with. * @param password * the password to authenticate with. * @param host * The host. * @param domain * the NT domain to authenticate in. * @return The response. */ static String getResponseFor(final String message, final String username, final char[] password, final String host, final String domain, final Certificate peerServerCertificate) throws NTLMEngineException { final String response; if (message == null || message.trim().isEmpty()) { response = new Type1Message(host, domain).getResponse(); } else { final Type1Message t1m = new Type1Message(host, domain); final Type2Message t2m = new Type2Message(message); response = getType3Message(username, password, host, domain, t2m.getChallenge(), t2m.getFlags(), t2m.getTarget(), t2m.getTargetInfo(), peerServerCertificate, t1m.getBytes(), t2m.getBytes()); } return response; } /** * Creates the first message (type 1 message) in the NTLM authentication * sequence. This message includes the user name, domain and host for the * authentication session. * * @param host * the computer name of the host requesting authentication. * @param domain * The domain to authenticate with. * @return String the message to add to the HTTP request header. */ static String getType1Message(final String host, final String domain) { // For compatibility reason do not include domain and host in type 1 message //return new Type1Message(domain, host).getResponse(); return TYPE_1_MESSAGE; } /** * Creates the type 3 message using the given server nonce. The type 3 * message includes all the information for authentication, host, domain, * username and the result of encrypting the nonce sent by the server using * the user's password as the key. * * @param user * The user name. This should not include the domain name. * @param password * The password. * @param host * The host that is originating the authentication request. * @param domain * The domain to authenticate within. * @param nonce * the 8 byte array the server sent. * @return The type 3 message. * @throws NTLMEngineException * If {@link Type3Message#Type3Message(String, String, String, char[], byte[], int, String, byte[])} fails. */ static String getType3Message(final String user, final char[] password, final String host, final String domain, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation) throws NTLMEngineException { return new Type3Message(domain, host, user, password, nonce, type2Flags, target, targetInformation).getResponse(); } /** * Creates the type 3 message using the given server nonce. The type 3 * message includes all the information for authentication, host, domain, * username and the result of encrypting the nonce sent by the server using * the user's password as the key. * * @param user * The user name. This should not include the domain name. * @param password * The password. * @param host * The host that is originating the authentication request. * @param domain * The domain to authenticate within. * @param nonce * the 8 byte array the server sent. * @return The type 3 message. */ static String getType3Message(final String user, final char[] password, final String host, final String domain, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation, final Certificate peerServerCertificate, final byte[] type1Message, final byte[] type2Message) throws NTLMEngineException { return new Type3Message(domain, host, user, password, nonce, type2Flags, target, targetInformation, peerServerCertificate, type1Message, type2Message).getResponse(); } private static int readULong(final byte[] src, final int index) { if (src.length < index + 4) { return 0; } return (src[index] & 0xff) | ((src[index + 1] & 0xff) << 8) | ((src[index + 2] & 0xff) << 16) | ((src[index + 3] & 0xff) << 24); } private static int readUShort(final byte[] src, final int index) { if (src.length < index + 2) { return 0; } return (src[index] & 0xff) | ((src[index + 1] & 0xff) << 8); } private static byte[] readSecurityBuffer(final byte[] src, final int index) { final int length = readUShort(src, index); final int offset = readULong(src, index + 4); if (src.length < offset + length) { return new byte[length]; } final byte[] buffer = new byte[length]; System.arraycopy(src, offset, buffer, 0, length); return buffer; } /** Calculate a challenge block */ private static byte[] makeRandomChallenge(final Random random) { final byte[] rval = new byte[8]; synchronized (random) { random.nextBytes(rval); } return rval; } /** Calculate a 16-byte secondary key */ private static byte[] makeSecondaryKey(final Random random) { final byte[] rval = new byte[16]; synchronized (random) { random.nextBytes(rval); } return rval; } static class CipherGen { final Random random; final long currentTime; final String domain; final String user; final char[] password; final byte[] challenge; final String target; final byte[] targetInformation; // Information we can generate but may be passed in (for testing) byte[] clientChallenge; byte[] clientChallenge2; byte[] secondaryKey; byte[] timestamp; // Stuff we always generate byte[] lmHash; byte[] lmResponse; byte[] ntlmHash; byte[] ntlmResponse; byte[] ntlmv2Hash; byte[] lmv2Hash; byte[] lmv2Response; byte[] ntlmv2Blob; byte[] ntlmv2Response; byte[] ntlm2SessionResponse; byte[] lm2SessionResponse; byte[] lmUserSessionKey; byte[] ntlmUserSessionKey; byte[] ntlmv2UserSessionKey; byte[] ntlm2SessionResponseUserSessionKey; byte[] lanManagerSessionKey; CipherGen(final Random random, final long currentTime, final String domain, final String user, final char[] password, final byte[] challenge, final String target, final byte[] targetInformation, final byte[] clientChallenge, final byte[] clientChallenge2, final byte[] secondaryKey, final byte[] timestamp) { this.random = random; this.currentTime = currentTime; this.domain = domain; this.target = target; this.user = user; this.password = password; this.challenge = challenge; this.targetInformation = targetInformation; this.clientChallenge = clientChallenge; this.clientChallenge2 = clientChallenge2; this.secondaryKey = secondaryKey; this.timestamp = timestamp; } CipherGen(final Random random, final long currentTime, final String domain, final String user, final char[] password, final byte[] challenge, final String target, final byte[] targetInformation) { this(random, currentTime, domain, user, password, challenge, target, targetInformation, null, null, null, null); } /** Calculate and return client challenge */ byte[] getClientChallenge() { if (clientChallenge == null) { clientChallenge = makeRandomChallenge(random); } return clientChallenge; } /** Calculate and return second client challenge */ byte[] getClientChallenge2() { if (clientChallenge2 == null) { clientChallenge2 = makeRandomChallenge(random); } return clientChallenge2; } /** Calculate and return random secondary key */ byte[] getSecondaryKey() { if (secondaryKey == null) { secondaryKey = makeSecondaryKey(random); } return secondaryKey; } /** Calculate and return the LMHash */ byte[] getLMHash() throws NTLMEngineException { if (lmHash == null) { lmHash = lmHash(password); } return lmHash; } /** Calculate and return the LMResponse */ byte[] getLMResponse() throws NTLMEngineException { if (lmResponse == null) { lmResponse = lmResponse(getLMHash(), challenge); } return lmResponse; } /** Calculate and return the NTLMHash */ byte[] getNTLMHash() { if (ntlmHash == null) { ntlmHash = ntlmHash(password); } return ntlmHash; } /** Calculate and return the NTLMResponse */ byte[] getNTLMResponse() throws NTLMEngineException { if (ntlmResponse == null) { ntlmResponse = lmResponse(getNTLMHash(), challenge); } return ntlmResponse; } /** Calculate the LMv2 hash */ byte[] getLMv2Hash() { if (lmv2Hash == null) { lmv2Hash = lmv2Hash(domain, user, getNTLMHash()); } return lmv2Hash; } /** Calculate the NTLMv2 hash */ byte[] getNTLMv2Hash() { if (ntlmv2Hash == null) { ntlmv2Hash = ntlmv2Hash(domain, user, getNTLMHash()); } return ntlmv2Hash; } /** Calculate a timestamp */ byte[] getTimestamp() { if (timestamp == null) { long time = this.currentTime; time += 11644473600000L; // milliseconds from January 1, 1601 -> epoch. time *= 10000; // tenths of a microsecond. // convert to little-endian byte array. timestamp = new byte[8]; for (int i = 0; i < 8; i++) { timestamp[i] = (byte) time; time >>>= 8; } } return timestamp; } /** Calculate the NTLMv2Blob */ byte[] getNTLMv2Blob() { if (ntlmv2Blob == null) { ntlmv2Blob = createBlob(getClientChallenge2(), targetInformation, getTimestamp()); } return ntlmv2Blob; } /** Calculate the NTLMv2Response */ byte[] getNTLMv2Response() { if (ntlmv2Response == null) { ntlmv2Response = lmv2Response(getNTLMv2Hash(), challenge, getNTLMv2Blob()); } return ntlmv2Response; } /** Calculate the LMv2Response */ byte[] getLMv2Response() { if (lmv2Response == null) { lmv2Response = lmv2Response(getLMv2Hash(), challenge, getClientChallenge()); } return lmv2Response; } /** Get NTLM2SessionResponse */ byte[] getNTLM2SessionResponse() throws NTLMEngineException { if (ntlm2SessionResponse == null) { ntlm2SessionResponse = ntlm2SessionResponse(getNTLMHash(), challenge, getClientChallenge()); } return ntlm2SessionResponse; } /** Calculate and return LM2 session response */ byte[] getLM2SessionResponse() { if (lm2SessionResponse == null) { final byte[] clntChallenge = getClientChallenge(); lm2SessionResponse = new byte[24]; System.arraycopy(clntChallenge, 0, lm2SessionResponse, 0, clntChallenge.length); Arrays.fill(lm2SessionResponse, clntChallenge.length, lm2SessionResponse.length, (byte) 0x00); } return lm2SessionResponse; } /** Get LMUserSessionKey */ byte[] getLMUserSessionKey() throws NTLMEngineException { if (lmUserSessionKey == null) { lmUserSessionKey = new byte[16]; System.arraycopy(getLMHash(), 0, lmUserSessionKey, 0, 8); Arrays.fill(lmUserSessionKey, 8, 16, (byte) 0x00); } return lmUserSessionKey; } /** Get NTLMUserSessionKey */ byte[] getNTLMUserSessionKey() { if (ntlmUserSessionKey == null) { final MD4 md4 = new MD4(); md4.update(getNTLMHash()); ntlmUserSessionKey = md4.getOutput(); } return ntlmUserSessionKey; } /** GetNTLMv2UserSessionKey */ byte[] getNTLMv2UserSessionKey() { if (ntlmv2UserSessionKey == null) { final byte[] ntlmv2hash = getNTLMv2Hash(); final byte[] truncatedResponse = new byte[16]; System.arraycopy(getNTLMv2Response(), 0, truncatedResponse, 0, 16); ntlmv2UserSessionKey = hmacMD5(truncatedResponse, ntlmv2hash); } return ntlmv2UserSessionKey; } /** Get NTLM2SessionResponseUserSessionKey */ byte[] getNTLM2SessionResponseUserSessionKey() { if (ntlm2SessionResponseUserSessionKey == null) { final byte[] ntlm2SessionResponseNonce = getLM2SessionResponse(); final byte[] sessionNonce = new byte[challenge.length + ntlm2SessionResponseNonce.length]; System.arraycopy(challenge, 0, sessionNonce, 0, challenge.length); System.arraycopy(ntlm2SessionResponseNonce, 0, sessionNonce, challenge.length, ntlm2SessionResponseNonce.length); ntlm2SessionResponseUserSessionKey = hmacMD5(sessionNonce,getNTLMUserSessionKey()); } return ntlm2SessionResponseUserSessionKey; } /** Get LAN Manager session key */ byte[] getLanManagerSessionKey() throws NTLMEngineException { if (lanManagerSessionKey == null) { try { final byte[] keyBytes = new byte[14]; System.arraycopy(getLMHash(), 0, keyBytes, 0, 8); Arrays.fill(keyBytes, 8, keyBytes.length, (byte)0xbd); final Key lowKey = createDESKey(keyBytes, 0); final Key highKey = createDESKey(keyBytes, 7); final byte[] truncatedResponse = new byte[8]; System.arraycopy(getLMResponse(), 0, truncatedResponse, 0, truncatedResponse.length); Cipher des = Cipher.getInstance("DES/ECB/NoPadding"); des.init(Cipher.ENCRYPT_MODE, lowKey); final byte[] lowPart = des.doFinal(truncatedResponse); des = Cipher.getInstance("DES/ECB/NoPadding"); des.init(Cipher.ENCRYPT_MODE, highKey); final byte[] highPart = des.doFinal(truncatedResponse); lanManagerSessionKey = new byte[16]; System.arraycopy(lowPart, 0, lanManagerSessionKey, 0, lowPart.length); System.arraycopy(highPart, 0, lanManagerSessionKey, lowPart.length, highPart.length); } catch (final Exception e) { throw new NTLMEngineException(e.getMessage(), e); } } return lanManagerSessionKey; } } /** Calculates HMAC-MD5 */ static byte[] hmacMD5(final byte[] value, final byte[] key) { final HMACMD5 hmacMD5 = new HMACMD5(key); hmacMD5.update(value); return hmacMD5.getOutput(); } /** Calculates RC4 */ static byte[] RC4(final byte[] value, final byte[] key) throws NTLMEngineException { try { final Cipher rc4 = Cipher.getInstance("RC4"); rc4.init(Cipher.ENCRYPT_MODE, new SecretKeySpec(key, "RC4")); return rc4.doFinal(value); } catch (final Exception e) { throw new NTLMEngineException(e.getMessage(), e); } } /** * Calculates the NTLM2 Session Response for the given challenge, using the * specified password and client challenge. * * @return The NTLM2 Session Response. This is placed in the NTLM response * field of the Type 3 message; the LM response field contains the * client challenge, null-padded to 24 bytes. */ static byte[] ntlm2SessionResponse(final byte[] ntlmHash, final byte[] challenge, final byte[] clientChallenge) throws NTLMEngineException { try { final MessageDigest md5 = getMD5(); md5.update(challenge); md5.update(clientChallenge); final byte[] digest = md5.digest(); final byte[] sessionHash = new byte[8]; System.arraycopy(digest, 0, sessionHash, 0, 8); return lmResponse(ntlmHash, sessionHash); } catch (final Exception e) { if (e instanceof NTLMEngineException) { throw (NTLMEngineException) e; } throw new NTLMEngineException(e.getMessage(), e); } } /** * Creates the LM Hash of the user's password. * * @param password * The password. * * @return The LM Hash of the given password, used in the calculation of the * LM Response. */ private static byte[] lmHash(final char[] password) throws NTLMEngineException { try { final char[] tmp = new char[password.length]; for (int i = 0; i < password.length; i++) { tmp[i] = Character.toUpperCase(password[i]); } final byte[] oemPassword = new ByteArrayBuilder().append(tmp).toByteArray(); final int length = Math.min(oemPassword.length, 14); final byte[] keyBytes = new byte[14]; System.arraycopy(oemPassword, 0, keyBytes, 0, length); final Key lowKey = createDESKey(keyBytes, 0); final Key highKey = createDESKey(keyBytes, 7); final byte[] magicConstant = "KGS!@#$%".getBytes(StandardCharsets.US_ASCII); final Cipher des = Cipher.getInstance("DES/ECB/NoPadding"); des.init(Cipher.ENCRYPT_MODE, lowKey); final byte[] lowHash = des.doFinal(magicConstant); des.init(Cipher.ENCRYPT_MODE, highKey); final byte[] highHash = des.doFinal(magicConstant); final byte[] lmHash = new byte[16]; System.arraycopy(lowHash, 0, lmHash, 0, 8); System.arraycopy(highHash, 0, lmHash, 8, 8); return lmHash; } catch (final Exception e) { throw new NTLMEngineException(e.getMessage(), e); } } /** * Creates the NTLM Hash of the user's password. * * @param password * The password. * * @return The NTLM Hash of the given password, used in the calculation of * the NTLM Response and the NTLMv2 and LMv2 Hashes. */ private static byte[] ntlmHash(final char[] password) { final byte[] unicodePassword = new ByteArrayBuilder() .charset(UNICODE_LITTLE_UNMARKED).append(password).toByteArray(); final MD4 md4 = new MD4(); md4.update(unicodePassword); return md4.getOutput(); } /** * Creates the LMv2 Hash of the user's password. * * @return The LMv2 Hash, used in the calculation of the NTLMv2 and LMv2 * Responses. */ private static byte[] lmv2Hash(final String domain, final String user, final byte[] ntlmHash) { final HMACMD5 hmacMD5 = new HMACMD5(ntlmHash); // Upper case username, upper case domain! hmacMD5.update(user.toUpperCase(Locale.ROOT).getBytes(UNICODE_LITTLE_UNMARKED)); if (domain != null) { hmacMD5.update(domain.toUpperCase(Locale.ROOT).getBytes(UNICODE_LITTLE_UNMARKED)); } return hmacMD5.getOutput(); } /** * Creates the NTLMv2 Hash of the user's password. * * @return The NTLMv2 Hash, used in the calculation of the NTLMv2 and LMv2 * Responses. */ private static byte[] ntlmv2Hash(final String domain, final String user, final byte[] ntlmHash) { final HMACMD5 hmacMD5 = new HMACMD5(ntlmHash); // Upper case username, mixed case target!! hmacMD5.update(user.toUpperCase(Locale.ROOT).getBytes(UNICODE_LITTLE_UNMARKED)); if (domain != null) { hmacMD5.update(domain.getBytes(UNICODE_LITTLE_UNMARKED)); } return hmacMD5.getOutput(); } /** * Creates the LM Response from the given hash and Type 2 challenge. * * @param hash * The LM or NTLM Hash. * @param challenge * The server challenge from the Type 2 message. * * @return The response (either LM or NTLM, depending on the provided hash). */ private static byte[] lmResponse(final byte[] hash, final byte[] challenge) throws NTLMEngineException { try { final byte[] keyBytes = new byte[21]; System.arraycopy(hash, 0, keyBytes, 0, 16); final Key lowKey = createDESKey(keyBytes, 0); final Key middleKey = createDESKey(keyBytes, 7); final Key highKey = createDESKey(keyBytes, 14); final Cipher des = Cipher.getInstance("DES/ECB/NoPadding"); des.init(Cipher.ENCRYPT_MODE, lowKey); final byte[] lowResponse = des.doFinal(challenge); des.init(Cipher.ENCRYPT_MODE, middleKey); final byte[] middleResponse = des.doFinal(challenge); des.init(Cipher.ENCRYPT_MODE, highKey); final byte[] highResponse = des.doFinal(challenge); final byte[] lmResponse = new byte[24]; System.arraycopy(lowResponse, 0, lmResponse, 0, 8); System.arraycopy(middleResponse, 0, lmResponse, 8, 8); System.arraycopy(highResponse, 0, lmResponse, 16, 8); return lmResponse; } catch (final Exception e) { throw new NTLMEngineException(e.getMessage(), e); } } /** * Creates the LMv2 Response from the given hash, client data, and Type 2 * challenge. * * @param hash * The NTLMv2 Hash. * @param clientData * The client data (blob or client challenge). * @param challenge * The server challenge from the Type 2 message. * * @return The response (either NTLMv2 or LMv2, depending on the client * data). */ private static byte[] lmv2Response(final byte[] hash, final byte[] challenge, final byte[] clientData) { final HMACMD5 hmacMD5 = new HMACMD5(hash); hmacMD5.update(challenge); hmacMD5.update(clientData); final byte[] mac = hmacMD5.getOutput(); final byte[] lmv2Response = new byte[mac.length + clientData.length]; System.arraycopy(mac, 0, lmv2Response, 0, mac.length); System.arraycopy(clientData, 0, lmv2Response, mac.length, clientData.length); return lmv2Response; } enum Mode { CLIENT, SERVER } static class Handle { private final byte[] signingKey; private byte[] sealingKey; private final Cipher rc4; final Mode mode; final private boolean isConnection; int sequenceNumber; Handle( final byte[] exportedSessionKey, final Mode mode, final boolean isConnection ) throws NTLMEngineException { this.isConnection = isConnection; this.mode = mode; try { final MessageDigest signMd5 = getMD5(); final MessageDigest sealMd5 = getMD5(); signMd5.update( exportedSessionKey ); sealMd5.update( exportedSessionKey ); if ( mode == Mode.CLIENT ) { signMd5.update( SIGN_MAGIC_CLIENT ); sealMd5.update( SEAL_MAGIC_CLIENT ); } else { signMd5.update( SIGN_MAGIC_SERVER ); sealMd5.update( SEAL_MAGIC_SERVER ); } signingKey = signMd5.digest(); sealingKey = sealMd5.digest(); } catch ( final Exception e ) { throw new NTLMEngineException( e.getMessage(), e ); } rc4 = initCipher(); } byte[] getSigningKey() { return signingKey; } byte[] getSealingKey() { return sealingKey; } private Cipher initCipher() throws NTLMEngineException { final Cipher cipher; try { cipher = Cipher.getInstance( "RC4" ); if ( mode == Mode.CLIENT ) { cipher.init( Cipher.ENCRYPT_MODE, new SecretKeySpec( sealingKey, "RC4" ) ); } else { cipher.init( Cipher.DECRYPT_MODE, new SecretKeySpec( sealingKey, "RC4" ) ); } } catch ( final Exception e ) { throw new NTLMEngineException( e.getMessage(), e ); } return cipher; } private void advanceMessageSequence() throws NTLMEngineException { if ( !isConnection ) { final MessageDigest sealMd5 = getMD5(); sealMd5.update( sealingKey ); final byte[] seqNumBytes = new byte[4]; writeULong( seqNumBytes, sequenceNumber, 0 ); sealMd5.update( seqNumBytes ); sealingKey = sealMd5.digest(); initCipher(); } sequenceNumber++; } private byte[] encrypt( final byte[] data ) { return rc4.update( data ); } private byte[] decrypt( final byte[] data ) { return rc4.update( data ); } private byte[] computeSignature( final byte[] message ) { final byte[] sig = new byte[16]; // version sig[0] = 0x01; sig[1] = 0x00; sig[2] = 0x00; sig[3] = 0x00; // HMAC (first 8 bytes) final HMACMD5 hmacMD5 = new HMACMD5( signingKey ); hmacMD5.update( encodeLong( sequenceNumber ) ); hmacMD5.update( message ); final byte[] hmac = hmacMD5.getOutput(); final byte[] trimmedHmac = new byte[8]; System.arraycopy( hmac, 0, trimmedHmac, 0, 8 ); final byte[] encryptedHmac = encrypt( trimmedHmac ); System.arraycopy( encryptedHmac, 0, sig, 4, 8 ); // sequence number encodeLong( sig, 12, sequenceNumber ); return sig; } private boolean validateSignature( final byte[] signature, final byte[] message ) { final byte[] computedSignature = computeSignature( message ); // log.info( "SSSSS validateSignature("+seqNumber+")\n" // + " received: " + DebugUtil.dump( signature ) + "\n" // + " computed: " + DebugUtil.dump( computedSignature ) ); return MessageDigest.isEqual( signature, computedSignature ); } byte[] signAndEncryptMessage( final byte[] cleartextMessage ) throws NTLMEngineException { final byte[] encryptedMessage = encrypt( cleartextMessage ); final byte[] signature = computeSignature( cleartextMessage ); final byte[] outMessage = new byte[signature.length + encryptedMessage.length]; System.arraycopy( signature, 0, outMessage, 0, signature.length ); System.arraycopy( encryptedMessage, 0, outMessage, signature.length, encryptedMessage.length ); advanceMessageSequence(); return outMessage; } byte[] decryptAndVerifySignedMessage( final byte[] inMessage ) throws NTLMEngineException { final byte[] signature = new byte[16]; System.arraycopy( inMessage, 0, signature, 0, signature.length ); final byte[] encryptedMessage = new byte[inMessage.length - 16]; System.arraycopy( inMessage, 16, encryptedMessage, 0, encryptedMessage.length ); final byte[] cleartextMessage = decrypt( encryptedMessage ); if ( !validateSignature( signature, cleartextMessage ) ) { throw new NTLMEngineException( "Wrong signature" ); } advanceMessageSequence(); return cleartextMessage; } } private static byte[] encodeLong( final int value ) { final byte[] enc = new byte[4]; encodeLong( enc, 0, value ); return enc; } private static void encodeLong( final byte[] buf, final int offset, final int value ) { buf[offset + 0] = ( byte ) ( value & 0xff ); buf[offset + 1] = ( byte ) ( value >> 8 & 0xff ); buf[offset + 2] = ( byte ) ( value >> 16 & 0xff ); buf[offset + 3] = ( byte ) ( value >> 24 & 0xff ); } /** * Creates the NTLMv2 blob from the given target information block and * client challenge. * * @param targetInformation * The target information block from the Type 2 message. * @param clientChallenge * The random 8-byte client challenge. * * @return The blob, used in the calculation of the NTLMv2 Response. */ private static byte[] createBlob(final byte[] clientChallenge, final byte[] targetInformation, final byte[] timestamp) { final byte[] blobSignature = new byte[] { (byte) 0x01, (byte) 0x01, (byte) 0x00, (byte) 0x00 }; final byte[] reserved = new byte[] { (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00 }; final byte[] unknown1 = new byte[] { (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00 }; final byte[] unknown2 = new byte[] { (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00 }; final byte[] blob = new byte[blobSignature.length + reserved.length + timestamp.length + 8 + unknown1.length + targetInformation.length + unknown2.length]; int offset = 0; System.arraycopy(blobSignature, 0, blob, offset, blobSignature.length); offset += blobSignature.length; System.arraycopy(reserved, 0, blob, offset, reserved.length); offset += reserved.length; System.arraycopy(timestamp, 0, blob, offset, timestamp.length); offset += timestamp.length; System.arraycopy(clientChallenge, 0, blob, offset, 8); offset += 8; System.arraycopy(unknown1, 0, blob, offset, unknown1.length); offset += unknown1.length; System.arraycopy(targetInformation, 0, blob, offset, targetInformation.length); offset += targetInformation.length; System.arraycopy(unknown2, 0, blob, offset, unknown2.length); offset += unknown2.length; return blob; } /** * Creates a DES encryption key from the given key material. * * @param bytes * A byte array containing the DES key material. * @param offset * The offset in the given byte array at which the 7-byte key * material starts. * * @return A DES encryption key created from the key material starting at * the specified offset in the given byte array. */ private static Key createDESKey(final byte[] bytes, final int offset) { final byte[] keyBytes = new byte[7]; System.arraycopy(bytes, offset, keyBytes, 0, 7); final byte[] material = new byte[8]; material[0] = keyBytes[0]; material[1] = (byte) (keyBytes[0] << 7 | (keyBytes[1] & 0xff) >>> 1); material[2] = (byte) (keyBytes[1] << 6 | (keyBytes[2] & 0xff) >>> 2); material[3] = (byte) (keyBytes[2] << 5 | (keyBytes[3] & 0xff) >>> 3); material[4] = (byte) (keyBytes[3] << 4 | (keyBytes[4] & 0xff) >>> 4); material[5] = (byte) (keyBytes[4] << 3 | (keyBytes[5] & 0xff) >>> 5); material[6] = (byte) (keyBytes[5] << 2 | (keyBytes[6] & 0xff) >>> 6); material[7] = (byte) (keyBytes[6] << 1); oddParity(material); return new SecretKeySpec(material, "DES"); } /** * Applies odd parity to the given byte array. * * @param bytes * The data whose parity bits are to be adjusted for odd parity. */ private static void oddParity(final byte[] bytes) { for (int i = 0; i < bytes.length; i++) { final byte b = bytes[i]; final boolean needsParity = (((b >>> 7) ^ (b >>> 6) ^ (b >>> 5) ^ (b >>> 4) ^ (b >>> 3) ^ (b >>> 2) ^ (b >>> 1)) & 0x01) == 0; if (needsParity) { bytes[i] |= (byte) 0x01; } else { bytes[i] &= (byte) 0xfe; } } } /** * Find the character set based on the flags. * @param flags is the flags. * @return the character set. */ private static Charset getCharset(final int flags) { if ((flags & FLAG_REQUEST_UNICODE_ENCODING) == 0) { return DEFAULT_CHARSET; } return UNICODE_LITTLE_UNMARKED; } /** NTLM message generation, base class */ static class NTLMMessage { /** The current response */ byte[] messageContents; /** The current output position */ int currentOutputPosition; /** Constructor to use when message contents are not yet known */ NTLMMessage() { } /** Constructor taking a string */ NTLMMessage(final String messageBody, final int expectedType) throws NTLMEngineException { this(Base64.decodeBase64(messageBody.getBytes(DEFAULT_CHARSET)), expectedType); } /** Constructor to use when message bytes are known */ NTLMMessage(final byte[] message, final int expectedType) throws NTLMEngineException { messageContents = message; // Look for NTLM message if (messageContents.length < SIGNATURE.length) { throw new NTLMEngineException("NTLM message decoding error - packet too short"); } int i = 0; while (i < SIGNATURE.length) { if (messageContents[i] != SIGNATURE[i]) { throw new NTLMEngineException( "NTLM message expected - instead got unrecognized bytes"); } i++; } // Check to be sure there's a type 2 message indicator next final int type = readULong(SIGNATURE.length); if (type != expectedType) { throw new NTLMEngineException("NTLM type " + expectedType + " message expected - instead got type " + type); } currentOutputPosition = messageContents.length; } /** * Get the length of the signature and flags, so calculations can adjust * offsets accordingly. */ int getPreambleLength() { return SIGNATURE.length + 4; } /** Get the message length */ int getMessageLength() { return currentOutputPosition; } /** Read a byte from a position within the message buffer */ byte readByte(final int position) throws NTLMEngineException { if (messageContents.length < position + 1) { throw new NTLMEngineException("NTLM: Message too short"); } return messageContents[position]; } /** Read a bunch of bytes from a position in the message buffer */ void readBytes(final byte[] buffer, final int position) throws NTLMEngineException { if (messageContents.length < position + buffer.length) { throw new NTLMEngineException("NTLM: Message too short"); } System.arraycopy(messageContents, position, buffer, 0, buffer.length); } /** Read a ushort from a position within the message buffer */ int readUShort(final int position) { return NTLMEngineImpl.readUShort(messageContents, position); } /** Read a ulong from a position within the message buffer */ int readULong(final int position) { return NTLMEngineImpl.readULong(messageContents, position); } /** Read a security buffer from a position within the message buffer */ byte[] readSecurityBuffer(final int position) { return NTLMEngineImpl.readSecurityBuffer(messageContents, position); } /** * Prepares the object to create a response of the given length. * * @param maxlength * the maximum length of the response to prepare, * including the type and the signature (which this method * adds). */ void prepareResponse(final int maxlength, final int messageType) { messageContents = new byte[maxlength]; currentOutputPosition = 0; addBytes(SIGNATURE); addULong(messageType); } /** * Adds the given byte to the response. * * @param b * the byte to add. */ void addByte(final byte b) { messageContents[currentOutputPosition] = b; currentOutputPosition++; } /** * Adds the given bytes to the response. * * @param bytes * the bytes to add. */ void addBytes(final byte[] bytes) { if (bytes == null) { return; } for (final byte b : bytes) { messageContents[currentOutputPosition] = b; currentOutputPosition++; } } /** Adds a USHORT to the response */ void addUShort(final int value) { addByte((byte) (value & 0xff)); addByte((byte) (value >> 8 & 0xff)); } /** Adds a ULong to the response */ void addULong(final int value) { addByte((byte) (value & 0xff)); addByte((byte) (value >> 8 & 0xff)); addByte((byte) (value >> 16 & 0xff)); addByte((byte) (value >> 24 & 0xff)); } /** * Returns the response that has been generated after shrinking the * array if required and base64 encodes the response. * * @return The response as above. */ String getResponse() { return new String(Base64.encodeBase64(getBytes()), StandardCharsets.US_ASCII); } byte[] getBytes() { if (messageContents == null) { buildMessage(); } if (messageContents.length > currentOutputPosition) { final byte[] tmp = new byte[currentOutputPosition]; System.arraycopy( messageContents, 0, tmp, 0, currentOutputPosition ); messageContents = tmp; } return messageContents; } void buildMessage() { throw new RuntimeException("Message builder not implemented for " + getClass().getName()); } } /** Type 1 message assembly class */ static class Type1Message extends NTLMMessage { private final byte[] hostBytes; private final byte[] domainBytes; private final int flags; Type1Message(final String domain, final String host) { this(domain, host, null); } Type1Message(final String domain, final String host, final Integer flags) { super(); this.flags = flags == null ? getDefaultFlags() : flags.intValue(); // See HTTPCLIENT-1662 final String unqualifiedHost = host; final String unqualifiedDomain = domain; hostBytes = unqualifiedHost != null ? unqualifiedHost.getBytes(UNICODE_LITTLE_UNMARKED) : null; domainBytes = unqualifiedDomain != null ? unqualifiedDomain.toUpperCase(Locale.ROOT).getBytes(UNICODE_LITTLE_UNMARKED) : null; } Type1Message() { super(); hostBytes = null; domainBytes = null; flags = getDefaultFlags(); } private int getDefaultFlags() { return //FLAG_WORKSTATION_PRESENT | //FLAG_DOMAIN_PRESENT | // Required flags //FLAG_REQUEST_LAN_MANAGER_KEY | FLAG_REQUEST_NTLMv1 | FLAG_REQUEST_NTLM2_SESSION | // Protocol version request FLAG_REQUEST_VERSION | // Recommended privacy settings FLAG_REQUEST_ALWAYS_SIGN | //FLAG_REQUEST_SEAL | //FLAG_REQUEST_SIGN | // These must be set according to documentation, based on use of SEAL above FLAG_REQUEST_128BIT_KEY_EXCH | FLAG_REQUEST_56BIT_ENCRYPTION | //FLAG_REQUEST_EXPLICIT_KEY_EXCH | FLAG_REQUEST_UNICODE_ENCODING; } /** * Getting the response involves building the message before returning * it */ @Override void buildMessage() { int domainBytesLength = 0; if ( domainBytes != null ) { domainBytesLength = domainBytes.length; } int hostBytesLength = 0; if ( hostBytes != null ) { hostBytesLength = hostBytes.length; } // Now, build the message. Calculate its length first, including // signature or type. final int finalLength = 32 + 8 + hostBytesLength + domainBytesLength; // Set up the response. This will initialize the signature, message // type, and flags. prepareResponse(finalLength, 1); // Flags. These are the complete set of flags we support. addULong(flags); // Domain length (two times). addUShort(domainBytesLength); addUShort(domainBytesLength); // Domain offset. addULong(hostBytesLength + 32 + 8); // Host length (two times). addUShort(hostBytesLength); addUShort(hostBytesLength); // Host offset (always 32 + 8). addULong(32 + 8); // Version addUShort(0x0105); // Build addULong(2600); // NTLM revision addUShort(0x0f00); // Host (workstation) String. if (hostBytes != null) { addBytes(hostBytes); } // Domain String. if (domainBytes != null) { addBytes(domainBytes); } } } /** Type 2 message class */ static class Type2Message extends NTLMMessage { final byte[] challenge; String target; byte[] targetInfo; final int flags; Type2Message(final String messageBody) throws NTLMEngineException { this(Base64.decodeBase64(messageBody.getBytes(DEFAULT_CHARSET))); } Type2Message(final byte[] message) throws NTLMEngineException { super(message, 2); // Type 2 message is laid out as follows: // First 8 bytes: NTLMSSP[0] // Next 4 bytes: Ulong, value 2 // Next 8 bytes, starting at offset 12: target field (2 ushort lengths, 1 ulong offset) // Next 4 bytes, starting at offset 20: Flags, e.g. 0x22890235 // Next 8 bytes, starting at offset 24: Challenge // Next 8 bytes, starting at offset 32: ??? (8 bytes of zeros) // Next 8 bytes, starting at offset 40: targetinfo field (2 ushort lengths, 1 ulong offset) // Next 2 bytes, major/minor version number (e.g. 0x05 0x02) // Next 8 bytes, build number // Next 2 bytes, protocol version number (e.g. 0x00 0x0f) // Next, various text fields, and a ushort of value 0 at the end // Parse out the rest of the info we need from the message // The nonce is the 8 bytes starting from the byte in position 24. challenge = new byte[8]; readBytes(challenge, 24); flags = readULong(20); // Do the target! target = null; // The TARGET_DESIRED flag is said to not have understood semantics // in Type2 messages, so use the length of the packet to decide // how to proceed instead if (getMessageLength() >= 12 + 8) { final byte[] bytes = readSecurityBuffer(12); if (bytes.length != 0) { target = new String(bytes, getCharset(flags)); } } // Do the target info! targetInfo = null; // TARGET_DESIRED flag cannot be relied on, so use packet length if (getMessageLength() >= 40 + 8) { final byte[] bytes = readSecurityBuffer(40); if (bytes.length != 0) { targetInfo = bytes; } } } /** Retrieve the challenge */ byte[] getChallenge() { return challenge; } /** Retrieve the target */ String getTarget() { return target; } /** Retrieve the target info */ byte[] getTargetInfo() { return targetInfo; } /** Retrieve the response flags */ int getFlags() { return flags; } } /** Type 3 message assembly class */ static class Type3Message extends NTLMMessage { // For mic computation final byte[] type1Message; final byte[] type2Message; // Response flags from the type2 message final int type2Flags; final byte[] domainBytes; final byte[] hostBytes; final byte[] userBytes; byte[] lmResp; byte[] ntResp; final byte[] sessionKey; final byte[] exportedSessionKey; final boolean computeMic; /** More primitive constructor: don't include cert or previous messages. */ Type3Message(final String domain, final String host, final String user, final char[] password, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation) throws NTLMEngineException { this(domain, host, user, password, nonce, type2Flags, target, targetInformation, null, null, null); } /** More primitive constructor: don't include cert or previous messages. */ Type3Message(final Random random, final long currentTime, final String domain, final String host, final String user, final char[] password, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation) throws NTLMEngineException { this(random, currentTime, domain, host, user, password, nonce, type2Flags, target, targetInformation, null, null, null); } /** Constructor. Pass the arguments we will need */ Type3Message(final String domain, final String host, final String user, final char[] password, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation, final Certificate peerServerCertificate, final byte[] type1Message, final byte[] type2Message) throws NTLMEngineException { this(RND_GEN, System.currentTimeMillis(), domain, host, user, password, nonce, type2Flags, target, targetInformation, peerServerCertificate, type1Message, type2Message); } /** Constructor. Pass the arguments we will need */ Type3Message(final Random random, final long currentTime, final String domain, final String host, final String user, final char[] password, final byte[] nonce, final int type2Flags, final String target, final byte[] targetInformation, final Certificate peerServerCertificate, final byte[] type1Message, final byte[] type2Message) throws NTLMEngineException { if (random == null) { throw new NTLMEngineException("Random generator not available"); } // Save the flags this.type2Flags = type2Flags; this.type1Message = type1Message; this.type2Message = type2Message; // All host name manipulations now take place in the credentials final String unqualifiedHost = host; // All domain name manipulations now take place in the credentials final String unqualifiedDomain = domain; byte[] responseTargetInformation = targetInformation; if (peerServerCertificate != null) { responseTargetInformation = addGssMicAvsToTargetInfo(targetInformation, peerServerCertificate); computeMic = true; } else { computeMic = false; } // Create a cipher generator class. Use domain BEFORE it gets modified! final CipherGen gen = new CipherGen(random, currentTime, unqualifiedDomain, user, password, nonce, target, responseTargetInformation); // Use the new code to calculate the responses, including v2 if that // seems warranted. byte[] userSessionKey; try { // This conditional may not work on Windows Server 2008 R2 and above, where it has not yet // been tested if ((type2Flags & FLAG_TARGETINFO_PRESENT) != 0 && targetInformation != null && target != null) { // NTLMv2 ntResp = gen.getNTLMv2Response(); lmResp = gen.getLMv2Response(); if ((type2Flags & FLAG_REQUEST_LAN_MANAGER_KEY) != 0) { userSessionKey = gen.getLanManagerSessionKey(); } else { userSessionKey = gen.getNTLMv2UserSessionKey(); } } else { // NTLMv1 if ((type2Flags & FLAG_REQUEST_NTLM2_SESSION) != 0) { // NTLM2 session stuff is requested ntResp = gen.getNTLM2SessionResponse(); lmResp = gen.getLM2SessionResponse(); if ((type2Flags & FLAG_REQUEST_LAN_MANAGER_KEY) != 0) { userSessionKey = gen.getLanManagerSessionKey(); } else { userSessionKey = gen.getNTLM2SessionResponseUserSessionKey(); } } else { ntResp = gen.getNTLMResponse(); lmResp = gen.getLMResponse(); if ((type2Flags & FLAG_REQUEST_LAN_MANAGER_KEY) != 0) { userSessionKey = gen.getLanManagerSessionKey(); } else { userSessionKey = gen.getNTLMUserSessionKey(); } } } } catch (final NTLMEngineException e) { // This likely means we couldn't find the MD4 hash algorithm - // fail back to just using LM ntResp = new byte[0]; lmResp = gen.getLMResponse(); if ((type2Flags & FLAG_REQUEST_LAN_MANAGER_KEY) != 0) { userSessionKey = gen.getLanManagerSessionKey(); } else { userSessionKey = gen.getLMUserSessionKey(); } } if ((type2Flags & FLAG_REQUEST_SIGN) != 0) { if ((type2Flags & FLAG_REQUEST_EXPLICIT_KEY_EXCH) != 0) { exportedSessionKey = gen.getSecondaryKey(); sessionKey = RC4(exportedSessionKey, userSessionKey); } else { sessionKey = userSessionKey; exportedSessionKey = sessionKey; } } else { if (computeMic) { throw new NTLMEngineException("Cannot sign/seal: no exported session key"); } sessionKey = null; exportedSessionKey = null; } final Charset charset = getCharset(type2Flags); hostBytes = unqualifiedHost != null ? unqualifiedHost.getBytes(charset) : null; domainBytes = unqualifiedDomain != null ? unqualifiedDomain .toUpperCase(Locale.ROOT).getBytes(charset) : null; userBytes = user.getBytes(charset); } byte[] getEncryptedRandomSessionKey() { return sessionKey; } byte[] getExportedSessionKey() { return exportedSessionKey; } /** Assemble the response */ @Override void buildMessage() { final int ntRespLen = ntResp.length; final int lmRespLen = lmResp.length; final int domainLen = domainBytes != null ? domainBytes.length : 0; final int hostLen = hostBytes != null ? hostBytes.length : 0; final int userLen = userBytes.length; final int sessionKeyLen; if (sessionKey != null) { sessionKeyLen = sessionKey.length; } else { sessionKeyLen = 0; } // Calculate the layout within the packet final int lmRespOffset = 72 + // allocate space for the version ( computeMic ? 16 : 0 ); // and MIC final int ntRespOffset = lmRespOffset + lmRespLen; final int domainOffset = ntRespOffset + ntRespLen; final int userOffset = domainOffset + domainLen; final int hostOffset = userOffset + userLen; final int sessionKeyOffset = hostOffset + hostLen; final int finalLength = sessionKeyOffset + sessionKeyLen; // Start the response. Length includes signature and type prepareResponse(finalLength, 3); // LM Resp Length (twice) addUShort(lmRespLen); addUShort(lmRespLen); // LM Resp Offset addULong(lmRespOffset); // NT Resp Length (twice) addUShort(ntRespLen); addUShort(ntRespLen); // NT Resp Offset addULong(ntRespOffset); // Domain length (twice) addUShort(domainLen); addUShort(domainLen); // Domain offset. addULong(domainOffset); // User Length (twice) addUShort(userLen); addUShort(userLen); // User offset addULong(userOffset); // Host length (twice) addUShort(hostLen); addUShort(hostLen); // Host offset addULong(hostOffset); // Session key length (twice) addUShort(sessionKeyLen); addUShort(sessionKeyLen); // Session key offset addULong(sessionKeyOffset); // Flags. addULong( /* //FLAG_WORKSTATION_PRESENT | //FLAG_DOMAIN_PRESENT | // Required flags (type2Flags & FLAG_REQUEST_LAN_MANAGER_KEY) | (type2Flags & FLAG_REQUEST_NTLMv1) | (type2Flags & FLAG_REQUEST_NTLM2_SESSION) | // Protocol version request FLAG_REQUEST_VERSION | // Recommended privacy settings (type2Flags & FLAG_REQUEST_ALWAYS_SIGN) | (type2Flags & FLAG_REQUEST_SEAL) | (type2Flags & FLAG_REQUEST_SIGN) | // These must be set according to documentation, based on use of SEAL above (type2Flags & FLAG_REQUEST_128BIT_KEY_EXCH) | (type2Flags & FLAG_REQUEST_56BIT_ENCRYPTION) | (type2Flags & FLAG_REQUEST_EXPLICIT_KEY_EXCH) | (type2Flags & FLAG_TARGETINFO_PRESENT) | (type2Flags & FLAG_REQUEST_UNICODE_ENCODING) | (type2Flags & FLAG_REQUEST_TARGET) */ type2Flags ); // Version addUShort(0x0105); // Build addULong(2600); // NTLM revision addUShort(0x0f00); int micPosition = -1; if ( computeMic ) { micPosition = currentOutputPosition; currentOutputPosition += 16; } // Add the actual data addBytes(lmResp); addBytes(ntResp); addBytes(domainBytes); addBytes(userBytes); addBytes(hostBytes); if (sessionKey != null) { addBytes(sessionKey); } // Write the mic back into its slot in the message if (computeMic) { // Computation of message integrity code (MIC) as specified in [MS-NLMP] section 3.2.5.1.2. final HMACMD5 hmacMD5 = new HMACMD5( exportedSessionKey ); hmacMD5.update( type1Message ); hmacMD5.update( type2Message ); hmacMD5.update( messageContents ); final byte[] mic = hmacMD5.getOutput(); System.arraycopy( mic, 0, messageContents, micPosition, mic.length ); } } /** * Add GSS channel binding hash and MIC flag to the targetInfo. * Looks like this is needed if we want to use exported session key for GSS wrapping. */ private byte[] addGssMicAvsToTargetInfo( final byte[] originalTargetInfo, final Certificate peerServerCertificate ) throws NTLMEngineException { final byte[] newTargetInfo = new byte[originalTargetInfo.length + 8 + 20]; final int appendLength = originalTargetInfo.length - 4; // last tag is MSV_AV_EOL, do not copy that System.arraycopy( originalTargetInfo, 0, newTargetInfo, 0, appendLength ); writeUShort( newTargetInfo, MSV_AV_FLAGS, appendLength ); writeUShort( newTargetInfo, 4, appendLength + 2 ); writeULong( newTargetInfo, MSV_AV_FLAGS_MIC, appendLength + 4 ); writeUShort( newTargetInfo, MSV_AV_CHANNEL_BINDINGS, appendLength + 8 ); writeUShort( newTargetInfo, 16, appendLength + 10 ); final byte[] channelBindingsHash; try { final byte[] certBytes = peerServerCertificate.getEncoded(); final MessageDigest sha256 = MessageDigest.getInstance( "SHA-256" ); final byte[] certHashBytes = sha256.digest( certBytes ); final byte[] channelBindingStruct = new byte[16 + 4 + MAGIC_TLS_SERVER_ENDPOINT.length + certHashBytes.length]; writeULong( channelBindingStruct, 0x00000035, 16 ); System.arraycopy( MAGIC_TLS_SERVER_ENDPOINT, 0, channelBindingStruct, 20, MAGIC_TLS_SERVER_ENDPOINT.length ); System.arraycopy( certHashBytes, 0, channelBindingStruct, 20 + MAGIC_TLS_SERVER_ENDPOINT.length, certHashBytes.length ); final MessageDigest md5 = getMD5(); channelBindingsHash = md5.digest( channelBindingStruct ); } catch (final CertificateEncodingException | NoSuchAlgorithmException e ) { throw new NTLMEngineException( e.getMessage(), e ); } System.arraycopy( channelBindingsHash, 0, newTargetInfo, appendLength + 12, 16 ); return newTargetInfo; } } static void writeUShort(final byte[] buffer, final int value, final int offset) { buffer[offset] = ( byte ) ( value & 0xff ); buffer[offset + 1] = ( byte ) ( value >> 8 & 0xff ); } static void writeULong(final byte[] buffer, final int value, final int offset) { buffer[offset] = (byte) (value & 0xff); buffer[offset + 1] = (byte) (value >> 8 & 0xff); buffer[offset + 2] = (byte) (value >> 16 & 0xff); buffer[offset + 3] = (byte) (value >> 24 & 0xff); } static int F(final int x, final int y, final int z) { return (x & y) | (~x & z); } static int G(final int x, final int y, final int z) { return (x & y) | (x & z) | (y & z); } static int H(final int x, final int y, final int z) { return x ^ y ^ z; } static int rotintlft(final int val, final int numbits) { return (val << numbits) | (val >>> (32 - numbits)); } static MessageDigest getMD5() { try { return MessageDigest.getInstance("MD5"); } catch (final NoSuchAlgorithmException ex) { throw new RuntimeException("MD5 message digest doesn't seem to exist - fatal error: " + ex.getMessage(), ex); } } /** * Cryptography support - MD4. The following class was based loosely on the * RFC and on code found at http://www.cs.umd.edu/~harry/jotp/src/md.java. * Code correctness was verified by looking at MD4.java from the jcifs * library (http://jcifs.samba.org). It was massaged extensively to the * final form found here by Karl Wright (kwright@metacarta.com). */ static class MD4 { int A = 0x67452301; int B = 0xefcdab89; int C = 0x98badcfe; int D = 0x10325476; long count; final byte[] dataBuffer = new byte[64]; MD4() { } void update(final byte[] input) { // We always deal with 512 bits at a time. Correspondingly, there is // a buffer 64 bytes long that we write data into until it gets // full. int curBufferPos = (int) (count & 63L); int inputIndex = 0; while (input.length - inputIndex + curBufferPos >= dataBuffer.length) { // We have enough data to do the next step. Do a partial copy // and a transform, updating inputIndex and curBufferPos // accordingly final int transferAmt = dataBuffer.length - curBufferPos; System.arraycopy(input, inputIndex, dataBuffer, curBufferPos, transferAmt); count += transferAmt; curBufferPos = 0; inputIndex += transferAmt; processBuffer(); } // If there's anything left, copy it into the buffer and leave it. // We know there's not enough left to process. if (inputIndex < input.length) { final int transferAmt = input.length - inputIndex; System.arraycopy(input, inputIndex, dataBuffer, curBufferPos, transferAmt); count += transferAmt; curBufferPos += transferAmt; } } byte[] getOutput() { // Feed pad/length data into engine. This must round out the input // to a multiple of 512 bits. final int bufferIndex = (int) (count & 63L); final int padLen = (bufferIndex < 56) ? (56 - bufferIndex) : (120 - bufferIndex); final byte[] postBytes = new byte[padLen + 8]; // Leading 0x80, specified amount of zero padding, then length in // bits. postBytes[0] = (byte) 0x80; // Fill out the last 8 bytes with the length for (int i = 0; i < 8; i++) { postBytes[padLen + i] = (byte) ((count * 8) >>> (8 * i)); } // Update the engine update(postBytes); // Calculate final result final byte[] result = new byte[16]; writeULong(result, A, 0); writeULong(result, B, 4); writeULong(result, C, 8); writeULong(result, D, 12); return result; } void processBuffer() { // Convert current buffer to 16 ulongs final int[] d = new int[16]; for (int i = 0; i < 16; i++) { d[i] = (dataBuffer[i * 4] & 0xff) + ((dataBuffer[i * 4 + 1] & 0xff) << 8) + ((dataBuffer[i * 4 + 2] & 0xff) << 16) + ((dataBuffer[i * 4 + 3] & 0xff) << 24); } // Do a round of processing final int AA = A; final int BB = B; final int CC = C; final int DD = D; round1(d); round2(d); round3(d); A += AA; B += BB; C += CC; D += DD; } void round1(final int[] d) { A = rotintlft(A + F(B, C, D) + d[0], 3); D = rotintlft(D + F(A, B, C) + d[1], 7); C = rotintlft(C + F(D, A, B) + d[2], 11); B = rotintlft(B + F(C, D, A) + d[3], 19); A = rotintlft(A + F(B, C, D) + d[4], 3); D = rotintlft(D + F(A, B, C) + d[5], 7); C = rotintlft(C + F(D, A, B) + d[6], 11); B = rotintlft(B + F(C, D, A) + d[7], 19); A = rotintlft(A + F(B, C, D) + d[8], 3); D = rotintlft(D + F(A, B, C) + d[9], 7); C = rotintlft(C + F(D, A, B) + d[10], 11); B = rotintlft(B + F(C, D, A) + d[11], 19); A = rotintlft(A + F(B, C, D) + d[12], 3); D = rotintlft(D + F(A, B, C) + d[13], 7); C = rotintlft(C + F(D, A, B) + d[14], 11); B = rotintlft(B + F(C, D, A) + d[15], 19); } void round2(final int[] d) { A = rotintlft(A + G(B, C, D) + d[0] + 0x5a827999, 3); D = rotintlft(D + G(A, B, C) + d[4] + 0x5a827999, 5); C = rotintlft(C + G(D, A, B) + d[8] + 0x5a827999, 9); B = rotintlft(B + G(C, D, A) + d[12] + 0x5a827999, 13); A = rotintlft(A + G(B, C, D) + d[1] + 0x5a827999, 3); D = rotintlft(D + G(A, B, C) + d[5] + 0x5a827999, 5); C = rotintlft(C + G(D, A, B) + d[9] + 0x5a827999, 9); B = rotintlft(B + G(C, D, A) + d[13] + 0x5a827999, 13); A = rotintlft(A + G(B, C, D) + d[2] + 0x5a827999, 3); D = rotintlft(D + G(A, B, C) + d[6] + 0x5a827999, 5); C = rotintlft(C + G(D, A, B) + d[10] + 0x5a827999, 9); B = rotintlft(B + G(C, D, A) + d[14] + 0x5a827999, 13); A = rotintlft(A + G(B, C, D) + d[3] + 0x5a827999, 3); D = rotintlft(D + G(A, B, C) + d[7] + 0x5a827999, 5); C = rotintlft(C + G(D, A, B) + d[11] + 0x5a827999, 9); B = rotintlft(B + G(C, D, A) + d[15] + 0x5a827999, 13); } void round3(final int[] d) { A = rotintlft(A + H(B, C, D) + d[0] + 0x6ed9eba1, 3); D = rotintlft(D + H(A, B, C) + d[8] + 0x6ed9eba1, 9); C = rotintlft(C + H(D, A, B) + d[4] + 0x6ed9eba1, 11); B = rotintlft(B + H(C, D, A) + d[12] + 0x6ed9eba1, 15); A = rotintlft(A + H(B, C, D) + d[2] + 0x6ed9eba1, 3); D = rotintlft(D + H(A, B, C) + d[10] + 0x6ed9eba1, 9); C = rotintlft(C + H(D, A, B) + d[6] + 0x6ed9eba1, 11); B = rotintlft(B + H(C, D, A) + d[14] + 0x6ed9eba1, 15); A = rotintlft(A + H(B, C, D) + d[1] + 0x6ed9eba1, 3); D = rotintlft(D + H(A, B, C) + d[9] + 0x6ed9eba1, 9); C = rotintlft(C + H(D, A, B) + d[5] + 0x6ed9eba1, 11); B = rotintlft(B + H(C, D, A) + d[13] + 0x6ed9eba1, 15); A = rotintlft(A + H(B, C, D) + d[3] + 0x6ed9eba1, 3); D = rotintlft(D + H(A, B, C) + d[11] + 0x6ed9eba1, 9); C = rotintlft(C + H(D, A, B) + d[7] + 0x6ed9eba1, 11); B = rotintlft(B + H(C, D, A) + d[15] + 0x6ed9eba1, 15); } } /** * Cryptography support - HMACMD5 - algorithmically based on various web * resources by Karl Wright */ static class HMACMD5 { final byte[] ipad; final byte[] opad; final MessageDigest md5; HMACMD5(final byte[] input) { byte[] key = input; md5 = getMD5(); // Initialize the pad buffers with the key ipad = new byte[64]; opad = new byte[64]; int keyLength = key.length; if (keyLength > 64) { // Use MD5 of the key instead, as described in RFC 2104 md5.update(key); key = md5.digest(); keyLength = key.length; } int i = 0; while (i < keyLength) { ipad[i] = (byte) (key[i] ^ (byte) 0x36); opad[i] = (byte) (key[i] ^ (byte) 0x5c); i++; } while (i < 64) { ipad[i] = (byte) 0x36; opad[i] = (byte) 0x5c; i++; } // Very important: processChallenge the digest with the ipad buffer md5.reset(); md5.update(ipad); } /** Grab the current digest. This is the "answer". */ byte[] getOutput() { final byte[] digest = md5.digest(); md5.update(opad); return md5.digest(digest); } /** Update by adding a complete array */ void update(final byte[] input) { md5.update(input); } /** Update the algorithm */ void update(final byte[] input, final int offset, final int length) { md5.update(input, offset, length); } } @Override public String generateType1Msg( final String domain, final String workstation) throws NTLMEngineException { return getType1Message(workstation, domain); } @Override public String generateType3Msg( final String username, final char[] password, final String domain, final String workstation, final String challenge) throws NTLMEngineException { final Type2Message t2m = new Type2Message(challenge); return getType3Message( username, password, workstation, domain, t2m.getChallenge(), t2m.getFlags(), t2m.getTarget(), t2m.getTargetInfo()); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ConnPoolSupport.java0100664 0000000 0000000 00000005512 14666635064 026405 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.pool.PoolStats; import org.apache.hc.core5.util.Identifiable; /** * Connection pooling support methods. * * @since 5.0 */ @Internal public final class ConnPoolSupport { public static String getId(final Object object) { if (object == null) { return null; } return object instanceof Identifiable ? ((Identifiable) object).getId() : object.getClass().getSimpleName() + "-" + Integer.toHexString(System.identityHashCode(object)); } public static String formatStats( final HttpRoute route, final Object state, final ConnPoolControl connPool) { final StringBuilder buf = new StringBuilder(); buf.append("[route: ").append(route).append("]"); if (state != null) { buf.append("[state: ").append(state).append("]"); } final PoolStats totals = connPool.getTotalStats(); final PoolStats stats = connPool.getStats(route); buf.append("[total available: ").append(totals.getAvailable()).append("; "); buf.append("route allocated: ").append(stats.getLeased() + stats.getAvailable()); buf.append(" of ").append(stats.getMax()).append("; "); buf.append("total allocated: ").append(totals.getLeased() + totals.getAvailable()); buf.append(" of ").append(totals.getMax()).append("]"); return buf.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultHttpRequestRetryStrategy.java0100664 0000000 0000000 00000021640 15036651120 031606 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.io.IOException; import java.io.InterruptedIOException; import java.net.ConnectException; import java.net.NoRouteToHostException; import java.net.UnknownHostException; import java.time.Instant; import java.util.Arrays; import java.util.Collection; import java.util.HashSet; import java.util.Set; import javax.net.ssl.SSLException; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ConnectionClosedException; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Default implementation of the {@link HttpRequestRetryStrategy} interface. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultHttpRequestRetryStrategy implements HttpRequestRetryStrategy { /** * Default instance of {@link DefaultHttpRequestRetryStrategy}. */ public static final DefaultHttpRequestRetryStrategy INSTANCE = new DefaultHttpRequestRetryStrategy(); /** * Maximum number of allowed retries */ private final int maxRetries; /** * Retry interval between subsequent retries */ private final TimeValue defaultRetryInterval; /** * Derived {@code IOExceptions} which shall not be retried */ private final Set> nonRetriableIOExceptionClasses; /** * HTTP status codes which shall be retried */ private final Set retriableCodes; protected DefaultHttpRequestRetryStrategy( final int maxRetries, final TimeValue defaultRetryInterval, final Collection> clazzes, final Collection codes) { Args.notNegative(maxRetries, "maxRetries"); Args.notNull(defaultRetryInterval, "defaultRetryInterval"); Args.check(TimeValue.isNonNegative(defaultRetryInterval), "Default retry interval is negative"); this.maxRetries = maxRetries; this.defaultRetryInterval = defaultRetryInterval; this.nonRetriableIOExceptionClasses = new HashSet<>(clazzes); this.retriableCodes = new HashSet<>(codes); } /** * Create the HTTP request retry strategy using the following list of * non-retriable I/O exception classes:
*
    *
  • InterruptedIOException
    • *
  • UnknownHostException
    • *
  • ConnectException
    • *
  • ConnectionClosedException
    • *
  • NoRouteToHostException
    • *
  • SSLException
    • *
* * and retriable HTTP status codes:
*
    *
  • SC_TOO_MANY_REQUESTS (429)
    • *
  • SC_SERVICE_UNAVAILABLE (503)
    • *
* * @param maxRetries how many times to retry; 0 means no retries * @param defaultRetryInterval the default retry interval between * subsequent retries if the {@code Retry-After} header is not set * or invalid. */ public DefaultHttpRequestRetryStrategy( final int maxRetries, final TimeValue defaultRetryInterval) { this(maxRetries, defaultRetryInterval, Arrays.asList( InterruptedIOException.class, UnknownHostException.class, ConnectException.class, ConnectionClosedException.class, NoRouteToHostException.class, SSLException.class), Arrays.asList( HttpStatus.SC_TOO_MANY_REQUESTS, HttpStatus.SC_SERVICE_UNAVAILABLE)); } /** * Create the HTTP request retry strategy with a max retry count of 1, * default retry interval of 1 second, and using the following list of * non-retriable I/O exception classes:
*
    *
  • InterruptedIOException
    • *
  • UnknownHostException
    • *
  • ConnectException
    • *
  • ConnectionClosedException
    • *
  • SSLException
    • *
* * and retriable HTTP status codes:
*
    *
  • SC_TOO_MANY_REQUESTS (429)
    • *
  • SC_SERVICE_UNAVAILABLE (503)
    • *
*/ public DefaultHttpRequestRetryStrategy() { this(1, TimeValue.ofSeconds(1L)); } @Override public boolean retryRequest( final HttpRequest request, final IOException exception, final int execCount, final HttpContext context) { Args.notNull(request, "request"); Args.notNull(exception, "exception"); if (execCount > this.maxRetries) { // Do not retry if over max retries return false; } if (this.nonRetriableIOExceptionClasses.contains(exception.getClass())) { return false; } for (final Class rejectException : this.nonRetriableIOExceptionClasses) { if (rejectException.isInstance(exception)) { return false; } } if (request instanceof CancellableDependency && ((CancellableDependency) request).isCancelled()) { return false; } // Retry if the request is considered idempotent return handleAsIdempotent(request); } @Override public boolean retryRequest( final HttpResponse response, final int execCount, final HttpContext context) { Args.notNull(response, "response"); if (context != null) { final HttpClientContext clientContext = HttpClientContext.cast(context); final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault(); final Timeout responseTimeout = requestConfig.getResponseTimeout(); if (responseTimeout != null && defaultRetryInterval.compareTo(responseTimeout) > 0) { return false; } } return execCount <= this.maxRetries && retriableCodes.contains(response.getCode()); } @Override public TimeValue getRetryInterval( final HttpResponse response, final int execCount, final HttpContext context) { Args.notNull(response, "response"); final Header header = response.getFirstHeader(HttpHeaders.RETRY_AFTER); TimeValue retryAfter = null; if (header != null) { final String value = header.getValue(); try { retryAfter = TimeValue.ofSeconds(Long.parseLong(value)); } catch (final NumberFormatException ignore) { final Instant retryAfterDate = DateUtils.parseStandardDate(value); if (retryAfterDate != null) { retryAfter = TimeValue.ofMilliseconds(retryAfterDate.toEpochMilli() - System.currentTimeMillis()); } } if (TimeValue.isPositive(retryAfter)) { return retryAfter; } } return this.defaultRetryInterval; } protected boolean handleAsIdempotent(final HttpRequest request) { return Method.isIdempotent(request.getMethod()); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/0040775 0000000 0000000 00000000000 15063503632 024070 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/package-info.java0100664 0000000 0000000 00000002425 14666635064 027274 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Standard client connection routing API implementations. */ package org.apache.hc.client5.http.impl.routing; httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/SystemDefaultRoutePlanner.java0100664 0000000 0000000 00000011660 15005672016 032063 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.ProxySelector; import java.net.URI; import java.net.URISyntaxException; import java.util.List; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link org.apache.hc.client5.http.routing.HttpRoutePlanner} implementation * based on {@link ProxySelector}. By default, this class will pick up * the proxy settings of the JVM, either from system properties * or from the browser running the application. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class SystemDefaultRoutePlanner extends DefaultRoutePlanner { private final ProxySelector proxySelector; /** * @param proxySelector the proxy selector, or {@code null} for the system default */ public SystemDefaultRoutePlanner( final SchemePortResolver schemePortResolver, final ProxySelector proxySelector) { super(schemePortResolver); this.proxySelector = proxySelector; } /** * @param proxySelector the proxy selector, or {@code null} for the system default */ public SystemDefaultRoutePlanner(final ProxySelector proxySelector) { this(null, proxySelector); } @Override protected HttpHost determineProxy(final HttpHost target, final HttpContext context) throws HttpException { final URI targetURI; try { targetURI = new URI(target.toURI()); } catch (final URISyntaxException ex) { throw new HttpException("Cannot convert host to URI: " + target, ex); } ProxySelector proxySelectorInstance = this.proxySelector; if (proxySelectorInstance == null) { proxySelectorInstance = ProxySelector.getDefault(); } if (proxySelectorInstance == null) { //The proxy selector can be "unset", so we must be able to deal with a null selector return null; } final List proxies = proxySelectorInstance.select(targetURI); final Proxy p = chooseProxy(proxies); HttpHost result = null; if (p.type() == Proxy.Type.HTTP) { // convert the socket address to an HttpHost if (!(p.address() instanceof InetSocketAddress)) { throw new HttpException("Unable to handle non-Inet proxy address: " + p.address()); } final InetSocketAddress isa = (InetSocketAddress) p.address(); // assume default scheme (http) result = new HttpHost(null, isa.getAddress(), isa.getHostString(), isa.getPort()); } return result; } private Proxy chooseProxy(final List proxies) { Proxy result = null; // check the list for one we can use for (int i = 0; result == null && i < proxies.size(); i++) { final Proxy p = proxies.get(i); switch (p.type()) { case DIRECT: case HTTP: result = p; break; case SOCKS: // SOCKS hosts are not handled on the route level. // The socket may make use of the SOCKS host though. break; } } if (result == null) { //@@@ log as warning or info that only a socks proxy is available? // result can only be null if all proxies are socks proxies // socks proxies are not handled on the route planning level result = Proxy.NO_PROXY; } return result; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/DefaultProxyRoutePlanner.java0100664 0000000 0000000 00000004467 14666635064 031745 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; /** * Implementation of an {@link org.apache.hc.client5.http.routing.HttpRoutePlanner} * that routes requests through a default proxy. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultProxyRoutePlanner extends DefaultRoutePlanner { private final HttpHost proxy; public DefaultProxyRoutePlanner(final HttpHost proxy, final SchemePortResolver schemePortResolver) { super(schemePortResolver); this.proxy = Args.notNull(proxy, "Proxy host"); } public DefaultProxyRoutePlanner(final HttpHost proxy) { this(proxy, null); } @Override protected HttpHost determineProxy( final HttpHost target, final HttpContext context) throws HttpException { return proxy; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/DistributedProxySelector.java0100664 0000000 0000000 00000016566 14666635064 032010 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.io.IOException; import java.net.Proxy; import java.net.ProxySelector; import java.net.SocketAddress; import java.net.URI; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.concurrent.atomic.AtomicInteger; /** * A DistributedProxySelector is a custom {@link ProxySelector} implementation that * delegates proxy selection to a list of underlying ProxySelectors in a * distributed manner. It ensures that proxy selection is load-balanced * across the available ProxySelectors, and provides thread safety by * maintaining separate states for each thread. * *

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

The connectFailed() method notifies the active {@link ProxySelector} of a * connection failure, allowing the underlying ProxySelector to handle * connection failures according to its own logic. * * @since 5.3 */ @Contract(threading = ThreadingBehavior.SAFE) public class DistributedProxySelector extends ProxySelector { private static final Logger LOG = LoggerFactory.getLogger(DistributedProxySelector.class); /** * A list of {@link ProxySelector} instances to be used by the DistributedProxySelector * for selecting proxies. */ private final List selectors; /** * A {@link ThreadLocal} variable holding the current {@link ProxySelector} for each thread, * ensuring thread safety when accessing the current {@link ProxySelector}. */ private final ThreadLocal currentSelector; /** * An {@link AtomicInteger} representing the shared index across all threads for * maintaining the current position in the list of ProxySelectors, ensuring * proper distribution of {@link ProxySelector} usage. */ private final AtomicInteger sharedIndex; /** * Constructs a DistributedProxySelector with the given list of {@link ProxySelector}. * The constructor initializes the currentSelector as a {@link ThreadLocal}, and * the sharedIndex as an {@link AtomicInteger}. * * @param selectors the list of ProxySelectors to use. * @throws IllegalArgumentException if the list is null or empty. */ public DistributedProxySelector(final List selectors) { if (selectors == null || selectors.isEmpty()) { throw new IllegalArgumentException("At least one ProxySelector is required"); } this.selectors = new ArrayList<>(selectors); this.currentSelector = new ThreadLocal<>(); this.sharedIndex = new AtomicInteger(); } /** * Selects a list of proxies for the given {@link URI} by delegating to the current * {@link ProxySelector} or the next available {@link ProxySelector} in the list if the current * one returns an empty proxy list. If an {@link Exception} occurs, it will be caught * and ignored, and the next {@link ProxySelector} will be tried. * * @param uri the {@link URI} to select a proxy for. * @return a list of proxies for the given {@link URI}. */ @Override public List select(final URI uri) { List result = Collections.emptyList(); ProxySelector selector; for (int i = 0; i < selectors.size(); i++) { selector = nextSelector(); if (LOG.isDebugEnabled()) { LOG.debug("Selecting next proxy selector for URI {}: {}", uri, selector); } try { currentSelector.set(selector); result = currentSelector.get().select(uri); if (!result.isEmpty()) { break; } } catch (final Exception e) { // ignore and try the next selector if (LOG.isDebugEnabled()) { LOG.debug("Exception caught while selecting proxy for URI {}: {}", uri, e.getMessage()); } } finally { currentSelector.remove(); } } return result; } /** * Notifies the active {@link ProxySelector} of a connection failure. This method * retrieves the current {@link ProxySelector} from the {@link ThreadLocal} variable and * delegates the handling of the connection failure to the underlying * ProxySelector's connectFailed() method. After handling the connection * failure, the current ProxySelector is removed from the {@link ThreadLocal} variable. * * @param uri the {@link URI} that failed to connect. * @param sa the {@link SocketAddress} of the proxy that failed to connect. * @param ioe the {@link IOException} that resulted from the failed connection. */ @Override public void connectFailed(final URI uri, final SocketAddress sa, final IOException ioe) { final ProxySelector selector = currentSelector.get(); if (selector != null) { selector.connectFailed(uri, sa, ioe); currentSelector.remove(); if (LOG.isDebugEnabled()) { LOG.debug("Removed the current ProxySelector for URI {}: {}", uri, selector); } } } /** * Retrieves the next available {@link ProxySelector} in the list of selectors, * incrementing the shared index atomically to ensure proper distribution * across different threads. * * @return the next {@link ProxySelector} in the list. */ private ProxySelector nextSelector() { final int nextIndex = sharedIndex.getAndUpdate(i -> (i + 1) % selectors.size()); return selectors.get(nextIndex); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/DefaultRoutePlanner.java0100664 0000000 0000000 00000012114 15063503632 030652 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import java.net.InetAddress; import java.util.Objects; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.net.URIAuthority; /** * Default implementation of an {@link HttpRoutePlanner}. It will not make use of * any Java system properties, nor of system or browser proxy settings. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultRoutePlanner implements HttpRoutePlanner { private final SchemePortResolver schemePortResolver; public DefaultRoutePlanner(final SchemePortResolver schemePortResolver) { super(); this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; } private static boolean sameNamedEndpoint(final NamedEndpoint n1, final NamedEndpoint n2) { if (n1 == null || n2 == null) { return false; } return Objects.equals(n1.getHostName(), n2.getHostName()) && n1.getPort() == n2.getPort(); } @Override public final HttpRoute determineRoute(final HttpHost host, final HttpRequest request, final HttpContext context) throws HttpException { if (host == null) { throw new ProtocolException("Target host is not specified"); } final HttpClientContext clientContext = HttpClientContext.cast(context); final RequestConfig config = clientContext.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") HttpHost proxy = config.getProxy(); if (proxy == null) { proxy = determineProxy(host, context); } final HttpHost target = RoutingSupport.normalize(host, schemePortResolver); if (target.getPort() < 0) { throw new ProtocolException("Unroutable protocol scheme: " + target); } final boolean secure = URIScheme.HTTPS.same(target.getSchemeName()); final URIAuthority authority; if (secure && request != null && !sameNamedEndpoint(request.getAuthority(), host)) { authority = request.getAuthority(); } else { authority = null; } final InetAddress inetAddress = determineLocalAddress(target, context); if (proxy == null) { return new HttpRoute(target, authority, inetAddress, secure); } return new HttpRoute(target, authority, inetAddress, proxy, secure); } @Override public final HttpRoute determineRoute(final HttpHost host, final HttpContext context) throws HttpException { return determineRoute(host, null, context); } /** * This implementation returns null. * * @throws HttpException may be thrown if overridden */ protected HttpHost determineProxy( final HttpHost target, final HttpContext context) throws HttpException { return null; } /** * This implementation returns null. * * @throws HttpException may be thrown if overridden */ protected InetAddress determineLocalAddress( final HttpHost firstHop, final HttpContext context) throws HttpException { return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/routing/BasicRouteDirector.java0100664 0000000 0000000 00000014234 15005672016 030467 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.client5.http.routing.HttpRouteDirector; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Basic {@link HttpRouteDirector} implementation. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicRouteDirector implements HttpRouteDirector { /** * Default instance of {@link BasicRouteDirector}. * * @since 5.2 */ public static final BasicRouteDirector INSTANCE = new BasicRouteDirector(); /** * Provides the next step. * * @param plan the planned route * @param fact the currently established route, or * {@code null} if nothing is established * * @return one of the constants defined in this class, indicating * either the next step to perform, or success, or failure. * 0 is for success, a negative value for failure. */ @Override public int nextStep(final RouteInfo plan, final RouteInfo fact) { Args.notNull(plan, "Planned route"); int step = UNREACHABLE; if (fact == null || fact.getHopCount() < 1) { step = firstStep(plan); } else if (plan.getHopCount() > 1) { step = proxiedStep(plan, fact); } else { step = directStep(plan, fact); } return step; } // nextStep /** * Determines the first step to establish a route. * * @param plan the planned route * * @return the first step */ protected int firstStep(final RouteInfo plan) { return (plan.getHopCount() > 1) ? CONNECT_PROXY : CONNECT_TARGET; } /** * Determines the next step to establish a direct connection. * * @param plan the planned route * @param fact the currently established route * * @return one of the constants defined in this class, indicating * either the next step to perform, or success, or failure */ protected int directStep(final RouteInfo plan, final RouteInfo fact) { if (fact.getHopCount() > 1) { return UNREACHABLE; } if (!plan.getTargetHost().equals(fact.getTargetHost())) { return UNREACHABLE; // If the security is too low, we could now suggest to layer // a secure protocol on the direct connection. Layering on direct // connections has not been supported in HttpClient 3.x, we don't // consider it here until there is a real-life use case for it. } // Should we tolerate if security is better than planned? // (plan.isSecure() && !fact.isSecure()) if (plan.isSecure() != fact.isSecure()) { return UNREACHABLE; } // Local address has to match only if the plan specifies one. if (plan.getLocalAddress() != null && !plan.getLocalAddress().equals(fact.getLocalAddress())) { return UNREACHABLE; } return COMPLETE; } /** * Determines the next step to establish a connection via proxy. * * @param plan the planned route * @param fact the currently established route * * @return one of the constants defined in this class, indicating * either the next step to perform, or success, or failure */ protected int proxiedStep(final RouteInfo plan, final RouteInfo fact) { if (fact.getHopCount() <= 1) { return UNREACHABLE; } if (!plan.getTargetHost().equals(fact.getTargetHost())) { return UNREACHABLE; } final int phc = plan.getHopCount(); final int fhc = fact.getHopCount(); if (phc < fhc) { return UNREACHABLE; } for (int i = 0; i < fhc - 1; i++) { if (!plan.getHopTarget(i).equals(fact.getHopTarget(i))) { return UNREACHABLE; } } // now we know that the target matches and proxies so far are the same if (phc > fhc) { return TUNNEL_PROXY; // need to extend the proxy chain } // proxy chain and target are the same, check tunnelling and layering if (fact.isTunnelled() && !plan.isTunnelled() || fact.isLayered() && !plan.isLayered()) { return UNREACHABLE; } if (plan.isTunnelled() && !fact.isTunnelled()) { return TUNNEL_TARGET; } if (plan.isLayered() && !fact.isLayered()) { return LAYER_PROTOCOL; } // tunnel and layering are the same, remains to check the security // Should we tolerate if security is better than planned? // (plan.isSecure() && !fact.isSecure()) if (plan.isSecure() != fact.isSecure()) { return UNREACHABLE; } return COMPLETE; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/0040775 0000000 0000000 00000000000 15064215312 024016 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpClientBuilder.java0100664 0000000 0000000 00000123236 15063503632 030256 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.Closeable; import java.net.ProxySelector; import java.security.AccessController; import java.security.PrivilegedAction; import java.util.ArrayList; import java.util.Collection; import java.util.LinkedHashMap; import java.util.LinkedList; import java.util.List; import java.util.Map; import java.util.function.Function; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.classic.BackoffManager; import org.apache.hc.client5.http.classic.ConnectionBackoffStrategy; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.entity.InputStreamFactory; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.CookieSpecSupport; import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.client5.http.impl.DefaultConnectionKeepAliveStrategy; import org.apache.hc.client5.http.impl.DefaultHttpRequestRetryStrategy; import org.apache.hc.client5.http.impl.DefaultRedirectStrategy; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.DefaultUserTokenHandler; import org.apache.hc.client5.http.impl.IdleConnectionEvictor; import org.apache.hc.client5.http.impl.NoopUserTokenHandler; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory; import org.apache.hc.client5.http.impl.auth.BearerSchemeFactory; import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory; import org.apache.hc.client5.http.impl.auth.SystemDefaultCredentialsProvider; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.impl.routing.DefaultProxyRoutePlanner; import org.apache.hc.client5.http.impl.routing.DefaultRoutePlanner; import org.apache.hc.client5.http.impl.routing.SystemDefaultRoutePlanner; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.protocol.RequestAddCookies; import org.apache.hc.client5.http.protocol.RequestClientConnControl; import org.apache.hc.client5.http.protocol.RequestDefaultHeaders; import org.apache.hc.client5.http.protocol.RequestExpectContinue; import org.apache.hc.client5.http.protocol.RequestUpgrade; import org.apache.hc.client5.http.protocol.RequestValidateTrace; import org.apache.hc.client5.http.protocol.ResponseProcessCookies; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.NamedElementChain; import org.apache.hc.core5.http.config.Registry; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessorBuilder; import org.apache.hc.core5.http.protocol.RequestContent; import org.apache.hc.core5.http.protocol.RequestTargetHost; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.apache.hc.core5.util.VersionInfo; /** * Builder for {@link CloseableHttpClient} instances. *

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

*

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

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

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

*

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

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

* For internal use. *

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

* For internal use. *

*/ @Internal protected void addCloseable(final Closeable closeable) { if (closeable == null) { return; } if (closeables == null) { closeables = new ArrayList<>(); } closeables.add(closeable); } @Internal protected Function contextAdaptor() { return HttpClientContext::castOrCreate; } public CloseableHttpClient build() { // Create main request executor // We copy the instance fields to avoid changing them, and rename to avoid accidental use of the wrong version HttpRequestExecutor requestExecCopy = this.requestExec; if (requestExecCopy == null) { requestExecCopy = new HttpRequestExecutor(); } HttpClientConnectionManager connManagerCopy = this.connManager; if (connManagerCopy == null) { final PoolingHttpClientConnectionManagerBuilder connectionManagerBuilder = PoolingHttpClientConnectionManagerBuilder.create(); if (systemProperties) { connectionManagerBuilder.useSystemProperties(); } connManagerCopy = connectionManagerBuilder.build(); } ConnectionReuseStrategy reuseStrategyCopy = this.reuseStrategy; if (reuseStrategyCopy == null) { if (systemProperties) { final String s = System.getProperty("http.keepAlive", "true"); if ("true".equalsIgnoreCase(s)) { reuseStrategyCopy = DefaultClientConnectionReuseStrategy.INSTANCE; } else { reuseStrategyCopy = (request, response, context) -> false; } } else { reuseStrategyCopy = DefaultClientConnectionReuseStrategy.INSTANCE; } } ConnectionKeepAliveStrategy keepAliveStrategyCopy = this.keepAliveStrategy; if (keepAliveStrategyCopy == null) { keepAliveStrategyCopy = DefaultConnectionKeepAliveStrategy.INSTANCE; } AuthenticationStrategy targetAuthStrategyCopy = this.targetAuthStrategy; if (targetAuthStrategyCopy == null) { targetAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } AuthenticationStrategy proxyAuthStrategyCopy = this.proxyAuthStrategy; if (proxyAuthStrategyCopy == null) { proxyAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } UserTokenHandler userTokenHandlerCopy = this.userTokenHandler; if (userTokenHandlerCopy == null) { if (!connectionStateDisabled) { userTokenHandlerCopy = DefaultUserTokenHandler.INSTANCE; } else { userTokenHandlerCopy = NoopUserTokenHandler.INSTANCE; } } String userAgentCopy = this.userAgent; if (userAgentCopy == null) { if (systemProperties) { userAgentCopy = System.getProperty("http.agent"); } if (userAgentCopy == null && !defaultUserAgentDisabled) { userAgentCopy = VersionInfo.getSoftwareInfo("Apache-HttpClient", "org.apache.hc.client5", getClass()); } } final HttpProcessorBuilder b = HttpProcessorBuilder.create(); if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } b.addAll( new RequestTargetHost(), new RequestValidateTrace(), new RequestDefaultHeaders(defaultHeaders), new RequestContent(), new RequestClientConnControl(), new RequestUserAgent(userAgentCopy), new RequestExpectContinue(), new RequestUpgrade()); if (!cookieManagementDisabled) { b.add(RequestAddCookies.INSTANCE); } if (!cookieManagementDisabled) { b.add(ResponseProcessCookies.INSTANCE); } if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } final HttpProcessor httpProcessor = b.build(); final NamedElementChain execChainDefinition = new NamedElementChain<>(); execChainDefinition.addLast( new MainClientExec(connManagerCopy, httpProcessor, reuseStrategyCopy, keepAliveStrategyCopy, userTokenHandlerCopy), ChainElement.MAIN_TRANSPORT.name()); execChainDefinition.addFirst( new ConnectExec( reuseStrategyCopy, new DefaultHttpProcessor(new RequestTargetHost(), new RequestUserAgent(userAgentCopy)), proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.CONNECT.name()); execChainDefinition.addFirst( new ProtocolExec( targetAuthStrategyCopy, proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.PROTOCOL.name()); if (!contentCompressionDisabled) { if (contentDecoderMap != null) { final List encodings = new ArrayList<>(contentDecoderMap.keySet()); final RegistryBuilder b2 = RegistryBuilder.create(); for (final Map.Entry entry: contentDecoderMap.entrySet()) { b2.register(entry.getKey(), entry.getValue()); } final Registry decoderRegistry = b2.build(); execChainDefinition.addFirst( new ContentCompressionExec(encodings, decoderRegistry, true), ChainElement.COMPRESS.name()); } else { execChainDefinition.addFirst(new ContentCompressionExec(true), ChainElement.COMPRESS.name()); } } // Add request retry executor, if not disabled if (!automaticRetriesDisabled) { HttpRequestRetryStrategy retryStrategyCopy = this.retryStrategy; if (retryStrategyCopy == null) { retryStrategyCopy = DefaultHttpRequestRetryStrategy.INSTANCE; } execChainDefinition.addFirst( new HttpRequestRetryExec(retryStrategyCopy), ChainElement.RETRY.name()); } HttpRoutePlanner routePlannerCopy = this.routePlanner; if (routePlannerCopy == null) { SchemePortResolver schemePortResolverCopy = this.schemePortResolver; if (schemePortResolverCopy == null) { schemePortResolverCopy = DefaultSchemePortResolver.INSTANCE; } if (proxy != null) { routePlannerCopy = new DefaultProxyRoutePlanner(proxy, schemePortResolverCopy); } else if (this.proxySelector != null) { routePlannerCopy = new SystemDefaultRoutePlanner(schemePortResolverCopy, this.proxySelector); } else if (systemProperties) { final ProxySelector defaultProxySelector = AccessController.doPrivileged((PrivilegedAction) ProxySelector::getDefault); routePlannerCopy = new SystemDefaultRoutePlanner(schemePortResolverCopy, defaultProxySelector); } else { routePlannerCopy = new DefaultRoutePlanner(schemePortResolverCopy); } } // Add redirect executor, if not disabled if (!redirectHandlingDisabled) { RedirectStrategy redirectStrategyCopy = this.redirectStrategy; if (redirectStrategyCopy == null) { redirectStrategyCopy = schemePortResolver != null ? new DefaultRedirectStrategy(schemePortResolver) : DefaultRedirectStrategy.INSTANCE; } execChainDefinition.addFirst( new RedirectExec(routePlannerCopy, redirectStrategyCopy), ChainElement.REDIRECT.name()); } // Optionally, add connection back-off executor if (this.backoffManager != null && this.connectionBackoffStrategy != null) { execChainDefinition.addFirst(new BackoffStrategyExec(this.connectionBackoffStrategy, this.backoffManager), ChainElement.BACK_OFF.name()); } if (execInterceptors != null) { for (final ExecInterceptorEntry entry: execInterceptors) { switch (entry.position) { case AFTER: execChainDefinition.addAfter(entry.existing, entry.interceptor, entry.name); break; case BEFORE: execChainDefinition.addBefore(entry.existing, entry.interceptor, entry.name); break; case REPLACE: execChainDefinition.replace(entry.existing, entry.interceptor); break; case FIRST: execChainDefinition.addFirst(entry.interceptor, entry.name); break; case LAST: // Don't add last, after MainClientExec, as that does not delegate to the chain // Instead, add the interceptor just before it, making it effectively the last interceptor execChainDefinition.addBefore(ChainElement.MAIN_TRANSPORT.name(), entry.interceptor, entry.name); break; } } } customizeExecChain(execChainDefinition); NamedElementChain.Node current = execChainDefinition.getLast(); ExecChainElement execChain = null; while (current != null) { execChain = new ExecChainElement(current.getValue(), execChain); current = current.getPrevious(); } Lookup authSchemeRegistryCopy = this.authSchemeRegistry; if (authSchemeRegistryCopy == null) { authSchemeRegistryCopy = RegistryBuilder.create() .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE) .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE) .register(StandardAuthScheme.BEARER, BearerSchemeFactory.INSTANCE) .build(); } Lookup cookieSpecRegistryCopy = this.cookieSpecRegistry; if (cookieSpecRegistryCopy == null) { cookieSpecRegistryCopy = CookieSpecSupport.createDefault(); } CookieStore defaultCookieStore = this.cookieStore; if (defaultCookieStore == null) { defaultCookieStore = new BasicCookieStore(); } CredentialsProvider defaultCredentialsProvider = this.credentialsProvider; if (defaultCredentialsProvider == null) { if (systemProperties) { defaultCredentialsProvider = new SystemDefaultCredentialsProvider(); } else { defaultCredentialsProvider = new BasicCredentialsProvider(); } } List closeablesCopy = closeables != null ? new ArrayList<>(closeables) : null; if (!this.connManagerShared) { if (closeablesCopy == null) { closeablesCopy = new ArrayList<>(1); } if (evictExpiredConnections || evictIdleConnections) { if (connManagerCopy instanceof ConnPoolControl) { final IdleConnectionEvictor connectionEvictor = new IdleConnectionEvictor((ConnPoolControl) connManagerCopy, maxIdleTime, maxIdleTime); closeablesCopy.add(() -> { connectionEvictor.shutdown(); try { connectionEvictor.awaitTermination(Timeout.ofSeconds(1)); } catch (final InterruptedException interrupted) { Thread.currentThread().interrupt(); } }); connectionEvictor.start(); } } closeablesCopy.add(connManagerCopy); } return new InternalHttpClient( connManagerCopy, requestExecCopy, execChain, routePlannerCopy, cookieSpecRegistryCopy, authSchemeRegistryCopy, defaultCookieStore, defaultCredentialsProvider, contextAdaptor(), defaultRequestConfig != null ? defaultRequestConfig : RequestConfig.DEFAULT, closeablesCopy); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/package-info.java0100664 0000000 0000000 00000002677 14666635064 027237 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Classic HTTP client API implementation that supports HTTP/1.1 transport * only. This implementation is mostly API compatible with HttpClient 4.5. * Please use the asynchronous client API implementation for HTTP/2 transport. */ package org.apache.hc.client5.http.impl.classic; httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ProtocolExec.java0100664 0000000 0000000 00000035146 15064215312 027275 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.util.Iterator; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.RequestSupport; import org.apache.hc.client5.http.impl.auth.AuthCacheKeeper; import org.apache.hc.client5.http.impl.auth.AuthenticationHandler; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the classic request execution chain * that is responsible for implementation of HTTP specification requirements. *

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

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class ProtocolExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(ProtocolExec.class); private final AuthenticationStrategy targetAuthStrategy; private final AuthenticationStrategy proxyAuthStrategy; private final AuthenticationHandler authenticator; private final SchemePortResolver schemePortResolver; private final AuthCacheKeeper authCacheKeeper; public ProtocolExec( final AuthenticationStrategy targetAuthStrategy, final AuthenticationStrategy proxyAuthStrategy, final SchemePortResolver schemePortResolver, final boolean authCachingDisabled) { this.targetAuthStrategy = Args.notNull(targetAuthStrategy, "Target authentication strategy"); this.proxyAuthStrategy = Args.notNull(proxyAuthStrategy, "Proxy authentication strategy"); this.authenticator = new AuthenticationHandler(); this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; this.authCacheKeeper = authCachingDisabled ? null : new AuthCacheKeeper(this.schemePortResolver); } @Override public ClassicHttpResponse execute( final ClassicHttpRequest userRequest, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(userRequest, "HTTP request"); Args.notNull(scope, "Scope"); if (Method.CONNECT.isSame(userRequest.getMethod())) { throw new ProtocolException("Direct execution of CONNECT is not allowed"); } final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final HttpClientContext context = scope.clientContext; final ExecRuntime execRuntime = scope.execRuntime; final HttpHost routeTarget = route.getTargetHost(); final HttpHost proxy = route.getProxyHost(); try { final ClassicHttpRequest request; if (proxy != null && !route.isTunnelled()) { final ClassicRequestBuilder requestBuilder = ClassicRequestBuilder.copy(userRequest); if (requestBuilder.getAuthority() == null) { requestBuilder.setAuthority(new URIAuthority(routeTarget)); } requestBuilder.setAbsoluteRequestUri(true); request = requestBuilder.build(); } else { request = userRequest; } // Ensure the request has a scheme and an authority if (request.getScheme() == null) { request.setScheme(routeTarget.getSchemeName()); } if (request.getAuthority() == null) { request.setAuthority(new URIAuthority(routeTarget)); } final URIAuthority authority = request.getAuthority(); if (authority.getUserInfo() != null) { throw new ProtocolException("Request URI authority contains deprecated userinfo component"); } final HttpHost target = new HttpHost( request.getScheme(), authority.getHostName(), schemePortResolver.resolve(request.getScheme(), authority)); final String pathPrefix = RequestSupport.extractPathPrefix(request); final AuthExchange targetAuthExchange = context.getAuthExchange(target); final AuthExchange proxyAuthExchange = proxy != null ? context.getAuthExchange(proxy) : new AuthExchange(); if (!targetAuthExchange.isConnectionBased() && targetAuthExchange.getPathPrefix() != null && !pathPrefix.startsWith(targetAuthExchange.getPathPrefix())) { // force re-authentication if the current path prefix does not match // that of the previous authentication exchange. targetAuthExchange.reset(); } if (targetAuthExchange.getPathPrefix() == null) { targetAuthExchange.setPathPrefix(pathPrefix); } if (authCacheKeeper != null) { authCacheKeeper.loadPreemptively(target, pathPrefix, targetAuthExchange, context); if (proxy != null) { authCacheKeeper.loadPreemptively(proxy, null, proxyAuthExchange, context); } } RequestEntityProxy.enhance(request); for (;;) { if (!request.containsHeader(HttpHeaders.AUTHORIZATION)) { if (LOG.isDebugEnabled()) { LOG.debug("{} target auth state: {}", exchangeId, targetAuthExchange.getState()); } authenticator.addAuthResponse(target, ChallengeType.TARGET, request, targetAuthExchange, context); } if (!request.containsHeader(HttpHeaders.PROXY_AUTHORIZATION) && !route.isTunnelled()) { if (LOG.isDebugEnabled()) { LOG.debug("{} proxy auth state: {}", exchangeId, proxyAuthExchange.getState()); } authenticator.addAuthResponse(proxy, ChallengeType.PROXY, request, proxyAuthExchange, context); } // This is where the actual network communication happens (eventually) final ClassicHttpResponse response = chain.proceed(request, scope); if (Method.TRACE.isSame(request.getMethod())) { // Do not perform authentication for TRACE request ResponseEntityProxy.enhance(response, execRuntime); return response; } final HttpEntity requestEntity = request.getEntity(); if (requestEntity != null && !requestEntity.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} Cannot retry non-repeatable request", exchangeId); } ResponseEntityProxy.enhance(response, execRuntime); return response; } if (needAuthentication( targetAuthExchange, proxyAuthExchange, proxy != null ? proxy : target, target, pathPrefix, response, context)) { // Make sure the response body is fully consumed, if present final HttpEntity responseEntity = response.getEntity(); if (execRuntime.isConnectionReusable()) { EntityUtils.consume(responseEntity); } else { execRuntime.disconnectEndpoint(); if (proxyAuthExchange.getState() == AuthExchange.State.SUCCESS && proxyAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting proxy auth state", exchangeId); } proxyAuthExchange.reset(); } if (targetAuthExchange.getState() == AuthExchange.State.SUCCESS && targetAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting target auth state", exchangeId); } targetAuthExchange.reset(); } } // Reset request headers final ClassicHttpRequest original = scope.originalRequest; request.setHeaders(); for (final Iterator
it = original.headerIterator(); it.hasNext(); ) { request.addHeader(it.next()); } } else { ResponseEntityProxy.enhance(response, execRuntime); return response; } } } catch (final HttpException ex) { execRuntime.discardEndpoint(); throw ex; } catch (final RuntimeException | IOException ex) { execRuntime.discardEndpoint(); for (final AuthExchange authExchange : context.getAuthExchanges().values()) { if (authExchange.isConnectionBased()) { authExchange.reset(); } } throw ex; } } private boolean needAuthentication( final AuthExchange targetAuthExchange, final AuthExchange proxyAuthExchange, final HttpHost proxy, final HttpHost target, final String pathPrefix, final HttpResponse response, final HttpClientContext context) throws AuthenticationException, MalformedChallengeException { final RequestConfig config = context.getRequestConfigOrDefault(); if (config.isAuthenticationEnabled()) { final boolean targetAuthRequested = authenticator.isChallenged( target, ChallengeType.TARGET, response, targetAuthExchange, context); final boolean targetMutualAuthRequired = authenticator.isChallengeExpected(targetAuthExchange); if (authCacheKeeper != null) { if (targetAuthRequested) { authCacheKeeper.updateOnChallenge(target, pathPrefix, targetAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(target, pathPrefix, targetAuthExchange, context); } } final boolean proxyAuthRequested = authenticator.isChallenged( proxy, ChallengeType.PROXY, response, proxyAuthExchange, context); final boolean proxyMutualAuthRequired = authenticator.isChallengeExpected(proxyAuthExchange); if (authCacheKeeper != null) { if (proxyAuthRequested) { authCacheKeeper.updateOnChallenge(proxy, null, proxyAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(proxy, null, proxyAuthExchange, context); } } if (targetAuthRequested || targetMutualAuthRequired) { final boolean updated = authenticator.handleResponse(target, ChallengeType.TARGET, response, targetAuthStrategy, targetAuthExchange, context); if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(target, pathPrefix, targetAuthExchange, context); } return updated; } if (proxyAuthRequested || proxyMutualAuthRequired) { final boolean updated = authenticator.handleResponse(proxy, ChallengeType.PROXY, response, proxyAuthStrategy, proxyAuthExchange, context); if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(proxy, null, proxyAuthExchange, context); } return updated; } } return false; } } ././@LongLink0100644 0000000 0000000 00000000146 14666635064 011654 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/BasicHttpClientResponseHandler.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/BasicHttpClientResponseHandler.jav0100664 0000000 0000000 00000005456 14666635064 032605 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.io.entity.EntityUtils; /** * A {@link org.apache.hc.core5.http.io.HttpClientResponseHandler} that returns * the response body as a String for successful (2xx) responses. If the response * code was >= 300, the response body is consumed * and an {@link org.apache.hc.client5.http.HttpResponseException} is thrown. *

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

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicHttpClientResponseHandler extends AbstractHttpClientResponseHandler { /** * Returns the entity as a body as a String. */ @Override public String handleEntity(final HttpEntity entity) throws IOException { try { return EntityUtils.toString(entity); } catch (final ParseException ex) { throw new ClientProtocolException(ex); } } @Override public String handleResponse(final ClassicHttpResponse response) throws IOException { return super.handleResponse(response); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/MainClientExec.java0100664 0000000 0000000 00000020671 15005672016 027517 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InterruptedIOException; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.impl.ConnectionShutdownException; import org.apache.hc.client5.http.impl.ProtocolSwitchStrategy; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Usually the last request execution handler in the classic request execution * chain that is responsible for execution of request / response exchanges with * the opposite endpoint. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class MainClientExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(MainClientExec.class); private final HttpClientConnectionManager connectionManager; private final HttpProcessor httpProcessor; private final ConnectionReuseStrategy reuseStrategy; private final ConnectionKeepAliveStrategy keepAliveStrategy; private final UserTokenHandler userTokenHandler; private final ProtocolSwitchStrategy protocolSwitchStrategy; /** * @since 4.4 */ public MainClientExec( final HttpClientConnectionManager connectionManager, final HttpProcessor httpProcessor, final ConnectionReuseStrategy reuseStrategy, final ConnectionKeepAliveStrategy keepAliveStrategy, final UserTokenHandler userTokenHandler) { this.connectionManager = Args.notNull(connectionManager, "Connection manager"); this.httpProcessor = Args.notNull(httpProcessor, "HTTP protocol processor"); this.reuseStrategy = Args.notNull(reuseStrategy, "Connection reuse strategy"); this.keepAliveStrategy = Args.notNull(keepAliveStrategy, "Connection keep alive strategy"); this.userTokenHandler = Args.notNull(userTokenHandler, "User token handler"); this.protocolSwitchStrategy = new ProtocolSwitchStrategy(); } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final HttpClientContext context = scope.clientContext; final ExecRuntime execRuntime = scope.execRuntime; if (LOG.isDebugEnabled()) { LOG.debug("{} executing {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } try { // Run request protocol interceptors context.setRoute(route); context.setRequest(request); httpProcessor.process(request, request.getEntity(), context); final ClassicHttpResponse response = execRuntime.execute( exchangeId, request, (r, connection, c) -> { if (r.getCode() == HttpStatus.SC_SWITCHING_PROTOCOLS) { final ProtocolVersion upgradeProtocol = protocolSwitchStrategy.switchProtocol(r); if (upgradeProtocol == null || !upgradeProtocol.getProtocol().equals("TLS")) { throw new ProtocolException("Failure switching protocols"); } if (LOG.isDebugEnabled()) { LOG.debug("Switching to {}", upgradeProtocol); } try { execRuntime.upgradeTls(context); } catch (final IOException ex) { throw new HttpException("Failure upgrading to TLS", ex); } LOG.debug("Successfully switched to {}", upgradeProtocol); } }, context); context.setResponse(response); httpProcessor.process(response, response.getEntity(), context); Object userToken = context.getUserToken(); if (userToken == null) { userToken = userTokenHandler.getUserToken(route, request, context); context.setUserToken(userToken); } // The connection is in or can be brought to a re-usable state. if (reuseStrategy.keepAlive(request, response, context)) { // Set the idle duration of this connection final TimeValue duration = keepAliveStrategy.getKeepAliveDuration(response, context); if (LOG.isDebugEnabled()) { final String s; if (duration != null) { s = "for " + duration; } else { s = "indefinitely"; } LOG.debug("{} connection can be kept alive {}", exchangeId, s); } execRuntime.markConnectionReusable(userToken, duration); } else { execRuntime.markConnectionNonReusable(); } // check for entity, release connection if possible final HttpEntity entity = response.getEntity(); if (entity == null || !entity.isStreaming()) { // connection not needed and (assumed to be) in re-usable state execRuntime.releaseEndpoint(); return new CloseableHttpResponse(response); } return new CloseableHttpResponse(response, execRuntime); } catch (final ConnectionShutdownException ex) { final InterruptedIOException ioex = new InterruptedIOException( "Connection has been shut down"); ioex.initCause(ex); execRuntime.discardEndpoint(); throw ioex; } catch (final HttpException | RuntimeException | IOException ex) { execRuntime.discardEndpoint(); throw ex; } catch (final Error error) { connectionManager.close(CloseMode.IMMEDIATE); throw error; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpRequestTaskCallable.java0100664 0000000 0000000 00000010425 14666635064 031434 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.util.concurrent.Callable; import java.util.concurrent.CancellationException; import java.util.concurrent.atomic.AtomicBoolean; import org.apache.hc.client5.http.classic.HttpClient; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.protocol.HttpContext; class HttpRequestTaskCallable implements Callable { private final ClassicHttpRequest request; private final HttpClient httpclient; private final AtomicBoolean cancelled = new AtomicBoolean(false); private final long scheduled = System.currentTimeMillis(); private long started = -1; private long ended = -1; private final HttpContext context; private final HttpClientResponseHandler responseHandler; private final FutureCallback callback; private final FutureRequestExecutionMetrics metrics; HttpRequestTaskCallable( final HttpClient httpClient, final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler responseHandler, final FutureCallback callback, final FutureRequestExecutionMetrics metrics) { this.httpclient = httpClient; this.responseHandler = responseHandler; this.request = request; this.context = context; this.callback = callback; this.metrics = metrics; } public long getScheduled() { return scheduled; } public long getStarted() { return started; } public long getEnded() { return ended; } @Override public V call() throws Exception { if (!cancelled.get()) { try { metrics.getActiveConnections().incrementAndGet(); started = System.currentTimeMillis(); try { metrics.getScheduledConnections().decrementAndGet(); final V result = httpclient.execute(request, context, responseHandler); ended = System.currentTimeMillis(); metrics.getSuccessfulConnections().increment(started); if (callback != null) { callback.completed(result); } return result; } catch (final Exception e) { metrics.getFailedConnections().increment(started); ended = System.currentTimeMillis(); if (callback != null) { callback.failed(e); } throw e; } } finally { metrics.getRequests().increment(started); metrics.getTasks().increment(started); metrics.getActiveConnections().decrementAndGet(); } } throw new CancellationException(); } public void cancel() { cancelled.set(true); if (callback != null) { callback.cancelled(); } } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/InternalExecRuntime.java0100664 0000000 0000000 00000027402 15005672016 030613 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.io.ConnectionEndpoint; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.io.LeaseRequest; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionRequestTimeoutException; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpResponseInformationCallback; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; class InternalExecRuntime implements ExecRuntime, Cancellable { private final Logger log; private final HttpClientConnectionManager manager; private final HttpRequestExecutor requestExecutor; private final CancellableDependency cancellableDependency; private final AtomicReference endpointRef; private volatile boolean reusable; private volatile Object state; private volatile TimeValue validDuration; InternalExecRuntime( final Logger log, final HttpClientConnectionManager manager, final HttpRequestExecutor requestExecutor, final CancellableDependency cancellableDependency) { super(); this.log = log; this.manager = manager; this.requestExecutor = requestExecutor; this.cancellableDependency = cancellableDependency; this.endpointRef = new AtomicReference<>(); this.validDuration = TimeValue.NEG_ONE_MILLISECOND; } @Override public boolean isExecutionAborted() { return cancellableDependency != null && cancellableDependency.isCancelled(); } @Override public boolean isEndpointAcquired() { return endpointRef.get() != null; } @Override public void acquireEndpoint( final String id, final HttpRoute route, final Object object, final HttpClientContext context) throws IOException { Args.notNull(route, "Route"); if (endpointRef.get() == null) { final RequestConfig requestConfig = context.getRequestConfigOrDefault(); final Timeout connectionRequestTimeout = requestConfig.getConnectionRequestTimeout(); if (log.isDebugEnabled()) { log.debug("{} acquiring endpoint ({})", id, connectionRequestTimeout); } final LeaseRequest connRequest = manager.lease(id, route, connectionRequestTimeout, object); state = object; if (cancellableDependency != null) { cancellableDependency.setDependency(connRequest); } try { final ConnectionEndpoint connectionEndpoint = connRequest.get(connectionRequestTimeout); endpointRef.set(connectionEndpoint); reusable = connectionEndpoint.isConnected(); if (cancellableDependency != null) { cancellableDependency.setDependency(this); } if (log.isDebugEnabled()) { log.debug("{} acquired endpoint {}", id, ConnPoolSupport.getId(connectionEndpoint)); } } catch (final TimeoutException ex) { connRequest.cancel(); throw new ConnectionRequestTimeoutException(ex.getMessage()); } catch (final InterruptedException interrupted) { connRequest.cancel(); Thread.currentThread().interrupt(); throw new RequestFailedException("Request aborted", interrupted); } catch (final ExecutionException ex) { connRequest.cancel(); Throwable cause = ex.getCause(); if (cause == null) { cause = ex; } throw new RequestFailedException("Request execution failed", cause); } } else { throw new IllegalStateException("Endpoint already acquired"); } } ConnectionEndpoint ensureValid() { final ConnectionEndpoint endpoint = endpointRef.get(); if (endpoint == null) { throw new IllegalStateException("Endpoint not acquired / already released"); } return endpoint; } @Override public boolean isEndpointConnected() { final ConnectionEndpoint endpoint = endpointRef.get(); return endpoint != null && endpoint.isConnected(); } private void connectEndpoint(final ConnectionEndpoint endpoint, final HttpClientContext context) throws IOException { if (isExecutionAborted()) { throw new RequestFailedException("Request aborted"); } final RequestConfig requestConfig = context.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); if (log.isDebugEnabled()) { log.debug("{} connecting endpoint ({})", ConnPoolSupport.getId(endpoint), connectTimeout); } manager.connect(endpoint, connectTimeout, context); if (log.isDebugEnabled()) { log.debug("{} endpoint connected", ConnPoolSupport.getId(endpoint)); } } @Override public void connectEndpoint(final HttpClientContext context) throws IOException { final ConnectionEndpoint endpoint = ensureValid(); if (!endpoint.isConnected()) { connectEndpoint(endpoint, context); } } @Override public void disconnectEndpoint() throws IOException { final ConnectionEndpoint endpoint = endpointRef.get(); if (endpoint != null) { endpoint.close(); if (log.isDebugEnabled()) { log.debug("{} endpoint closed", ConnPoolSupport.getId(endpoint)); } } } @Override public void upgradeTls(final HttpClientContext context) throws IOException { final ConnectionEndpoint endpoint = ensureValid(); if (log.isDebugEnabled()) { log.debug("{} upgrading endpoint", ConnPoolSupport.getId(endpoint)); } manager.upgrade(endpoint, context); } @Override public EndpointInfo getEndpointInfo() { final ConnectionEndpoint endpoint = endpointRef.get(); return endpoint != null ? endpoint.getInfo() : null; } @Override public ClassicHttpResponse execute( final String id, final ClassicHttpRequest request, final HttpClientContext context) throws IOException, HttpException { return execute(id, request, null, context); } @Override public ClassicHttpResponse execute( final String id, final ClassicHttpRequest request, final HttpResponseInformationCallback informationCallback, final HttpClientContext context) throws IOException, HttpException { final ConnectionEndpoint endpoint = ensureValid(); if (!endpoint.isConnected()) { connectEndpoint(endpoint, context); } if (isExecutionAborted()) { throw new RequestFailedException("Request aborted"); } final RequestConfig requestConfig = context.getRequestConfigOrDefault(); final Timeout responseTimeout = requestConfig.getResponseTimeout(); if (responseTimeout != null) { endpoint.setSocketTimeout(responseTimeout); } if (log.isDebugEnabled()) { log.debug("{} start execution {}", ConnPoolSupport.getId(endpoint), id); } return endpoint.execute( id, request, (r, conn, c) -> requestExecutor.execute(r, conn, informationCallback, c), context); } @Override public boolean isConnectionReusable() { return reusable; } @Override public void markConnectionReusable(final Object state, final TimeValue validDuration) { this.reusable = true; this.state = state; this.validDuration = validDuration; } @Override public void markConnectionNonReusable() { reusable = false; } private void discardEndpoint(final ConnectionEndpoint endpoint) { try { endpoint.close(CloseMode.IMMEDIATE); if (log.isDebugEnabled()) { log.debug("{} endpoint closed", ConnPoolSupport.getId(endpoint)); } } finally { if (log.isDebugEnabled()) { log.debug("{} discarding endpoint", ConnPoolSupport.getId(endpoint)); } manager.release(endpoint, null, TimeValue.ZERO_MILLISECONDS); } } @Override public void releaseEndpoint() { final ConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { if (reusable) { if (log.isDebugEnabled()) { log.debug("{} releasing valid endpoint", ConnPoolSupport.getId(endpoint)); } manager.release(endpoint, state, validDuration); } else { discardEndpoint(endpoint); } } } @Override public void discardEndpoint() { final ConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { discardEndpoint(endpoint); } } @Override public boolean cancel() { final boolean alreadyReleased = endpointRef.get() == null; final ConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { if (log.isDebugEnabled()) { log.debug("{} cancel", ConnPoolSupport.getId(endpoint)); } discardEndpoint(endpoint); } return !alreadyReleased; } @Override public ExecRuntime fork(final CancellableDependency cancellableDependency) { return new InternalExecRuntime(log, manager, requestExecutor, cancellableDependency); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/Clock.java0100664 0000000 0000000 00000002617 14666635064 025740 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; interface Clock { /** * Returns the current time, expressed as the number of * milliseconds since the epoch. * @return current time */ long getCurrentTime(); } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/CloseableDelegate.java0100664 0000000 0000000 00000003017 15005672016 030206 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.Closeable; import java.io.IOException; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.io.CloseMode; /** * @since 5.5 */ @Internal @FunctionalInterface public interface CloseableDelegate { void close(Closeable closeable, CloseMode closeMode) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/CloseableHttpResponse.java0100664 0000000 0000000 00000016032 15005672016 031133 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.util.Iterator; import java.util.Locale; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.util.Args; /** * Provided for backward compatibility with HttpClient 4.x. * * @since 4.3 */ public final class CloseableHttpResponse implements ClassicHttpResponse, ModalCloseable { private final ClassicHttpResponse response; private final CloseableDelegate closeableDelegate; /** * @since 5.4 */ @Internal public static CloseableHttpResponse adapt(final ClassicHttpResponse response) { if (response == null) { return null; } return response instanceof CloseableHttpResponse ? (CloseableHttpResponse) response : new CloseableHttpResponse(response); } /** * @since 5.5 */ @Internal public static CloseableHttpResponse create(final ClassicHttpResponse response, final CloseableDelegate closeableDelegate) { if (response == null) { return null; } return new CloseableHttpResponse(response, closeableDelegate); } CloseableHttpResponse(final ClassicHttpResponse response) { this.response = Args.notNull(response, "Response"); this.closeableDelegate = null; } CloseableHttpResponse(final ClassicHttpResponse response, final CloseableDelegate closeableDelegate) { this.response = Args.notNull(response, "Response"); this.closeableDelegate = closeableDelegate; } CloseableHttpResponse(final ClassicHttpResponse response, final ExecRuntime execRuntime) { this.response = Args.notNull(response, "Response"); this.closeableDelegate = (closeable, closeMode) -> { try { if (closeMode == CloseMode.GRACEFUL) { response.close(); } execRuntime.disconnectEndpoint(); } finally { execRuntime.discardEndpoint(); } }; } @Override public int getCode() { return response.getCode(); } @Override public HttpEntity getEntity() { return response.getEntity(); } @Override public boolean containsHeader(final String name) { return response.containsHeader(name); } @Override public void setVersion(final ProtocolVersion version) { response.setVersion(version); } @Override public void setCode(final int code) { response.setCode(code); } @Override public String getReasonPhrase() { return response.getReasonPhrase(); } @Override public int countHeaders(final String name) { return response.countHeaders(name); } @Override public void setEntity(final HttpEntity entity) { response.setEntity(entity); } @Override public ProtocolVersion getVersion() { return response.getVersion(); } @Override public void setReasonPhrase(final String reason) { response.setReasonPhrase(reason); } @Override public Header[] getHeaders(final String name) { return response.getHeaders(name); } @Override public void addHeader(final Header header) { response.addHeader(header); } @Override public Locale getLocale() { return response.getLocale(); } @Override public void addHeader(final String name, final Object value) { response.addHeader(name, value); } @Override public void setLocale(final Locale loc) { response.setLocale(loc); } @Override public Header getHeader(final String name) throws ProtocolException { return response.getHeader(name); } @Override public void setHeader(final Header header) { response.setHeader(header); } @Override public Header getFirstHeader(final String name) { return response.getFirstHeader(name); } @Override public void setHeader(final String name, final Object value) { response.setHeader(name, value); } @Override public void setHeaders(final Header... headers) { response.setHeaders(headers); } @Override public boolean removeHeader(final Header header) { return response.removeHeader(header); } @Override public boolean removeHeaders(final String name) { return response.removeHeaders(name); } @Override public Header getLastHeader(final String name) { return response.getLastHeader(name); } @Override public Header[] getHeaders() { return response.getHeaders(); } @Override public Iterator
headerIterator() { return response.headerIterator(); } @Override public Iterator
headerIterator(final String name) { return response.headerIterator(name); } private void doClose(final CloseMode closeMode) throws IOException { if (closeableDelegate != null) { closeableDelegate.close(response, closeMode); } else { response.close(); } } @Override public void close(final CloseMode closeMode) { try { doClose(closeMode); } catch (final IOException ignore) { } } @Override public void close() throws IOException { doClose(CloseMode.GRACEFUL); } @Override public String toString() { return response.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ExecChainElement.java0100664 0000000 0000000 00000004336 14666635064 030046 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; class ExecChainElement { private final ExecChainHandler handler; private final ExecChainElement next; ExecChainElement(final ExecChainHandler handler, final ExecChainElement next) { this.handler = handler; this.next = next; } public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope) throws IOException, HttpException { return handler.execute(request, scope, next != null ? next::execute : null); } @Override public String toString() { return "{" + "handler=" + handler.getClass() + ", next=" + (next != null ? next.handler.getClass() : "null") + '}'; } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/AIMDBackoffManager.java0100664 0000000 0000000 00000007766 14704162040 030156 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.Args; /** *

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

* *

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

* *

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

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

* This constructor is primarily used for testing purposes, allowing the * injection of a custom {@link Clock} implementation. * * @param connPerRoute the {@link ConnPoolControl} that manages * per-host routing maximums */ public AIMDBackoffManager(final ConnPoolControl connPerRoute) { super(connPerRoute); } /** * Returns the backed-off pool size based on the current pool size. * The new pool size is calculated as the floor of (backoffFactor * curr). * * @param curr the current pool size * @return the backed-off pool size, with a minimum value of 1 */ @Override protected int getBackedOffPoolSize(final int curr) { if (curr <= 1) { return 1; } return (int) (Math.floor(getBackoffFactor().get() * curr)); } /** * Sets the factor to use when backing off; the new * per-host limit will be roughly the current max times * this factor. {@code Math.floor} is applied in the * case of non-integer outcomes to ensure we actually * decrease the pool size. Pool sizes are never decreased * below 1, however. Defaults to 0.5. * @param d must be between 0.0 and 1.0, exclusive. */ @Override public void setBackoffFactor(final double d) { Args.check(d > 0.0 && d < 1.0, "Backoff factor must be 0.0 < f < 1.0"); getBackoffFactor().set(d); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ConnectExec.java0100664 0000000 0000000 00000035334 15041375016 027067 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteTracker; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.auth.AuthCacheKeeper; import org.apache.hc.client5.http.impl.auth.AuthenticationHandler; import org.apache.hc.client5.http.impl.routing.BasicRouteDirector; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRouteDirector; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the classic request execution chain * that is responsible for establishing connection to the target * origin server as specified by the current connection route. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class ConnectExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(ConnectExec.class); private final ConnectionReuseStrategy reuseStrategy; private final HttpProcessor proxyHttpProcessor; private final AuthenticationStrategy proxyAuthStrategy; private final AuthenticationHandler authenticator; private final AuthCacheKeeper authCacheKeeper; private final HttpRouteDirector routeDirector; public ConnectExec( final ConnectionReuseStrategy reuseStrategy, final HttpProcessor proxyHttpProcessor, final AuthenticationStrategy proxyAuthStrategy, final SchemePortResolver schemePortResolver, final boolean authCachingDisabled) { Args.notNull(reuseStrategy, "Connection reuse strategy"); Args.notNull(proxyHttpProcessor, "Proxy HTTP processor"); Args.notNull(proxyAuthStrategy, "Proxy authentication strategy"); this.reuseStrategy = reuseStrategy; this.proxyHttpProcessor = proxyHttpProcessor; this.proxyAuthStrategy = proxyAuthStrategy; this.authenticator = new AuthenticationHandler(); this.authCacheKeeper = authCachingDisabled ? null : new AuthCacheKeeper(schemePortResolver); this.routeDirector = BasicRouteDirector.INSTANCE; } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final HttpClientContext context = scope.clientContext; final ExecRuntime execRuntime = scope.execRuntime; if (!execRuntime.isEndpointAcquired()) { final Object userToken = context.getUserToken(); if (LOG.isDebugEnabled()) { LOG.debug("{} acquiring connection with route {}", exchangeId, route); } execRuntime.acquireEndpoint(exchangeId, route, userToken, context); } try { if (!execRuntime.isEndpointConnected()) { if (LOG.isDebugEnabled()) { LOG.debug("{} opening connection {}", exchangeId, route); } final RouteTracker tracker = new RouteTracker(route); int step; do { final HttpRoute fact = tracker.toRoute(); step = this.routeDirector.nextStep(route, fact); switch (step) { case HttpRouteDirector.CONNECT_TARGET: execRuntime.connectEndpoint(context); tracker.connectTarget(route.isSecure()); break; case HttpRouteDirector.CONNECT_PROXY: execRuntime.connectEndpoint(context); final HttpHost proxy = route.getProxyHost(); tracker.connectProxy(proxy, route.isSecure() && !route.isTunnelled()); break; case HttpRouteDirector.TUNNEL_TARGET: { final ClassicHttpResponse finalResponse = createTunnelToTarget( exchangeId, route, request, execRuntime, context); if (finalResponse != null) { return finalResponse; } if (LOG.isDebugEnabled()) { LOG.debug("{} tunnel to target created.", exchangeId); } tracker.tunnelTarget(false); } break; case HttpRouteDirector.TUNNEL_PROXY: { // The most simple example for this case is a proxy chain // of two proxies, where P1 must be tunnelled to P2. // route: Source -> P1 -> P2 -> Target (3 hops) // fact: Source -> P1 -> Target (2 hops) final int hop = fact.getHopCount() - 1; // the hop to establish final boolean secure = createTunnelToProxy(route, hop, context); if (LOG.isDebugEnabled()) { LOG.debug("{} tunnel to proxy created.", exchangeId); } tracker.tunnelProxy(route.getHopTarget(hop), secure); } break; case HttpRouteDirector.LAYER_PROTOCOL: execRuntime.upgradeTls(context); tracker.layerProtocol(route.isSecure()); break; case HttpRouteDirector.UNREACHABLE: throw new HttpException("Unable to establish route: " + "planned = " + route + "; current = " + fact); case HttpRouteDirector.COMPLETE: break; default: throw new IllegalStateException("Unknown step indicator " + step + " from RouteDirector."); } } while (step > HttpRouteDirector.COMPLETE); } final EndpointInfo endpointInfo = execRuntime.getEndpointInfo(); if (endpointInfo != null) { context.setSSLSession(endpointInfo.getSslSession()); } return chain.proceed(request, scope); } catch (final IOException | HttpException | RuntimeException ex) { execRuntime.discardEndpoint(); throw ex; } } /** * Creates a tunnel to the target server. * The connection must be established to the (last) proxy. * A CONNECT request for tunnelling through the proxy will * be created and sent, the response received and checked. * This method does not processChallenge the connection with * information about the tunnel, that is left to the caller. */ private ClassicHttpResponse createTunnelToTarget( final String exchangeId, final HttpRoute route, final HttpRequest request, final ExecRuntime execRuntime, final HttpClientContext context) throws HttpException, IOException { final RequestConfig config = context.getRequestConfigOrDefault(); final HttpHost target = route.getTargetHost(); final HttpHost proxy = route.getProxyHost(); final AuthExchange proxyAuthExchange = context.getAuthExchange(proxy); if (authCacheKeeper != null) { authCacheKeeper.loadPreemptively(proxy, null, proxyAuthExchange, context); } ClassicHttpResponse response = null; final String authority = target.toHostString(); final ClassicHttpRequest connect = new BasicClassicHttpRequest(Method.CONNECT, target, authority); connect.setVersion(HttpVersion.HTTP_1_1); this.proxyHttpProcessor.process(connect, null, context); while (response == null) { connect.removeHeaders(HttpHeaders.PROXY_AUTHORIZATION); this.authenticator.addAuthResponse(proxy, ChallengeType.PROXY, connect, proxyAuthExchange, context); response = execRuntime.execute(exchangeId, connect, context); this.proxyHttpProcessor.process(response, response.getEntity(), context); final int status = response.getCode(); if (status < HttpStatus.SC_SUCCESS) { throw new HttpException("Unexpected response to CONNECT request: " + new StatusLine(response)); } if (config.isAuthenticationEnabled()) { final boolean proxyAuthRequested = authenticator.isChallenged(proxy, ChallengeType.PROXY, response, proxyAuthExchange, context); final boolean proxyMutualAuthRequired = authenticator.isChallengeExpected(proxyAuthExchange); if (authCacheKeeper != null) { if (proxyAuthRequested) { authCacheKeeper.updateOnChallenge(proxy, null, proxyAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(proxy, null, proxyAuthExchange, context); } } if (proxyAuthRequested || proxyMutualAuthRequired) { final boolean updated = authenticator.handleResponse(proxy, ChallengeType.PROXY, response, proxyAuthStrategy, proxyAuthExchange, context); if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(proxy, null, proxyAuthExchange, context); } if (updated) { // Retry request if (this.reuseStrategy.keepAlive(connect, response, context)) { if (LOG.isDebugEnabled()) { LOG.debug("{} connection kept alive", exchangeId); } // Consume response content final HttpEntity entity = response.getEntity(); EntityUtils.consume(entity); } else { execRuntime.disconnectEndpoint(); } response = null; } } } } final int status = response.getCode(); if (status == HttpStatus.SC_OK) { context.setProtocolVersion(null); } else { final HttpEntity entity = response.getEntity(); if (entity != null) { response.setEntity(new ByteArrayEntity( EntityUtils.toByteArray(entity, 4096), ContentType.parseLenient(entity.getContentType()))); execRuntime.discardEndpoint(); } return response; } return null; } /** * Creates a tunnel to an intermediate proxy. * This method is not implemented in this class. * It just throws an exception here. */ private boolean createTunnelToProxy( final HttpRoute route, final int hop, final HttpClientContext context) throws HttpException { // Have a look at createTunnelToTarget and replicate the parts // you need in a custom derived class. If your proxies don't require // authentication, it is not too hard. But for the stock version of // HttpClient, we cannot make such simplifying assumptions and would // have to include proxy authentication code. The HttpComponents team // is currently not in a position to support rarely used code of this // complexity. Feel free to submit patches that refactor the code in // createTunnelToTarget to facilitate re-use for proxy tunnelling. throw new HttpException("Proxy chains are not supported."); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ResponseEntityProxy.java0100664 0000000 0000000 00000016413 15005672016 030723 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.net.SocketException; import java.util.Arrays; import java.util.List; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.impl.io.ChunkedInputStream; import org.apache.hc.core5.http.io.EofSensorInputStream; import org.apache.hc.core5.http.io.EofSensorWatcher; import org.apache.hc.core5.http.io.entity.HttpEntityWrapper; class ResponseEntityProxy extends HttpEntityWrapper implements EofSensorWatcher { private final ExecRuntime execRuntime; public static void enhance(final ClassicHttpResponse response, final ExecRuntime execRuntime) { final HttpEntity entity = response.getEntity(); if (entity != null && entity.isStreaming() && execRuntime != null) { response.setEntity(new ResponseEntityProxy(entity, execRuntime)); } } ResponseEntityProxy(final HttpEntity entity, final ExecRuntime execRuntime) { super(entity); this.execRuntime = execRuntime; } private void cleanup() throws IOException { if (this.execRuntime != null) { if (this.execRuntime.isEndpointConnected()) { this.execRuntime.disconnectEndpoint(); } this.execRuntime.discardEndpoint(); } } private void discardConnection() { if (this.execRuntime != null) { this.execRuntime.discardEndpoint(); } } public void releaseConnection() { if (this.execRuntime != null) { this.execRuntime.releaseEndpoint(); } } @Override public boolean isRepeatable() { return false; } @Override public InputStream getContent() throws IOException { return new EofSensorInputStream(super.getContent(), this); } @Override public void writeTo(final OutputStream outStream) throws IOException { try { super.writeTo(outStream != null ? outStream : NullOutputStream.INSTANCE); releaseConnection(); } catch (final IOException | RuntimeException ex) { discardConnection(); throw ex; } finally { cleanup(); } } @Override public boolean eofDetected(final InputStream wrapped) throws IOException { try { // there may be some cleanup required, such as // reading trailers after the response body: if (wrapped != null) { wrapped.close(); } releaseConnection(); } catch (final IOException | RuntimeException ex) { discardConnection(); throw ex; } finally { cleanup(); } return false; } @Override public boolean streamClosed(final InputStream wrapped) throws IOException { try { final boolean open = execRuntime != null && execRuntime.isEndpointAcquired(); // this assumes that closing the stream will // consume the remainder of the response body: try { if (wrapped != null) { wrapped.close(); } releaseConnection(); } catch (final SocketException ex) { if (open) { throw ex; } } } catch (final IOException | RuntimeException ex) { discardConnection(); throw ex; } finally { cleanup(); } return false; } @Override public boolean streamAbort(final InputStream wrapped) throws IOException { cleanup(); return false; } @Override public Supplier> getTrailers() { try { final InputStream underlyingStream = super.getContent(); return () -> { final Header[] footers; if (underlyingStream instanceof ChunkedInputStream) { final ChunkedInputStream chunkedInputStream = (ChunkedInputStream) underlyingStream; footers = chunkedInputStream.getFooters(); } else { footers = new Header[0]; } return Arrays.asList(footers); }; } catch (final IOException e) { throw new IllegalStateException("Unable to retrieve input stream", e); } } @Override public void close() throws IOException { try { // HttpEntity.close will close the underlying resource. Closing a reusable request stream results in // draining remaining data, allowing for connection reuse. super.close(); releaseConnection(); } catch (final IOException | RuntimeException ex) { discardConnection(); throw ex; } finally { cleanup(); } } private static final class NullOutputStream extends OutputStream { private static final NullOutputStream INSTANCE = new NullOutputStream(); private NullOutputStream() { } @Override public void write(@SuppressWarnings("unused") final int byteValue) { // no-op } @Override public void write(@SuppressWarnings("unused") final byte[] buffer) { // no-op } @Override public void write( @SuppressWarnings("unused") final byte[] buffer, @SuppressWarnings("unused") final int off, @SuppressWarnings("unused") final int len) { // no-op } @Override public void flush() { // no-op } @Override public void close() { // no-op } @Override public String toString() { return "NullOutputStream{}"; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpClients.java0100664 0000000 0000000 00000005371 14666635064 027146 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.http.io.HttpClientConnectionManager; /** * Factory methods for {@link CloseableHttpClient} instances. * * @since 4.3 */ public final class HttpClients { private HttpClients() { super(); } /** * Creates builder object for construction of custom * {@link CloseableHttpClient} instances. */ public static HttpClientBuilder custom() { return HttpClientBuilder.create(); } /** * Creates {@link CloseableHttpClient} instance with default * configuration. */ public static CloseableHttpClient createDefault() { return HttpClientBuilder.create().build(); } /** * Creates {@link CloseableHttpClient} instance with default * configuration based on system properties. */ public static CloseableHttpClient createSystem() { return HttpClientBuilder.create().useSystemProperties().build(); } /** * Creates {@link CloseableHttpClient} instance that implements * the most basic HTTP protocol support. */ public static MinimalHttpClient createMinimal() { return new MinimalHttpClient(new PoolingHttpClientConnectionManager()); } /** * Creates {@link CloseableHttpClient} instance that implements * the most basic HTTP protocol support. */ public static MinimalHttpClient createMinimal(final HttpClientConnectionManager connManager) { return new MinimalHttpClient(connManager); } } ././@LongLink0100644 0000000 0000000 00000000151 14704162040 011626 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/AbstractHttpClientResponseHandler.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/AbstractHttpClientResponseHandler.0100664 0000000 0000000 00000006416 14704162040 032601 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.HttpResponseException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.io.entity.EntityUtils; /** * A generic {@link HttpClientResponseHandler} that works with the response entity * for successful (2xx) responses. If the response code was >= 300, the response * body is consumed and an {@link HttpResponseException} is thrown. *

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

* * @param the type of the value determined by the response. * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public abstract class AbstractHttpClientResponseHandler implements HttpClientResponseHandler { /** * Read the entity from the response body and pass it to the entity handler * method if the response was successful (a 2xx status code). If no response * body exists, this returns null. If the response was unsuccessful (>= 300 * status code), throws an {@link HttpResponseException}. */ @Override public T handleResponse(final ClassicHttpResponse response) throws IOException { final HttpEntity entity = response.getEntity(); if (response.getCode() >= HttpStatus.SC_REDIRECTION) { EntityUtils.consume(entity); throw new HttpResponseException(response.getCode(), response.getReasonPhrase()); } return entity == null ? null : handleEntity(entity); } /** * Handle the response entity and transform it into the actual response * object. */ public abstract T handleEntity(HttpEntity entity) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/RequestAbortedException.java0100664 0000000 0000000 00000003343 14666635064 031512 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.InterruptedIOException; /** * Signals that the request has been aborted. * * @since 4.3 */ public class RequestAbortedException extends InterruptedIOException { private static final long serialVersionUID = 4973849966012490112L; public RequestAbortedException(final String message) { super(message); } public RequestAbortedException(final String message, final Throwable cause) { super(message); if (cause != null) { initCause(cause); } } } ././@LongLink0100644 0000000 0000000 00000000145 15005672016 011635 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/FutureRequestExecutionService.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/FutureRequestExecutionService.java0100664 0000000 0000000 00000013127 15005672016 032715 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.Closeable; import java.io.IOException; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.FutureTask; import java.util.concurrent.atomic.AtomicBoolean; import org.apache.hc.client5.http.classic.HttpClient; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.protocol.HttpContext; /** * This class schedules message execution execution and processing * as {@link FutureTask}s with the provided {@link ExecutorService}. */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public class FutureRequestExecutionService implements Closeable { private final HttpClient httpclient; private final ExecutorService executorService; private final FutureRequestExecutionMetrics metrics = new FutureRequestExecutionMetrics(); private final AtomicBoolean closed = new AtomicBoolean(false); /** * Create a new FutureRequestExecutionService. * * @param httpClient * you should tune your httpclient instance to match your needs. You should * align the max number of connections in the pool and the number of threads * in the executor; it doesn't make sense to have more threads than connections * and if you have less connections than threads, the threads will just end up * blocking on getting a connection from the pool. * @param executorService * any executorService will do here. E.g. * {@link Executors#newFixedThreadPool(int)} */ public FutureRequestExecutionService( final HttpClient httpClient, final ExecutorService executorService) { this.httpclient = httpClient; this.executorService = executorService; } /** * Schedule a request for execution. * * @param * * @param request * request to execute * @param HttpClientResponseHandler * handler that will process the response. * @return HttpAsyncClientFutureTask for the scheduled request. */ public FutureTask execute( final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler HttpClientResponseHandler) { return execute(request, context, HttpClientResponseHandler, null); } /** * Schedule a request for execution. * * @param * * @param request * request to execute * @param context * optional context; use null if not needed. * @param HttpClientResponseHandler * handler that will process the response. * @param callback * callback handler that will be called when the request is scheduled, * started, completed, failed, or cancelled. * @return HttpAsyncClientFutureTask for the scheduled request. */ public FutureTask execute( final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler HttpClientResponseHandler, final FutureCallback callback) { if (closed.get()) { throw new IllegalStateException("Close has been called on this httpclient instance."); } metrics.getScheduledConnections().incrementAndGet(); final HttpRequestTaskCallable callable = new HttpRequestTaskCallable<>( httpclient, request, context, HttpClientResponseHandler, callback, metrics); final HttpRequestFutureTask httpRequestFutureTask = new HttpRequestFutureTask<>( request, callable); executorService.execute(httpRequestFutureTask); return httpRequestFutureTask; } /** * @return metrics gathered for this instance. * @see FutureRequestExecutionMetrics */ public FutureRequestExecutionMetrics metrics() { return metrics; } @Override public void close() throws IOException { closed.set(true); executorService.shutdownNow(); if (httpclient instanceof Closeable) { ((Closeable) httpclient).close(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/SystemClock.java0100664 0000000 0000000 00000002535 14666635064 027144 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; class SystemClock implements Clock { @Override public long getCurrentTime() { return System.currentTimeMillis(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ContentCompressionExec.java0100664 0000000 0000000 00000017312 15063503632 031327 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.util.ArrayList; import java.util.List; import java.util.Locale; import java.util.zip.GZIPInputStream; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.entity.BrotliDecompressingEntity; import org.apache.hc.client5.http.entity.BrotliInputStreamFactory; import org.apache.hc.client5.http.entity.DecompressingEntity; import org.apache.hc.client5.http.entity.DeflateInputStream; import org.apache.hc.client5.http.entity.DeflateInputStreamFactory; import org.apache.hc.client5.http.entity.GZIPInputStreamFactory; import org.apache.hc.client5.http.entity.InputStreamFactory; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.message.BasicHeaderValueParser; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.util.Args; import org.brotli.dec.BrotliInputStream; /** * Request execution handler in the classic request execution chain * that is responsible for automatic response content decompression. *

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

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class ContentCompressionExec implements ExecChainHandler { private final Header acceptEncoding; private final Lookup decoderRegistry; private final boolean ignoreUnknown; public ContentCompressionExec( final List acceptEncoding, final Lookup decoderRegistry, final boolean ignoreUnknown) { final boolean brotliSupported = decoderRegistry == null && BrotliDecompressingEntity.isAvailable(); if (acceptEncoding != null) { this.acceptEncoding = MessageSupport.headerOfTokens(HttpHeaders.ACCEPT_ENCODING, acceptEncoding); } else { final List encodings = new ArrayList<>(4); encodings.add("gzip"); encodings.add("x-gzip"); encodings.add("deflate"); if (brotliSupported) { encodings.add("br"); } this.acceptEncoding = MessageSupport.headerOfTokens(HttpHeaders.ACCEPT_ENCODING, encodings); } if (decoderRegistry != null) { this.decoderRegistry = decoderRegistry; } else { final RegistryBuilder builder = RegistryBuilder.create() .register("gzip", GZIPInputStreamFactory.getInstance()) .register("x-gzip", GZIPInputStreamFactory.getInstance()) .register("deflate", DeflateInputStreamFactory.getInstance()); if (brotliSupported) { builder.register("br", BrotliInputStreamFactory.getInstance()); } this.decoderRegistry = builder.build(); } this.ignoreUnknown = ignoreUnknown; } public ContentCompressionExec(final boolean ignoreUnknown) { this(null, null, ignoreUnknown); } /** * Handles {@code gzip} and {@code deflate} compressed entities by using the following * decoders: *
    *
  • gzip - see {@link GZIPInputStream}
    • *
  • deflate - see {@link DeflateInputStream}
    • *
  • brotli - see {@link BrotliInputStream}
    • *
*/ public ContentCompressionExec() { this(null, null, true); } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final HttpClientContext clientContext = scope.clientContext; final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault(); /* Signal support for Accept-Encoding transfer encodings. */ if (!request.containsHeader(HttpHeaders.ACCEPT_ENCODING) && requestConfig.isContentCompressionEnabled()) { request.addHeader(acceptEncoding); } final ClassicHttpResponse response = chain.proceed(request, scope); final HttpEntity entity = response.getEntity(); // entity can be null in case of 304 Not Modified, 204 No Content or similar // check for zero length entity. if (requestConfig.isContentCompressionEnabled() && entity != null && entity.getContentLength() != 0) { final String contentEncoding = entity.getContentEncoding(); if (contentEncoding != null) { final ParserCursor cursor = new ParserCursor(0, contentEncoding.length()); final HeaderElement[] codecs = BasicHeaderValueParser.INSTANCE.parseElements(contentEncoding, cursor); for (final HeaderElement codec : codecs) { final String codecname = codec.getName().toLowerCase(Locale.ROOT); final InputStreamFactory decoderFactory = decoderRegistry.lookup(codecname); if (decoderFactory != null) { response.setEntity(new DecompressingEntity(response.getEntity(), decoderFactory)); response.removeHeaders(HttpHeaders.CONTENT_LENGTH); response.removeHeaders(HttpHeaders.CONTENT_ENCODING); response.removeHeaders(HttpHeaders.CONTENT_MD5); } else { if (!"identity".equals(codecname) && !ignoreUnknown) { throw new HttpException("Unsupported Content-Encoding: " + codec.getName()); } } } } } return response; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/InternalHttpClient.java0100664 0000000 0000000 00000022434 15005672035 030442 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.Closeable; import java.io.IOException; import java.util.List; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.function.Function; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Internal implementation of {@link CloseableHttpClient}. *

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

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

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

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

* Example usage: * 

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

* This method is used by both backOff() and probe() methods to enforce the cool-down period before making adjustments * to the connection pool size. * * @param route the {@link HttpRoute} to check * @param now the current {@link Instant} used to calculate the time since the last probe or backoff * @return true if the cool-down period has not elapsed since the last probe or backoff, false otherwise */ private boolean shouldSkip(final HttpRoute route, final Instant now) { final Instant lastProbe = getLastRouteProbes().getOrDefault(route, Instant.EPOCH); final Instant lastBackoff = getLastRouteBackoffs().getOrDefault(route, Instant.EPOCH); return Duration.between(lastProbe, now).compareTo(getCoolDown().get().toDuration()) < 0 || Duration.between(lastBackoff, now).compareTo(getCoolDown().get().toDuration()) < 0; } /** * Returns the new pool size after applying the linear backoff algorithm. * The new pool size is calculated by adding the increment value to the current pool size. * * @param curr the current pool size * @return the new pool size after applying the linear backoff */ @Override protected int getBackedOffPoolSize(final int curr) { return curr + increment; } /** * This method is not used in LinearBackoffManager's implementation. * It is provided to fulfill the interface requirement and for potential future extensions or modifications * of LinearBackoffManager that may use the backoff factor. * * @param d the backoff factor, not used in the current implementation */ @Override public void setBackoffFactor(final double d) { // Intentionally empty, as the backoff factor is not used in LinearBackoffManager } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpRequestRetryExec.java0100664 0000000 0000000 00000020077 15052544051 031011 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InterruptedIOException; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChain.Scope; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.NoHttpResponseException; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request executor in the request execution chain that is responsible for * making a decision whether a request that failed due to an I/O exception * or received a specific response from the target server should * be re-executed. *

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

*

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

*

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

* *

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

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public class HttpRequestRetryExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(HttpRequestRetryExec.class); private final HttpRequestRetryStrategy retryStrategy; public HttpRequestRetryExec( final HttpRequestRetryStrategy retryStrategy) { Args.notNull(retryStrategy, "retryStrategy"); this.retryStrategy = retryStrategy; } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "request"); Args.notNull(scope, "scope"); final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final HttpHost target = route.getTargetHost(); final HttpClientContext context = scope.clientContext; ClassicHttpRequest currentRequest = request; for (int execCount = 1;; execCount++) { try { final ClassicHttpResponse response = chain.proceed(currentRequest, scope); try { final HttpEntity entity = request.getEntity(); if (entity != null && !entity.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot retry non-repeatable request", exchangeId); } return response; } if (retryStrategy.retryRequest(response, execCount, context)) { response.close(); final TimeValue delay = retryStrategy.getRetryInterval(response, execCount, context); if (LOG.isInfoEnabled()) { LOG.info("{} {} responded with status {}; " + "request will be automatically re-executed in {} (exec count {})", exchangeId, target, response.getCode(), delay, execCount + 1); } pause(delay); currentRequest = ClassicRequestBuilder.copy(scope.originalRequest).build(); } else { return response; } } catch (final RuntimeException ex) { response.close(); throw ex; } } catch (final IOException ex) { if (scope.execRuntime.isExecutionAborted()) { throw new RequestFailedException("Request aborted"); } final HttpEntity requestEntity = request.getEntity(); if (requestEntity != null && !requestEntity.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot retry non-repeatable request", exchangeId); } throw ex; } if (retryStrategy.retryRequest(request, ex, execCount, context)) { if (LOG.isDebugEnabled()) { LOG.debug("{} {}", exchangeId, ex.getMessage(), ex); } final TimeValue delay = retryStrategy.getRetryInterval(request, ex, execCount, context); if (LOG.isInfoEnabled()) { LOG.info("{} recoverable I/O exception ({}) caught when sending request to {};" + "request will be automatically re-executed in {} (exec count {})", exchangeId, ex.getClass().getName(), target, delay, execCount + 1); } pause(delay); currentRequest = ClassicRequestBuilder.copy(scope.originalRequest).build(); continue; } if (ex instanceof NoHttpResponseException) { final NoHttpResponseException updatedex = new NoHttpResponseException( target.toHostString() + " failed to respond"); updatedex.setStackTrace(ex.getStackTrace()); throw updatedex; } throw ex; } } } private static void pause(final TimeValue delay) throws InterruptedIOException { if (TimeValue.isPositive(delay)) { try { delay.sleep(); } catch (final InterruptedException e) { Thread.currentThread().interrupt(); throw new InterruptedIOException(); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/MinimalHttpClient.java0100664 0000000 0000000 00000020546 15005672016 030255 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InterruptedIOException; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.ConnectionShutdownException; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RequestClientConnControl; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.RequestContent; import org.apache.hc.core5.http.protocol.RequestTargetHost; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.VersionInfo; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Minimal implementation of {@link CloseableHttpClient}. This client is * optimized for HTTP/1.1 message transport and does not support advanced * HTTP protocol functionality such as request execution via a proxy, state * management, authentication and request redirects. *

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

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public class MinimalHttpClient extends CloseableHttpClient { private static final Logger LOG = LoggerFactory.getLogger(MinimalHttpClient.class); private final HttpClientConnectionManager connManager; private final ConnectionReuseStrategy reuseStrategy; private final SchemePortResolver schemePortResolver; private final HttpRequestExecutor requestExecutor; private final HttpProcessor httpProcessor; MinimalHttpClient(final HttpClientConnectionManager connManager) { super(); this.connManager = Args.notNull(connManager, "HTTP connection manager"); this.reuseStrategy = DefaultClientConnectionReuseStrategy.INSTANCE; this.schemePortResolver = DefaultSchemePortResolver.INSTANCE; this.requestExecutor = new HttpRequestExecutor(this.reuseStrategy); this.httpProcessor = new DefaultHttpProcessor( new RequestContent(), new RequestTargetHost(), new RequestClientConnControl(), new RequestUserAgent(VersionInfo.getSoftwareInfo( "Apache-HttpClient", "org.apache.hc.client5", getClass()))); } @Override protected CloseableHttpResponse doExecute( final HttpHost target, final ClassicHttpRequest request, final HttpContext context) throws IOException { Args.notNull(target, "Target host"); Args.notNull(request, "HTTP request"); if (request.getScheme() == null) { request.setScheme(target.getSchemeName()); } if (request.getAuthority() == null) { request.setAuthority(new URIAuthority(target)); } final HttpClientContext clientContext = HttpClientContext.castOrCreate(context); RequestConfig config = null; if (request instanceof Configurable) { config = ((Configurable) request).getConfig(); } if (config != null) { clientContext.setRequestConfig(config); } final HttpRoute route = new HttpRoute(RoutingSupport.normalize(target, schemePortResolver)); final String exchangeId = ExecSupport.getNextExchangeId(); clientContext.setExchangeId(exchangeId); final ExecRuntime execRuntime = new InternalExecRuntime(LOG, connManager, requestExecutor, request instanceof CancellableDependency ? (CancellableDependency) request : null); try { if (!execRuntime.isEndpointAcquired()) { execRuntime.acquireEndpoint(exchangeId, route, null, clientContext); } if (!execRuntime.isEndpointConnected()) { execRuntime.connectEndpoint(clientContext); } clientContext.setRequest(request); clientContext.setRoute(route); httpProcessor.process(request, request.getEntity(), clientContext); final ClassicHttpResponse response = execRuntime.execute(exchangeId, request, clientContext); httpProcessor.process(response, response.getEntity(), clientContext); if (reuseStrategy.keepAlive(request, response, clientContext)) { execRuntime.markConnectionReusable(null, TimeValue.NEG_ONE_MILLISECOND); } else { execRuntime.markConnectionNonReusable(); } // check for entity, release connection if possible final HttpEntity entity = response.getEntity(); if (entity == null || !entity.isStreaming()) { // connection not needed and (assumed to be) in re-usable state execRuntime.releaseEndpoint(); return new CloseableHttpResponse(response); } ResponseEntityProxy.enhance(response, execRuntime); return new CloseableHttpResponse(response, execRuntime); } catch (final ConnectionShutdownException ex) { final InterruptedIOException ioex = new InterruptedIOException("Connection has been shut down"); ioex.initCause(ex); execRuntime.discardEndpoint(); throw ioex; } catch (final HttpException httpException) { execRuntime.discardEndpoint(); throw new ClientProtocolException(httpException); } catch (final RuntimeException | IOException ex) { execRuntime.discardEndpoint(); throw ex; } catch (final Error error) { connManager.close(CloseMode.IMMEDIATE); throw error; } } @Override public void close() throws IOException { this.connManager.close(); } @Override public void close(final CloseMode closeMode) { this.connManager.close(closeMode); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ProxyClient.java0100664 0000000 0000000 00000022113 15005672016 027140 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.net.Socket; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteInfo.LayerType; import org.apache.hc.client5.http.RouteInfo.TunnelType; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.client5.http.impl.auth.AuthenticationHandler; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory; import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory; import org.apache.hc.client5.http.impl.io.ManagedHttpClientConnectionFactory; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RequestClientConnControl; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.RequestTargetHost; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.util.Args; /** * ProxyClient can be used to establish a tunnel via an HTTP/1.1 proxy. */ public class ProxyClient { private final HttpConnectionFactory connFactory; private final RequestConfig requestConfig; private final HttpProcessor httpProcessor; private final HttpRequestExecutor requestExec; private final AuthenticationStrategy proxyAuthStrategy; private final AuthenticationHandler authenticator; private final AuthExchange proxyAuthExchange; private final Lookup authSchemeRegistry; private final ConnectionReuseStrategy reuseStrategy; /** * @since 5.0 */ public ProxyClient( final HttpConnectionFactory connFactory, final Http1Config h1Config, final CharCodingConfig charCodingConfig, final RequestConfig requestConfig) { super(); this.connFactory = connFactory != null ? connFactory : ManagedHttpClientConnectionFactory.builder() .http1Config(h1Config) .charCodingConfig(charCodingConfig) .build(); this.requestConfig = requestConfig != null ? requestConfig : RequestConfig.DEFAULT; this.httpProcessor = new DefaultHttpProcessor( new RequestTargetHost(), new RequestClientConnControl(), new RequestUserAgent()); this.requestExec = new HttpRequestExecutor(); this.proxyAuthStrategy = new DefaultAuthenticationStrategy(); this.authenticator = new AuthenticationHandler(); this.proxyAuthExchange = new AuthExchange(); this.authSchemeRegistry = RegistryBuilder.create() .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE) .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE) .build(); this.reuseStrategy = DefaultClientConnectionReuseStrategy.INSTANCE; } /** * @since 4.3 */ public ProxyClient(final RequestConfig requestConfig) { this(null, null, null, requestConfig); } public ProxyClient() { this(null, null, null, null); } public Socket tunnel( final HttpHost proxy, final HttpHost target, final Credentials credentials) throws IOException, HttpException { Args.notNull(proxy, "Proxy host"); Args.notNull(target, "Target host"); Args.notNull(credentials, "Credentials"); Args.check(target.getPort() > 0, "A valid port number must be provided for the tunnel CONNECT request."); final HttpRoute route = new HttpRoute( target, null, proxy, false, TunnelType.TUNNELLED, LayerType.PLAIN); final ManagedHttpClientConnection conn = this.connFactory.createConnection(null); final HttpClientContext context = HttpClientContext.create(); ClassicHttpResponse response; final ClassicHttpRequest connect = new BasicClassicHttpRequest(Method.CONNECT, proxy, target.toHostString()); final BasicCredentialsProvider credsProvider = new BasicCredentialsProvider(); credsProvider.setCredentials(new AuthScope(proxy), credentials); // Populate the execution context context.setRequest(connect); context.setRoute(route); context.setCredentialsProvider(credsProvider); context.setAuthSchemeRegistry(this.authSchemeRegistry); context.setRequestConfig(this.requestConfig); this.requestExec.preProcess(connect, this.httpProcessor, context); for (;;) { if (!conn.isOpen()) { final Socket socket = new Socket(proxy.getHostName(), proxy.getPort()); conn.bind(socket); } this.authenticator.addAuthResponse(proxy, ChallengeType.PROXY, connect, this.proxyAuthExchange, context); response = this.requestExec.execute(connect, conn, context); final int status = response.getCode(); if (status < 200) { throw new HttpException("Unexpected response to CONNECT request: " + response); } if (this.authenticator.isChallenged(proxy, ChallengeType.PROXY, response, this.proxyAuthExchange, context) || authenticator.isChallengeExpected(proxyAuthExchange)) { if (this.authenticator.handleResponse(proxy, ChallengeType.PROXY, response, this.proxyAuthStrategy, this.proxyAuthExchange, context)) { // Retry request if (this.reuseStrategy.keepAlive(connect, response, context)) { // Consume response content final HttpEntity entity = response.getEntity(); EntityUtils.consume(entity); } else { conn.close(); } // discard previous auth header connect.removeHeaders(HttpHeaders.PROXY_AUTHORIZATION); } else { break; } } else { break; } } final int status = response.getCode(); if (status > 299) { EntityUtils.consume(response.getEntity()); conn.close(); throw new HttpException("Tunnel refused: " + new StatusLine(response)); } return conn.getSocket(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/CloseableHttpClient.java0100664 0000000 0000000 00000030235 14666635064 030572 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.classic.HttpClient; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Base implementation of {@link HttpClient} that also implements {@link ModalCloseable}. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.SAFE) public abstract class CloseableHttpClient implements HttpClient, ModalCloseable { private static final Logger LOG = LoggerFactory.getLogger(CloseableHttpClient.class); protected abstract CloseableHttpResponse doExecute(HttpHost target, ClassicHttpRequest request, HttpContext context) throws IOException; private static HttpHost determineTarget(final ClassicHttpRequest request) throws ClientProtocolException { try { return RoutingSupport.determineHost(request); } catch (final HttpException ex) { throw new ClientProtocolException(ex); } } /** * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(HttpHost, ClassicHttpRequest, HttpContext, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated @Override public CloseableHttpResponse execute( final HttpHost target, final ClassicHttpRequest request, final HttpContext context) throws IOException { return doExecute(target, request, context); } /** * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(ClassicHttpRequest, HttpContext, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated @Override public CloseableHttpResponse execute( final ClassicHttpRequest request, final HttpContext context) throws IOException { Args.notNull(request, "HTTP request"); return doExecute(determineTarget(request), request, context); } /** * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(ClassicHttpRequest, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(ClassicHttpRequest, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated @Override public CloseableHttpResponse execute( final ClassicHttpRequest request) throws IOException { return doExecute(determineTarget(request), request, null); } /** * @deprecated It is strongly recommended to use execute methods with {@link HttpClientResponseHandler} * such as {@link #execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler)} in order * to ensure automatic resource deallocation by the client. * For special cases one can still use {@link #executeOpen(HttpHost, ClassicHttpRequest, HttpContext)} * to keep the response object open after the request execution. * * @see #execute(HttpHost, ClassicHttpRequest, HttpClientResponseHandler) * @see #executeOpen(HttpHost, ClassicHttpRequest, HttpContext) */ @Deprecated @Override public CloseableHttpResponse execute( final HttpHost target, final ClassicHttpRequest request) throws IOException { return doExecute(target, request, null); } /** * Executes a request using the default context and processes the * response using the given response handler. The content entity associated * with the response is fully consumed and the underlying connection is * released back to the connection manager automatically in all cases * relieving individual {@link HttpClientResponseHandler}s from having to manage * resource deallocation internally. * * @param request the request to execute * @param responseHandler the response handler * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted * @throws ClientProtocolException in case of an http protocol error */ @Override public T execute(final ClassicHttpRequest request, final HttpClientResponseHandler responseHandler) throws IOException { return execute(request, null, responseHandler); } /** * Executes a request using the default context and processes the * response using the given response handler. The content entity associated * with the response is fully consumed and the underlying connection is * released back to the connection manager automatically in all cases * relieving individual {@link HttpClientResponseHandler}s from having to manage * resource deallocation internally. * * @param request the request to execute * @param responseHandler the response handler * @param context the context to use for the execution, or * {@code null} to use the default context * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted * @throws ClientProtocolException in case of an http protocol error */ @Override public T execute( final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler responseHandler) throws IOException { final HttpHost target = determineTarget(request); return execute(target, request, context, responseHandler); } /** * Executes a request using the default context and processes the * response using the given response handler. The content entity associated * with the response is fully consumed and the underlying connection is * released back to the connection manager automatically in all cases * relieving individual {@link HttpClientResponseHandler}s from having to manage * resource deallocation internally. * * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * @param responseHandler the response handler * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted * @throws ClientProtocolException in case of an http protocol error */ @Override public T execute(final HttpHost target, final ClassicHttpRequest request, final HttpClientResponseHandler responseHandler) throws IOException { return execute(target, request, null, responseHandler); } /** * Executes a request using the default context and processes the * response using the given response handler. The content entity associated * with the response is fully consumed and the underlying connection is * released back to the connection manager automatically in all cases * relieving individual {@link HttpClientResponseHandler}s from having to manage * resource deallocation internally. * * @param target the target host for the request. * Implementations may accept {@code null} * if they can still determine a route, for example * to a default target or by inspecting the request. * @param request the request to execute * @param context the context to use for the execution, or * {@code null} to use the default context * @param responseHandler the response handler * * @return the response object as generated by the response handler. * @throws IOException in case of a problem or the connection was aborted * @throws ClientProtocolException in case of an http protocol error */ @Override public T execute( final HttpHost target, final ClassicHttpRequest request, final HttpContext context, final HttpClientResponseHandler responseHandler) throws IOException { Args.notNull(responseHandler, "Response handler"); try (final ClassicHttpResponse response = doExecute(target, request, context)) { try { final T result = responseHandler.handleResponse(response); final HttpEntity entity = response.getEntity(); EntityUtils.consume(entity); return result; } catch (final HttpException t) { // Try to salvage the underlying connection in case of a protocol exception final HttpEntity entity = response.getEntity(); try { EntityUtils.consume(entity); } catch (final Exception t2) { // Log this exception. The original exception is more // important and will be thrown to the caller. LOG.warn("Error consuming content after an exception.", t2); } throw new ClientProtocolException(t); } } } } ././@LongLink0100644 0000000 0000000 00000000145 14666635064 011653 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/FutureRequestExecutionMetrics.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/FutureRequestExecutionMetrics.java0100664 0000000 0000000 00000011534 14666635064 032741 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.util.concurrent.atomic.AtomicLong; /** * Collection of different counters used to gather metrics for {@link FutureRequestExecutionService}. */ public final class FutureRequestExecutionMetrics { private final AtomicLong activeConnections = new AtomicLong(); private final AtomicLong scheduledConnections = new AtomicLong(); private final DurationCounter successfulConnections = new DurationCounter(); private final DurationCounter failedConnections = new DurationCounter(); private final DurationCounter requests = new DurationCounter(); private final DurationCounter tasks = new DurationCounter(); FutureRequestExecutionMetrics() { } AtomicLong getActiveConnections() { return activeConnections; } AtomicLong getScheduledConnections() { return scheduledConnections; } DurationCounter getSuccessfulConnections() { return successfulConnections; } DurationCounter getFailedConnections() { return failedConnections; } DurationCounter getRequests() { return requests; } DurationCounter getTasks() { return tasks; } public long getActiveConnectionCount() { return activeConnections.get(); } public long getScheduledConnectionCount() { return scheduledConnections.get(); } public long getSuccessfulConnectionCount() { return successfulConnections.count(); } public long getSuccessfulConnectionAverageDuration() { return successfulConnections.averageDuration(); } public long getFailedConnectionCount() { return failedConnections.count(); } public long getFailedConnectionAverageDuration() { return failedConnections.averageDuration(); } public long getRequestCount() { return requests.count(); } public long getRequestAverageDuration() { return requests.averageDuration(); } public long getTaskCount() { return tasks.count(); } public long getTaskAverageDuration() { return tasks.averageDuration(); } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("[activeConnections=").append(activeConnections) .append(", scheduledConnections=").append(scheduledConnections) .append(", successfulConnections=").append(successfulConnections) .append(", failedConnections=").append(failedConnections) .append(", requests=").append(requests) .append(", tasks=").append(tasks) .append("]"); return builder.toString(); } /** * A counter that can measure duration and number of events. */ static class DurationCounter { private final AtomicLong count = new AtomicLong(0); private final AtomicLong cumulativeDuration = new AtomicLong(0); public void increment(final long startTime) { count.incrementAndGet(); cumulativeDuration.addAndGet(System.currentTimeMillis() - startTime); } public long count() { return count.get(); } public long averageDuration() { final long counter = count.get(); return counter > 0 ? cumulativeDuration.get() / counter : 0; } @Override public String toString() { final StringBuilder builder = new StringBuilder(); builder.append("[count=").append(count()) .append(", averageDuration=").append(averageDuration()) .append("]"); return builder.toString(); } } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/HttpRequestFutureTask.java0100664 0000000 0000000 00000006434 14704162040 031172 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.util.concurrent.FutureTask; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.http.ClassicHttpRequest; final class HttpRequestFutureTask extends FutureTask { private final ClassicHttpRequest request; private final HttpRequestTaskCallable callable; HttpRequestFutureTask( final ClassicHttpRequest request, final HttpRequestTaskCallable httpCallable) { super(httpCallable); this.request = request; this.callable = httpCallable; } @Override public boolean cancel(final boolean mayInterruptIfRunning) { callable.cancel(); if (mayInterruptIfRunning && request instanceof Cancellable) { ((Cancellable) request).cancel(); } return super.cancel(mayInterruptIfRunning); } /** * @return the time in millis the task was scheduled. */ public long scheduledTime() { return callable.getScheduled(); } /** * @return the time in millis the task was started. */ public long startedTime() { return callable.getStarted(); } /** * @return the time in millis the task was finished/cancelled. */ public long endedTime() { if (isDone()) { return callable.getEnded(); } throw new IllegalStateException("Task is not done yet"); } /** * @return the time in millis it took to make the request (excluding the time it was * scheduled to be executed). */ public long requestDuration() { if (isDone()) { return endedTime() - startedTime(); } throw new IllegalStateException("Task is not done yet"); } /** * @return the time in millis it took to execute the task from the moment it was scheduled. */ public long taskDuration() { if (isDone()) { return endedTime() - scheduledTime(); } throw new IllegalStateException("Task is not done yet"); } @Override public String toString() { return request.toString(); } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/AbstractBackoff.java0100664 0000000 0000000 00000025271 14666635064 027725 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.classic.BackoffManager; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.time.Instant; import java.time.temporal.ChronoUnit; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicReference; /** * AbstractBackoff is an abstract class that provides a common implementation for managing * backoff behavior in HttpClient connection pool. Subclasses should implement the specific * backoff algorithms by overriding the abstract methods. *

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

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

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

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public final class BackoffStrategyExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(BackoffStrategyExec.class); private final ConnectionBackoffStrategy connectionBackoffStrategy; private final BackoffManager backoffManager; /** * Constructs a {@code BackoffStrategyExec} with the specified * {@link ConnectionBackoffStrategy} and {@link BackoffManager}. * * @param connectionBackoffStrategy the strategy to determine whether * to backoff based on the response or exception * @param backoffManager the manager responsible for applying backoff * and probing actions to the HTTP routes */ public BackoffStrategyExec( final ConnectionBackoffStrategy connectionBackoffStrategy, final BackoffManager backoffManager) { super(); Args.notNull(connectionBackoffStrategy, "Connection backoff strategy"); Args.notNull(backoffManager, "Backoff manager"); this.connectionBackoffStrategy = connectionBackoffStrategy; this.backoffManager = backoffManager; } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final HttpRoute route = scope.route; final ClassicHttpResponse response; try { response = chain.proceed(request, scope); } catch (final IOException | HttpException ex) { if (this.connectionBackoffStrategy.shouldBackoff(ex)) { if (LOG.isDebugEnabled()) { LOG.debug("Backing off route {} due to exception: {}", route, ex.getMessage()); } this.backoffManager.backOff(route); } throw ex; } if (this.connectionBackoffStrategy.shouldBackoff(response)) { if (LOG.isDebugEnabled()) { LOG.debug("Backing off route {} due to response status: {}", route, response.getCode()); } this.backoffManager.backOff(route); } else { if (LOG.isDebugEnabled()) { LOG.debug("Probing route: {}", route); } this.backoffManager.probe(route); } return response; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/DefaultBackoffStrategy.java0100664 0000000 0000000 00000004275 14666635064 031272 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.net.ConnectException; import java.net.SocketTimeoutException; import org.apache.hc.client5.http.classic.ConnectionBackoffStrategy; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; /** * This {@link ConnectionBackoffStrategy} backs off either for a raw * network socket or connection timeout or if the server explicitly * sends a 429 (Too Many Requests) or a 503 (Service Unavailable) response. * * @since 4.2 */ @Experimental public class DefaultBackoffStrategy implements ConnectionBackoffStrategy { @Override public boolean shouldBackoff(final Throwable t) { return t instanceof SocketTimeoutException || t instanceof ConnectException; } @Override public boolean shouldBackoff(final HttpResponse response) { return response.getCode() == HttpStatus.SC_TOO_MANY_REQUESTS || response.getCode() == HttpStatus.SC_SERVICE_UNAVAILABLE; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/RedirectExec.java0100664 0000000 0000000 00000026145 15005672035 027240 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.net.URI; import java.util.Objects; import org.apache.hc.client5.http.CircularRedirectException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RedirectException; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectLocations; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.client5.http.utils.URIUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the classic request execution chain * responsible for handling of request redirects. *

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

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class RedirectExec implements ExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(RedirectExec.class); private final RedirectStrategy redirectStrategy; private final HttpRoutePlanner routePlanner; public RedirectExec( final HttpRoutePlanner routePlanner, final RedirectStrategy redirectStrategy) { super(); Args.notNull(routePlanner, "HTTP route planner"); Args.notNull(redirectStrategy, "HTTP redirect strategy"); this.routePlanner = routePlanner; this.redirectStrategy = redirectStrategy; } @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final HttpClientContext context = scope.clientContext; context.setRedirectLocations(null); final RequestConfig config = context.getRequestConfigOrDefault(); final int maxRedirects = config.getMaxRedirects() > 0 ? config.getMaxRedirects() : 50; ClassicHttpRequest currentRequest = request; ExecChain.Scope currentScope = scope; for (int redirectCount = 0;;) { final String exchangeId = currentScope.exchangeId; final ClassicHttpResponse response = chain.proceed(currentRequest, currentScope); try { if (config.isRedirectsEnabled() && this.redirectStrategy.isRedirected(request, response, context)) { final HttpEntity requestEntity = request.getEntity(); if (requestEntity != null && !requestEntity.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot redirect non-repeatable request", exchangeId); } return response; } if (redirectCount >= maxRedirects) { throw new RedirectException("Maximum redirects (" + maxRedirects + ") exceeded"); } redirectCount++; final URI redirectUri = this.redirectStrategy.getLocationURI(currentRequest, response, context); if (LOG.isDebugEnabled()) { LOG.debug("{} redirect requested to location '{}'", exchangeId, redirectUri); } final HttpHost newTarget = URIUtils.extractHost(redirectUri); if (newTarget == null) { throw new ProtocolException("Redirect URI does not specify a valid host name: " + redirectUri); } final RedirectLocations redirectLocations = context.getRedirectLocations(); if (!config.isCircularRedirectsAllowed()) { if (redirectLocations.contains(redirectUri)) { throw new CircularRedirectException("Circular redirect to '" + redirectUri + "'"); } } final int statusCode = response.getCode(); final ClassicRequestBuilder redirectBuilder; switch (statusCode) { case HttpStatus.SC_MOVED_PERMANENTLY: case HttpStatus.SC_MOVED_TEMPORARILY: if (Method.POST.isSame(request.getMethod())) { redirectBuilder = ClassicRequestBuilder.get(); } else { redirectBuilder = ClassicRequestBuilder.copy(currentScope.originalRequest); } break; case HttpStatus.SC_SEE_OTHER: if (!Method.GET.isSame(request.getMethod()) && !Method.HEAD.isSame(request.getMethod())) { redirectBuilder = ClassicRequestBuilder.get(); } else { redirectBuilder = ClassicRequestBuilder.copy(currentScope.originalRequest); } break; default: redirectBuilder = ClassicRequestBuilder.copy(currentScope.originalRequest); } redirectBuilder.setUri(redirectUri); final ClassicHttpRequest redirect = redirectBuilder.build(); final HttpRoute currentRoute = currentScope.route; final HttpHost currentHost = currentRoute.getTargetHost(); if (!redirectStrategy.isRedirectAllowed(currentHost, newTarget, redirect, context)) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot redirect due to safety restrictions", exchangeId); } return response; } redirectLocations.add(redirectUri); final HttpRoute newRoute; if (!Objects.equals(currentHost, newTarget)) { newRoute = this.routePlanner.determineRoute(newTarget, context); if (!Objects.equals(currentRoute, newRoute)) { if (LOG.isDebugEnabled()) { LOG.debug("{} new route required", exchangeId); } final AuthExchange targetAuthExchange = context.getAuthExchange(currentHost); if (LOG.isDebugEnabled()) { LOG.debug("{} resetting target auth state", exchangeId); } targetAuthExchange.reset(); final HttpHost proxyHost = currentRoute.getProxyHost(); if (proxyHost != null) { final AuthExchange proxyAuthExchange = context.getAuthExchange(proxyHost); if (proxyAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting proxy auth state", exchangeId); } proxyAuthExchange.reset(); } } } } else { newRoute = currentRoute; } if (LOG.isDebugEnabled()) { LOG.debug("{} redirecting to '{}' via {}", exchangeId, redirectUri, newRoute); } currentScope = new ExecChain.Scope( scope.exchangeId, newRoute, ClassicRequestBuilder.copy(redirect).build(), scope.execRuntime, scope.clientContext); currentRequest = redirect; RequestEntityProxy.enhance(currentRequest); EntityUtils.consume(response.getEntity()); response.close(); } else { return response; } } catch (final RuntimeException | IOException ex) { response.close(); throw ex; } catch (final HttpException ex) { // Protocol exception related to a direct. // The underlying connection may still be salvaged. try { EntityUtils.consume(response.getEntity()); } catch (final IOException ioex) { if (LOG.isDebugEnabled()) { LOG.debug("{} I/O error while releasing connection", exchangeId, ioex); } } finally { response.close(); } throw ex; } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/RequestEntityProxy.java0100664 0000000 0000000 00000007233 15005672035 030556 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.util.List; import java.util.Set; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; class RequestEntityProxy implements HttpEntity { static void enhance(final ClassicHttpRequest request) { final HttpEntity entity = request.getEntity(); if (entity != null && !entity.isRepeatable() && !isEnhanced(entity)) { request.setEntity(new RequestEntityProxy(entity)); } } static boolean isEnhanced(final HttpEntity entity) { return entity instanceof RequestEntityProxy; } private final HttpEntity original; private boolean consumed; RequestEntityProxy(final HttpEntity original) { super(); this.original = original; } public HttpEntity getOriginal() { return original; } public boolean isConsumed() { return consumed; } @Override public boolean isRepeatable() { return !consumed || original.isRepeatable(); } @Override public boolean isChunked() { return original.isChunked(); } @Override public long getContentLength() { return original.getContentLength(); } @Override public String getContentType() { return original.getContentType(); } @Override public String getContentEncoding() { return original.getContentEncoding(); } @Override public InputStream getContent() throws IOException, IllegalStateException { return original.getContent(); } @Override public void writeTo(final OutputStream outStream) throws IOException { consumed = true; original.writeTo(outStream); } @Override public boolean isStreaming() { return original.isStreaming(); } @Override public Supplier> getTrailers() { return original.getTrailers(); } @Override public Set getTrailerNames() { return original.getTrailerNames(); } @Override public void close() throws IOException { original.close(); } @Override public String toString() { final StringBuilder sb = new StringBuilder("RequestEntityProxy{"); sb.append(original); sb.append('}'); return sb.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/NullBackoffStrategy.java0100664 0000000 0000000 00000003347 14666635064 030617 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.classic.ConnectionBackoffStrategy; import org.apache.hc.core5.http.HttpResponse; /** * This is a {@link ConnectionBackoffStrategy} that never backs off, * for compatibility with existing behavior. * * @since 4.2 */ public class NullBackoffStrategy implements ConnectionBackoffStrategy { @Override public boolean shouldBackoff(final Throwable t) { return false; } @Override public boolean shouldBackoff(final HttpResponse response) { return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ClassicRequestCopier.java0100664 0000000 0000000 00000004675 14704162040 030765 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.util.Iterator; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; /** * {@link ClassicHttpRequest} copier. * * @since 5.0 * * @deprecated Use {@link org.apache.hc.core5.http.io.support.ClassicRequestBuilder} */ @Deprecated public final class ClassicRequestCopier implements org.apache.hc.client5.http.impl.MessageCopier { /** * Default instance of {@link ClassicRequestCopier}. */ public static final ClassicRequestCopier INSTANCE = new ClassicRequestCopier(); @Override public ClassicHttpRequest copy(final ClassicHttpRequest original) { if (original == null) { return null; } final BasicClassicHttpRequest copy = new BasicClassicHttpRequest(original.getMethod(), null, original.getPath()); copy.setScheme(original.getScheme()); copy.setAuthority(original.getAuthority()); copy.setVersion(original.getVersion()); for (final Iterator
it = original.headerIterator(); it.hasNext(); ) { copy.addHeader(it.next()); } copy.setEntity(original.getEntity()); return copy; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/RequestFailedException.java0100664 0000000 0000000 00000003407 14666635064 031317 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.InterruptedIOException; /** * Signals that the request has been aborted or failed due to an expected condition. * * @since 5.0 */ public class RequestFailedException extends InterruptedIOException { private static final long serialVersionUID = 4973849966012490112L; public RequestFailedException(final String message) { super(message); } public RequestFailedException(final String message, final Throwable cause) { super(message); if (cause != null) { initCause(cause); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/classic/ExponentialBackoffManager.java0100664 0000000 0000000 00000007474 14704162040 031726 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * A backoff manager implementation that uses an exponential backoff algorithm to adjust the maximum * number of connections per HTTP route. The algorithm reduces the number of connections in response * to adverse events, such as connection failures, and gradually increases the number of connections * when the route is operating without issues. * *

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

The exponential backoff algorithm is primarily implemented in the {@code getBackedOffPoolSize} * method, which calculates the new connection pool size based on the current pool size, growth rate, * and the number of time intervals. * * @since 5.3 */ public class ExponentialBackoffManager extends AbstractBackoff { private static final Logger LOG = LoggerFactory.getLogger(ExponentialBackoffManager.class); /** * Constructs a new ExponentialBackoffManager with the specified connection pool control. * * @param connPerRoute the connection pool control to be used for managing connections * @throws IllegalArgumentException if connPerRoute is null */ public ExponentialBackoffManager(final ConnPoolControl connPerRoute) { super(connPerRoute); } /** * Calculates the new pool size after applying the exponential backoff algorithm. * The new pool size is calculated using the formula: floor(curr / (1 + growthRate) ^ t), * where curr is the current pool size, growthRate is the exponential growth rate, and t is the time interval. * * @param curr the current pool size * @return the new pool size after applying the backoff */ @Override protected int getBackedOffPoolSize(final int curr) { if (curr <= 1) { return 1; } final int t = getTimeInterval().incrementAndGet(); final int result = Math.max(1, (int) Math.floor(curr / Math.pow(1 + getBackoffFactor().get(), t))); if (LOG.isDebugEnabled()) { LOG.debug("curr={}, t={}, growthRate={}, result={}", curr, t, getBackoffFactor().get(), result); } return result; } @Override public void setBackoffFactor(final double rate) { Args.check(rate > 0.0, "Growth rate must be greater than 0.0"); this.getBackoffFactor().set(rate); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/0040775 0000000 0000000 00000000000 15063503637 023523 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000147 14740035240 011634 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LoggingAsyncClientExchangeHandler.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LoggingAsyncClientExchangeHandler.ja0100664 0000000 0000000 00000014645 14740035240 032521 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Identifiable; import org.slf4j.Logger; final class LoggingAsyncClientExchangeHandler implements AsyncClientExchangeHandler, Identifiable { private final Logger log; private final String exchangeId; private final AsyncClientExchangeHandler handler; LoggingAsyncClientExchangeHandler(final Logger log, final String exchangeId, final AsyncClientExchangeHandler handler) { this.log = log; this.exchangeId = exchangeId; this.handler = handler; } @Override public String getId() { return exchangeId; } @Override public void releaseResources() { handler.releaseResources(); } @Override public void produceRequest(final RequestChannel channel, final HttpContext context) throws HttpException, IOException { handler.produceRequest((request, entityDetails, context1) -> { if (log.isDebugEnabled()) { log.debug("{} send request {} {}, {}", exchangeId, request.getMethod(), request.getRequestUri(), entityDetails != null ? "entity len " + entityDetails.getContentLength() : "null entity"); } channel.sendRequest(request, entityDetails, context1); }, context); } @Override public int available() { return handler.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { if (log.isDebugEnabled()) { log.debug("{}: produce request data", exchangeId); } handler.produce(new DataStreamChannel() { @Override public void requestOutput() { channel.requestOutput(); } @Override public int write(final ByteBuffer src) throws IOException { if (log.isDebugEnabled()) { log.debug("{}: produce request data, len {} bytes", exchangeId, src.remaining()); } return channel.write(src); } @Override public void endStream() throws IOException { if (log.isDebugEnabled()) { log.debug("{}: end of request data", exchangeId); } channel.endStream(); } @Override public void endStream(final List trailers) throws IOException { if (log.isDebugEnabled()) { log.debug("{}: end of request data", exchangeId); } channel.endStream(trailers); } }); } @Override public void consumeInformation( final HttpResponse response, final HttpContext context) throws HttpException, IOException { if (log.isDebugEnabled()) { log.debug("{}: information response {}", exchangeId, response.getCode()); } handler.consumeInformation(response, context); } @Override public void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { if (log.isDebugEnabled()) { log.debug("{}: consume response {}, {}", exchangeId, response.getCode(), entityDetails != null ? "entity len " + entityDetails.getContentLength() : " null entity"); } handler.consumeResponse(response, entityDetails, context); } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { handler.updateCapacity(increment -> { if (log.isDebugEnabled()) { log.debug("{} capacity update {}", exchangeId, increment); } capacityChannel.update(increment); }); } @Override public void consume(final ByteBuffer src) throws IOException { if (log.isDebugEnabled()) { log.debug("{}: consume response data, len {} bytes", exchangeId, src.remaining()); } handler.consume(src); } @Override public void streamEnd(final List trailers) throws HttpException, IOException { if (log.isDebugEnabled()) { log.debug("{}: end of response data", exchangeId); } handler.streamEnd(trailers); } @Override public void failed(final Exception cause) { if (log.isDebugEnabled()) { log.debug("{}: execution failed: {}", exchangeId, cause.getMessage()); } handler.failed(cause); } @Override public void cancel() { if (log.isDebugEnabled()) { log.debug("{}: execution cancelled", exchangeId); } handler.cancel(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/package-info.java0100664 0000000 0000000 00000002474 14666635064 026726 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Asynchronous HTTP client API implementation that supports both * HTTP/2 and HTTP/1.1 transport. */ package org.apache.hc.client5.http.impl.async; httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncProtocolExec.java0100664 0000000 0000000 00000040162 15005672016 027764 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.util.Iterator; import java.util.concurrent.atomic.AtomicBoolean; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.RequestSupport; import org.apache.hc.client5.http.impl.auth.AuthCacheKeeper; import org.apache.hc.client5.http.impl.auth.AuthenticationHandler; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the asynchronous request execution chain * that is responsible for implementation of HTTP specification requirements. *

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

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class AsyncProtocolExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(AsyncProtocolExec.class); private final AuthenticationStrategy targetAuthStrategy; private final AuthenticationStrategy proxyAuthStrategy; private final AuthenticationHandler authenticator; private final SchemePortResolver schemePortResolver; private final AuthCacheKeeper authCacheKeeper; AsyncProtocolExec( final AuthenticationStrategy targetAuthStrategy, final AuthenticationStrategy proxyAuthStrategy, final SchemePortResolver schemePortResolver, final boolean authCachingDisabled) { this.targetAuthStrategy = Args.notNull(targetAuthStrategy, "Target authentication strategy"); this.proxyAuthStrategy = Args.notNull(proxyAuthStrategy, "Proxy authentication strategy"); this.authenticator = new AuthenticationHandler(); this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; this.authCacheKeeper = authCachingDisabled ? null : new AuthCacheKeeper(this.schemePortResolver); } @Override public void execute( final HttpRequest userRequest, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { if (Method.CONNECT.isSame(userRequest.getMethod())) { throw new ProtocolException("Direct execution of CONNECT is not allowed"); } final HttpRoute route = scope.route; final HttpHost routeTarget = route.getTargetHost(); final HttpHost proxy = route.getProxyHost(); final HttpClientContext clientContext = scope.clientContext; final HttpRequest request; if (proxy != null && !route.isTunnelled()) { final BasicRequestBuilder requestBuilder = BasicRequestBuilder.copy(userRequest); if (requestBuilder.getAuthority() == null) { requestBuilder.setAuthority(new URIAuthority(routeTarget)); } requestBuilder.setAbsoluteRequestUri(true); request = requestBuilder.build(); } else { request = userRequest; } // Ensure the request has a scheme and an authority if (request.getScheme() == null) { request.setScheme(routeTarget.getSchemeName()); } if (request.getAuthority() == null) { request.setAuthority(new URIAuthority(routeTarget)); } final URIAuthority authority = request.getAuthority(); if (authority.getUserInfo() != null) { throw new ProtocolException("Request URI authority contains deprecated userinfo component"); } final HttpHost target = new HttpHost( request.getScheme(), authority.getHostName(), schemePortResolver.resolve(request.getScheme(), authority)); final String pathPrefix = RequestSupport.extractPathPrefix(request); final AuthExchange targetAuthExchange = clientContext.getAuthExchange(target); final AuthExchange proxyAuthExchange = proxy != null ? clientContext.getAuthExchange(proxy) : new AuthExchange(); if (!targetAuthExchange.isConnectionBased() && targetAuthExchange.getPathPrefix() != null && !pathPrefix.startsWith(targetAuthExchange.getPathPrefix())) { // force re-authentication if the current path prefix does not match // that of the previous authentication exchange. targetAuthExchange.reset(); } if (targetAuthExchange.getPathPrefix() == null) { targetAuthExchange.setPathPrefix(pathPrefix); } if (authCacheKeeper != null) { authCacheKeeper.loadPreemptively(target, pathPrefix, targetAuthExchange, clientContext); if (proxy != null) { authCacheKeeper.loadPreemptively(proxy, null, proxyAuthExchange, clientContext); } } final AtomicBoolean challenged = new AtomicBoolean(false); internalExecute(target, pathPrefix, targetAuthExchange, proxyAuthExchange, challenged, request, entityProducer, scope, chain, asyncExecCallback); } private void internalExecute( final HttpHost target, final String pathPrefix, final AuthExchange targetAuthExchange, final AuthExchange proxyAuthExchange, final AtomicBoolean challenged, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final HttpClientContext clientContext = scope.clientContext; final AsyncExecRuntime execRuntime = scope.execRuntime; final HttpHost proxy = route.getProxyHost(); if (!request.containsHeader(HttpHeaders.AUTHORIZATION)) { if (LOG.isDebugEnabled()) { LOG.debug("{} target auth state: {}", exchangeId, targetAuthExchange.getState()); } authenticator.addAuthResponse(target, ChallengeType.TARGET, request, targetAuthExchange, clientContext); } if (!request.containsHeader(HttpHeaders.PROXY_AUTHORIZATION) && !route.isTunnelled()) { if (LOG.isDebugEnabled()) { LOG.debug("{} proxy auth state: {}", exchangeId, proxyAuthExchange.getState()); } authenticator.addAuthResponse(proxy, ChallengeType.PROXY, request, proxyAuthExchange, clientContext); } chain.proceed(request, entityProducer, scope, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { if (Method.TRACE.isSame(request.getMethod())) { // Do not perform authentication for TRACE request return asyncExecCallback.handleResponse(response, entityDetails); } if (needAuthentication( targetAuthExchange, proxyAuthExchange, proxy != null ? proxy : target, target, pathPrefix, response, clientContext)) { challenged.set(true); return null; } challenged.set(false); return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse( final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { if (!execRuntime.isEndpointConnected()) { if (proxyAuthExchange.getState() == AuthExchange.State.SUCCESS && proxyAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting proxy auth state", exchangeId); } proxyAuthExchange.reset(); } if (targetAuthExchange.getState() == AuthExchange.State.SUCCESS && targetAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting target auth state", exchangeId); } targetAuthExchange.reset(); } } if (challenged.get()) { if (entityProducer != null && !entityProducer.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot retry non-repeatable request", exchangeId); } asyncExecCallback.completed(); } else { // Reset request headers final HttpRequest original = scope.originalRequest; request.setHeaders(); for (final Iterator
it = original.headerIterator(); it.hasNext(); ) { request.addHeader(it.next()); } try { if (entityProducer != null) { entityProducer.releaseResources(); } internalExecute(target, pathPrefix, targetAuthExchange, proxyAuthExchange, challenged, request, entityProducer, scope, chain, asyncExecCallback); } catch (final HttpException | IOException ex) { asyncExecCallback.failed(ex); } } } else { asyncExecCallback.completed(); } } @Override public void failed(final Exception cause) { if (cause instanceof IOException || cause instanceof RuntimeException) { for (final AuthExchange authExchange : clientContext.getAuthExchanges().values()) { if (authExchange.isConnectionBased()) { authExchange.reset(); } } } asyncExecCallback.failed(cause); } }); } private boolean needAuthentication( final AuthExchange targetAuthExchange, final AuthExchange proxyAuthExchange, final HttpHost proxy, final HttpHost target, final String pathPrefix, final HttpResponse response, final HttpClientContext context) throws AuthenticationException, MalformedChallengeException { final RequestConfig config = context.getRequestConfigOrDefault(); if (config.isAuthenticationEnabled()) { final boolean targetAuthRequested = authenticator.isChallenged( target, ChallengeType.TARGET, response, targetAuthExchange, context); final boolean targetMutualAuthRequired = authenticator.isChallengeExpected(targetAuthExchange); if (authCacheKeeper != null) { if (targetAuthRequested) { authCacheKeeper.updateOnChallenge(target, pathPrefix, targetAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(target, pathPrefix, targetAuthExchange, context); } } final boolean proxyAuthRequested = authenticator.isChallenged( proxy, ChallengeType.PROXY, response, proxyAuthExchange, context); final boolean proxyMutualAuthRequired = authenticator.isChallengeExpected(proxyAuthExchange); if (authCacheKeeper != null) { if (proxyAuthRequested) { authCacheKeeper.updateOnChallenge(proxy, null, proxyAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(proxy, null, proxyAuthExchange, context); } } if (targetAuthRequested || targetMutualAuthRequired) { final boolean updated = authenticator.handleResponse(target, ChallengeType.TARGET, response, targetAuthStrategy, targetAuthExchange, context); if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(target, pathPrefix, targetAuthExchange, context); } return updated; } if (proxyAuthRequested || proxyMutualAuthRequired) { final boolean updated = authenticator.handleResponse(proxy, ChallengeType.PROXY, response, proxyAuthStrategy, proxyAuthExchange, context); if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(proxy, null, proxyAuthExchange, context); } return updated; } } return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncHttpRequestRetryExec.java0100664 0000000 0000000 00000023555 15052544051 031507 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.entity.DiscardingEntityConsumer; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request executor in the asynchronous request execution chain that is * responsible for making a decision whether a request that failed due to * an I/O exception or received a specific response from the target server should * be re-executed. *

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

*

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

*

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

* *

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

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class AsyncHttpRequestRetryExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(AsyncHttpRequestRetryExec.class); private final HttpRequestRetryStrategy retryStrategy; public AsyncHttpRequestRetryExec(final HttpRequestRetryStrategy retryStrategy) { Args.notNull(retryStrategy, "retryStrategy"); this.retryStrategy = retryStrategy; } private static class State { volatile boolean retrying; volatile int status; volatile TimeValue delay; } private void internalExecute( final State state, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final String exchangeId = scope.exchangeId; chain.proceed(BasicRequestBuilder.copy(request).build(), entityProducer, scope, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { final HttpClientContext clientContext = scope.clientContext; if (entityProducer != null && !entityProducer.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot retry non-repeatable request", exchangeId); } return asyncExecCallback.handleResponse(response, entityDetails); } state.retrying = retryStrategy.retryRequest(response, scope.execCount.get(), clientContext); if (state.retrying) { state.status = response.getCode(); state.delay = retryStrategy.getRetryInterval(response, scope.execCount.get(), clientContext); return new DiscardingEntityConsumer<>(); } return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { if (state.retrying) { final int execCount = scope.execCount.incrementAndGet(); if (entityProducer != null) { entityProducer.releaseResources(); } final HttpHost target = scope.route.getTargetHost(); final TimeValue delay = TimeValue.isPositive(state.delay) ? state.delay : TimeValue.ZERO_MILLISECONDS; if (LOG.isInfoEnabled()) { LOG.info("{} {} responded with status {}; " + "request will be automatically re-executed in {} (exec count {})", exchangeId, target, state.status, delay, execCount); } scope.scheduler.scheduleExecution( request, entityProducer, scope, (r, e, s, c) -> execute(r, e, s, chain, c), asyncExecCallback, delay); } else { asyncExecCallback.completed(); } } @Override public void failed(final Exception cause) { if (cause instanceof IOException) { final HttpHost target = scope.route.getTargetHost(); final HttpClientContext clientContext = scope.clientContext; if (entityProducer != null && !entityProducer.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot retry non-repeatable request", exchangeId); } } else if (retryStrategy.retryRequest(request, (IOException) cause, scope.execCount.get(), clientContext)) { if (LOG.isDebugEnabled()) { LOG.debug("{} {}", exchangeId, cause.getMessage(), cause); } scope.execRuntime.discardEndpoint(); if (entityProducer != null) { entityProducer.releaseResources(); } state.retrying = true; final int execCount = scope.execCount.incrementAndGet(); state.delay = retryStrategy.getRetryInterval(request, (IOException) cause, execCount - 1, clientContext); final TimeValue delay = TimeValue.isPositive(state.delay) ? state.delay : TimeValue.ZERO_MILLISECONDS; if (LOG.isInfoEnabled()) { LOG.info("{} recoverable I/O exception ({}) caught when sending request to {};" + "request will be automatically re-executed in {} (exec count {})", exchangeId, cause.getClass().getName(), target, delay, execCount); } scope.scheduler.scheduleExecution( request, entityProducer, scope, (r, e, s, c) -> execute(r, e, s, chain, c), asyncExecCallback, delay); return; } } asyncExecCallback.failed(cause); } }); } @Override public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final State state = new State(); state.retrying = false; internalExecute(state, request, entityProducer, scope, chain, asyncExecCallback); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncClients.java0100664 0000000 0000000 00000037010 15005672035 027616 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.compat.ClassicToAsyncAdaptor; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.concurrent.DefaultThreadFactory; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.routing.RequestRouter; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.http2.protocol.H2RequestConnControl; import org.apache.hc.core5.http2.protocol.H2RequestContent; import org.apache.hc.core5.http2.protocol.H2RequestTargetHost; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Timeout; import org.apache.hc.core5.util.VersionInfo; /** * Factory methods for {@link CloseableHttpAsyncClient} instances. * * @since 5.0 */ public final class HttpAsyncClients { private HttpAsyncClients() { super(); } /** * Creates builder object for construction of custom * {@link CloseableHttpAsyncClient} instances. */ public static HttpAsyncClientBuilder custom() { return HttpAsyncClientBuilder.create(); } /** * Creates {@link CloseableHttpAsyncClient} instance with default configuration. */ public static CloseableHttpAsyncClient createDefault() { return HttpAsyncClientBuilder.create().build(); } /** * Creates {@link CloseableHttpAsyncClient} instance with default * configuration and system properties. */ public static CloseableHttpAsyncClient createSystem() { return HttpAsyncClientBuilder.create().useSystemProperties().build(); } /** * Creates builder object for construction of custom HTTP/2 * {@link CloseableHttpAsyncClient} instances optimized for HTTP/2 protocol * and message multiplexing */ public static H2AsyncClientBuilder customHttp2() { return H2AsyncClientBuilder.create(); } /** * Creates HTTP/2 {@link CloseableHttpAsyncClient} instance with default configuration * optimized for HTTP/2 protocol and message multiplexing. */ public static CloseableHttpAsyncClient createHttp2Default() { return H2AsyncClientBuilder.create().build(); } /** * Creates HTTP/2 {@link CloseableHttpAsyncClient} instance with default configuration and * system properties optimized for HTTP/2 protocol and message multiplexing. */ public static CloseableHttpAsyncClient createHttp2System() { return H2AsyncClientBuilder.create().useSystemProperties().build(); } private static HttpProcessor createMinimalProtocolProcessor() { return new DefaultHttpProcessor( new H2RequestTargetHost(), new H2RequestContent(), new H2RequestConnControl(), new RequestUserAgent(VersionInfo.getSoftwareInfo( "Apache-HttpAsyncClient", "org.apache.hc.client5", HttpAsyncClients.class))); } private static MinimalHttpAsyncClient createMinimalHttpAsyncClientImpl( final IOEventHandlerFactory eventHandlerFactory, final AsyncPushConsumerRegistry pushConsumerRegistry, final IOReactorConfig ioReactorConfig, final AsyncClientConnectionManager connmgr, final SchemePortResolver schemePortResolver, final TlsConfig tlsConfig) { return new MinimalHttpAsyncClient( eventHandlerFactory, pushConsumerRegistry, ioReactorConfig, new DefaultThreadFactory("httpclient-main", true), new DefaultThreadFactory("httpclient-dispatch", true), connmgr, schemePortResolver, tlsConfig); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. * * @deprecated Use {@link #createMinimal(H2Config, Http1Config, IOReactorConfig, AsyncClientConnectionManager)} */ @Deprecated public static MinimalHttpAsyncClient createMinimal( final HttpVersionPolicy versionPolicy, final H2Config h2Config, final Http1Config h1Config, final IOReactorConfig ioReactorConfig, final AsyncClientConnectionManager connmgr) { final AsyncPushConsumerRegistry pushConsumerRegistry = new AsyncPushConsumerRegistry(); return createMinimalHttpAsyncClientImpl( new HttpAsyncClientProtocolNegotiationStarter( createMinimalProtocolProcessor(), (request, context) -> pushConsumerRegistry.get(request), h2Config, h1Config, CharCodingConfig.DEFAULT, DefaultClientConnectionReuseStrategy.INSTANCE, LoggingExceptionCallback.INSTANCE), pushConsumerRegistry, ioReactorConfig, connmgr, DefaultSchemePortResolver.INSTANCE, versionPolicy != null ? TlsConfig.custom().setVersionPolicy(versionPolicy).build() : null); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. * * @since 5.2 */ public static MinimalHttpAsyncClient createMinimal( final H2Config h2Config, final Http1Config h1Config, final IOReactorConfig ioReactorConfig, final AsyncClientConnectionManager connmgr) { final AsyncPushConsumerRegistry pushConsumerRegistry = new AsyncPushConsumerRegistry(); return createMinimalHttpAsyncClientImpl( new HttpAsyncClientProtocolNegotiationStarter( createMinimalProtocolProcessor(), (request, context) -> pushConsumerRegistry.get(request), h2Config, h1Config, CharCodingConfig.DEFAULT, DefaultClientConnectionReuseStrategy.INSTANCE, LoggingExceptionCallback.INSTANCE), pushConsumerRegistry, ioReactorConfig, connmgr, DefaultSchemePortResolver.INSTANCE, null); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. * * @deprecated Use {@link #createMinimal(H2Config, Http1Config, IOReactorConfig)} */ @Deprecated public static MinimalHttpAsyncClient createMinimal( final HttpVersionPolicy versionPolicy, final H2Config h2Config, final Http1Config h1Config, final IOReactorConfig ioReactorConfig) { return createMinimal(versionPolicy, h2Config, h1Config, ioReactorConfig, PoolingAsyncClientConnectionManagerBuilder.create().build()); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. */ public static MinimalHttpAsyncClient createMinimal( final H2Config h2Config, final Http1Config h1Config, final IOReactorConfig ioReactorConfig) { return createMinimal(h2Config, h1Config, ioReactorConfig, PoolingAsyncClientConnectionManagerBuilder.create().build()); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. */ public static MinimalHttpAsyncClient createMinimal(final H2Config h2Config, final Http1Config h1Config) { return createMinimal(HttpVersionPolicy.NEGOTIATE, h2Config, h1Config, IOReactorConfig.DEFAULT); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. */ public static MinimalHttpAsyncClient createMinimal() { return createMinimal(H2Config.DEFAULT, Http1Config.DEFAULT); } /** * Creates {@link MinimalHttpAsyncClient} instance optimized for * HTTP/1.1 and HTTP/2 message transport without advanced HTTP protocol * functionality. */ public static MinimalHttpAsyncClient createMinimal(final AsyncClientConnectionManager connManager) { return createMinimal( HttpVersionPolicy.NEGOTIATE, H2Config.DEFAULT, Http1Config.DEFAULT, IOReactorConfig.DEFAULT, connManager); } private static MinimalH2AsyncClient createMinimalHttp2AsyncClientImpl( final IOEventHandlerFactory eventHandlerFactory, final AsyncPushConsumerRegistry pushConsumerRegistry, final IOReactorConfig ioReactorConfig, final DnsResolver dnsResolver, final TlsStrategy tlsStrategy) { return new MinimalH2AsyncClient( eventHandlerFactory, pushConsumerRegistry, ioReactorConfig, new DefaultThreadFactory("httpclient-main", true), new DefaultThreadFactory("httpclient-dispatch", true), dnsResolver, tlsStrategy); } /** * Creates {@link MinimalH2AsyncClient} instance optimized for HTTP/2 multiplexing message * transport without advanced HTTP protocol functionality. */ public static MinimalH2AsyncClient createHttp2Minimal( final H2Config h2Config, final IOReactorConfig ioReactorConfig, final DnsResolver dnsResolver, final TlsStrategy tlsStrategy) { final AsyncPushConsumerRegistry pushConsumerRegistry = new AsyncPushConsumerRegistry(); return createMinimalHttp2AsyncClientImpl( new H2AsyncClientProtocolStarter( createMinimalProtocolProcessor(), (request, context) -> pushConsumerRegistry.get(request), h2Config, CharCodingConfig.DEFAULT, LoggingExceptionCallback.INSTANCE), pushConsumerRegistry, ioReactorConfig, dnsResolver, tlsStrategy); } /** * Creates {@link MinimalH2AsyncClient} instance optimized for HTTP/2 multiplexing message * transport without advanced HTTP protocol functionality. */ public static MinimalH2AsyncClient createHttp2Minimal( final H2Config h2Config, final IOReactorConfig ioReactorConfig, final TlsStrategy tlsStrategy) { return createHttp2Minimal(h2Config, ioReactorConfig, SystemDefaultDnsResolver.INSTANCE, tlsStrategy); } /** * Creates {@link MinimalH2AsyncClient} instance optimized for HTTP/2 multiplexing message * transport without advanced HTTP protocol functionality. */ public static MinimalH2AsyncClient createHttp2Minimal( final H2Config h2Config, final IOReactorConfig ioReactorConfig) { return createHttp2Minimal(h2Config, ioReactorConfig, DefaultClientTlsStrategy.createDefault()); } /** * Creates {@link MinimalH2AsyncClient} instance optimized for HTTP/2 multiplexing message * transport without advanced HTTP protocol functionality. */ public static MinimalH2AsyncClient createHttp2Minimal(final H2Config h2Config) { return createHttp2Minimal(h2Config, IOReactorConfig.DEFAULT); } /** * Creates {@link MinimalH2AsyncClient} instance optimized for HTTP/2 multiplexing message * transport without advanced HTTP protocol functionality. */ public static MinimalH2AsyncClient createHttp2Minimal() { return createHttp2Minimal(H2Config.DEFAULT); } /** * Creates {@link HandlerFactory} backed by a push {@link RequestRouter}. * * @since 5.4 */ public static HandlerFactory pushRouter(final RequestRouter> requestRouter) { return (request, context) -> { final Supplier supplier = requestRouter.resolve(request, context); return supplier != null ? supplier.get() : null; }; } /** * Creates an {@link CloseableHttpClient} facade backed by {@link CloseableHttpAsyncClient} * built internally and acting as a compatibility bridge between the classic APIs based * on the standard {@link java.io.InputStream} / {@link java.io.OutputStream} model * and the underlying asynchronous message transport. *

* This feature is considered experimental and may be discontinued in the future. * * @param client async client * @param operationTimeout maximum period an operation can block awaiting input / output. * * @since 5.5 */ @Experimental public static CloseableHttpClient classic(final CloseableHttpAsyncClient client, final Timeout operationTimeout) { client.start(); return new ClassicToAsyncAdaptor(client, operationTimeout); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LoggingIOSessionDecorator.java0100664 0000000 0000000 00000004111 14704162040 031373 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import org.apache.hc.core5.function.Decorator; import org.apache.hc.core5.reactor.IOSession; import org.slf4j.Logger; import org.slf4j.LoggerFactory; final class LoggingIOSessionDecorator implements Decorator { /** * Singleton instance of LoggingIOSessionDecorator. */ public final static LoggingIOSessionDecorator INSTANCE = new LoggingIOSessionDecorator(); private static final Logger WIRE_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.wire"); private LoggingIOSessionDecorator() { } @Override public IOSession decorate(final IOSession ioSession) { final Logger sessionLog = LoggerFactory.getLogger(ioSession.getClass()); if (sessionLog.isDebugEnabled() || WIRE_LOG.isDebugEnabled()) { return new LoggingIOSession(ioSession, sessionLog, WIRE_LOG); } return ioSession; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/H2AsyncClientProtocolStarter.java0100664 0000000 0000000 00000021566 15005672035 032065 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.util.List; import org.apache.hc.core5.function.Callback; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.http2.frame.FramePrinter; import org.apache.hc.core5.http2.frame.RawFrame; import org.apache.hc.core5.http2.impl.nio.ClientH2PrefaceHandler; import org.apache.hc.core5.http2.impl.nio.ClientH2StreamMultiplexerFactory; import org.apache.hc.core5.http2.impl.nio.H2StreamListener; import org.apache.hc.core5.reactor.IOEventHandler; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.ProtocolIOSession; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; class H2AsyncClientProtocolStarter implements IOEventHandlerFactory { private static final Logger HEADER_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.headers"); private static final Logger FRAME_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.frame"); private static final Logger FRAME_PAYLOAD_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.frame.payload"); private static final Logger FLOW_CTRL_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.flow"); private final HttpProcessor httpProcessor; private final HandlerFactory exchangeHandlerFactory; private final H2Config h2Config; private final CharCodingConfig charCodingConfig; private final Callback exceptionCallback; H2AsyncClientProtocolStarter( final HttpProcessor httpProcessor, final HandlerFactory exchangeHandlerFactory, final H2Config h2Config, final CharCodingConfig charCodingConfig, final Callback exceptionCallback) { this.httpProcessor = Args.notNull(httpProcessor, "HTTP processor"); this.exchangeHandlerFactory = exchangeHandlerFactory; this.h2Config = h2Config != null ? h2Config : H2Config.DEFAULT; this.charCodingConfig = charCodingConfig != null ? charCodingConfig : CharCodingConfig.DEFAULT; this.exceptionCallback = exceptionCallback; } @Override public IOEventHandler createHandler(final ProtocolIOSession ioSession, final Object attachment) { if (HEADER_LOG.isDebugEnabled() || FRAME_LOG.isDebugEnabled() || FRAME_PAYLOAD_LOG.isDebugEnabled() || FLOW_CTRL_LOG.isDebugEnabled()) { final String id = ioSession.getId(); final ClientH2StreamMultiplexerFactory http2StreamHandlerFactory = new ClientH2StreamMultiplexerFactory( httpProcessor, exchangeHandlerFactory, h2Config, charCodingConfig, new H2StreamListener() { final FramePrinter framePrinter = new FramePrinter(); private void logFrameInfo(final String prefix, final RawFrame frame) { try { final LogAppendable logAppendable = new LogAppendable(FRAME_LOG, prefix); framePrinter.printFrameInfo(frame, logAppendable); logAppendable.flush(); } catch (final IOException ignore) { } } private void logFramePayload(final String prefix, final RawFrame frame) { try { final LogAppendable logAppendable = new LogAppendable(FRAME_PAYLOAD_LOG, prefix); framePrinter.printPayload(frame, logAppendable); logAppendable.flush(); } catch (final IOException ignore) { } } private void logFlowControl(final String prefix, final int streamId, final int delta, final int actualSize) { FLOW_CTRL_LOG.debug("{} stream {} flow control {} -> {}", prefix, streamId, delta, actualSize); } @Override public void onHeaderInput(final HttpConnection connection, final int streamId, final List headers) { if (HEADER_LOG.isDebugEnabled()) { for (int i = 0; i < headers.size(); i++) { HEADER_LOG.debug("{} << {}", id, headers.get(i)); } } } @Override public void onHeaderOutput(final HttpConnection connection, final int streamId, final List headers) { if (HEADER_LOG.isDebugEnabled()) { for (int i = 0; i < headers.size(); i++) { HEADER_LOG.debug("{} >> {}", id, headers.get(i)); } } } @Override public void onFrameInput(final HttpConnection connection, final int streamId, final RawFrame frame) { if (FRAME_LOG.isDebugEnabled()) { logFrameInfo(id + " <<", frame); } if (FRAME_PAYLOAD_LOG.isDebugEnabled()) { logFramePayload(id + " <<", frame); } } @Override public void onFrameOutput(final HttpConnection connection, final int streamId, final RawFrame frame) { if (FRAME_LOG.isDebugEnabled()) { logFrameInfo(id + " >>", frame); } if (FRAME_PAYLOAD_LOG.isDebugEnabled()) { logFramePayload(id + " >>", frame); } } @Override public void onInputFlowControl(final HttpConnection connection, final int streamId, final int delta, final int actualSize) { if (FLOW_CTRL_LOG.isDebugEnabled()) { logFlowControl(id + " <<", streamId, delta, actualSize); } } @Override public void onOutputFlowControl(final HttpConnection connection, final int streamId, final int delta, final int actualSize) { if (FLOW_CTRL_LOG.isDebugEnabled()) { logFlowControl(id + " >>", streamId, delta, actualSize); } } }); return new ClientH2PrefaceHandler(ioSession, http2StreamHandlerFactory, false, exceptionCallback); } final ClientH2StreamMultiplexerFactory http2StreamHandlerFactory = new ClientH2StreamMultiplexerFactory( httpProcessor, exchangeHandlerFactory, h2Config, charCodingConfig, null); return new ClientH2PrefaceHandler(ioSession, http2StreamHandlerFactory, false, exceptionCallback); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/H2AsyncClientBuilder.java0100664 0000000 0000000 00000111335 15063503632 030277 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.Closeable; import java.io.IOException; import java.security.AccessController; import java.security.PrivilegedAction; import java.util.ArrayList; import java.util.Collection; import java.util.LinkedList; import java.util.List; import java.util.concurrent.ThreadFactory; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.CookieSpecSupport; import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy; import org.apache.hc.client5.http.impl.DefaultHttpRequestRetryStrategy; import org.apache.hc.client5.http.impl.DefaultRedirectStrategy; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory; import org.apache.hc.client5.http.impl.auth.BearerSchemeFactory; import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory; import org.apache.hc.client5.http.impl.auth.SystemDefaultCredentialsProvider; import org.apache.hc.client5.http.impl.nio.MultihomeConnectionInitiator; import org.apache.hc.client5.http.impl.routing.DefaultRoutePlanner; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.protocol.RequestAddCookies; import org.apache.hc.client5.http.protocol.RequestDefaultHeaders; import org.apache.hc.client5.http.protocol.RequestExpectContinue; import org.apache.hc.client5.http.protocol.ResponseProcessCookies; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.DefaultThreadFactory; import org.apache.hc.core5.function.Callback; import org.apache.hc.core5.function.Decorator; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.NamedElementChain; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.nio.command.ShutdownCommand; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessorBuilder; import org.apache.hc.core5.http.protocol.RequestTargetHost; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.http2.protocol.H2RequestConnControl; import org.apache.hc.core5.http2.protocol.H2RequestContent; import org.apache.hc.core5.http2.protocol.H2RequestTargetHost; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.reactor.IOSessionListener; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.VersionInfo; /** * Builder for HTTP/2 only {@link CloseableHttpAsyncClient} instances. *

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

*

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

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

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

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

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

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

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

*

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

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

* For internal use. *

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

* For internal use. *

*/ @Internal protected void addCloseable(final Closeable closeable) { if (closeable == null) { return; } if (closeables == null) { closeables = new ArrayList<>(); } closeables.add(closeable); } public CloseableHttpAsyncClient build() { AuthenticationStrategy targetAuthStrategyCopy = this.targetAuthStrategy; if (targetAuthStrategyCopy == null) { targetAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } AuthenticationStrategy proxyAuthStrategyCopy = this.proxyAuthStrategy; if (proxyAuthStrategyCopy == null) { proxyAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } String userAgentCopy = this.userAgent; if (userAgentCopy == null) { if (systemProperties) { userAgentCopy = getProperty("http.agent", null); } if (userAgentCopy == null) { userAgentCopy = VersionInfo.getSoftwareInfo("Apache-HttpAsyncClient", "org.apache.hc.client5", getClass()); } } final HttpProcessorBuilder b = HttpProcessorBuilder.create(); if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } b.addAll( new H2RequestTargetHost(), new RequestDefaultHeaders(defaultHeaders), new RequestUserAgent(userAgentCopy), new RequestExpectContinue(), new H2RequestContent(), new H2RequestConnControl()); if (!cookieManagementDisabled) { b.add(RequestAddCookies.INSTANCE); } if (!cookieManagementDisabled) { b.add(ResponseProcessCookies.INSTANCE); } if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } final HttpProcessor httpProcessor = b.build(); final NamedElementChain execChainDefinition = new NamedElementChain<>(); execChainDefinition.addLast( new H2AsyncMainClientExec(httpProcessor), ChainElement.MAIN_TRANSPORT.name()); execChainDefinition.addFirst( new AsyncConnectExec( new DefaultHttpProcessor(new RequestTargetHost(), new RequestUserAgent(userAgentCopy)), proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.CONNECT.name()); execChainDefinition.addFirst( new AsyncProtocolExec( targetAuthStrategyCopy, proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.PROTOCOL.name()); // Add request retry executor, if not disabled if (!automaticRetriesDisabled) { HttpRequestRetryStrategy retryStrategyCopy = this.retryStrategy; if (retryStrategyCopy == null) { retryStrategyCopy = DefaultHttpRequestRetryStrategy.INSTANCE; } execChainDefinition.addFirst( new AsyncHttpRequestRetryExec(retryStrategyCopy), ChainElement.RETRY.name()); } HttpRoutePlanner routePlannerCopy = this.routePlanner; if (routePlannerCopy == null) { SchemePortResolver schemePortResolverCopy = this.schemePortResolver; if (schemePortResolverCopy == null) { schemePortResolverCopy = DefaultSchemePortResolver.INSTANCE; } routePlannerCopy = new DefaultRoutePlanner(schemePortResolverCopy); } // Add redirect executor, if not disabled if (!redirectHandlingDisabled) { RedirectStrategy redirectStrategyCopy = this.redirectStrategy; if (redirectStrategyCopy == null) { redirectStrategyCopy = schemePortResolver != null ? new DefaultRedirectStrategy(schemePortResolver) : DefaultRedirectStrategy.INSTANCE; } execChainDefinition.addFirst( new AsyncRedirectExec(routePlannerCopy, redirectStrategyCopy), ChainElement.REDIRECT.name()); } final AsyncPushConsumerRegistry pushConsumerRegistry = new AsyncPushConsumerRegistry(); final IOEventHandlerFactory ioEventHandlerFactory = new H2AsyncClientProtocolStarter( HttpProcessorBuilder.create().build(), (request, context) -> pushConsumerRegistry.get(request), h2Config != null ? h2Config : H2Config.DEFAULT, charCodingConfig != null ? charCodingConfig : CharCodingConfig.DEFAULT, ioReactorExceptionCallback != null ? ioReactorExceptionCallback : LoggingExceptionCallback.INSTANCE); final DefaultConnectingIOReactor ioReactor = new DefaultConnectingIOReactor( ioEventHandlerFactory, ioReactorConfig != null ? ioReactorConfig : IOReactorConfig.DEFAULT, threadFactory != null ? threadFactory : new DefaultThreadFactory("httpclient-dispatch", true), ioSessionDecorator != null ? ioSessionDecorator : LoggingIOSessionDecorator.INSTANCE, ioReactorExceptionCallback != null ? ioReactorExceptionCallback : LoggingExceptionCallback.INSTANCE, ioSessionListener, ioSession -> ioSession.enqueue(new ShutdownCommand(CloseMode.GRACEFUL), Command.Priority.IMMEDIATE)); if (execInterceptors != null) { for (final ExecInterceptorEntry entry: execInterceptors) { switch (entry.position) { case AFTER: execChainDefinition.addAfter(entry.existing, entry.interceptor, entry.name); break; case BEFORE: execChainDefinition.addBefore(entry.existing, entry.interceptor, entry.name); break; case REPLACE: execChainDefinition.replace(entry.existing, entry.interceptor); break; case FIRST: execChainDefinition.addFirst(entry.interceptor, entry.name); break; case LAST: // Don't add last, after H2AsyncMainClientExec, as that does not delegate to the chain // Instead, add the interceptor just before it, making it effectively the last interceptor execChainDefinition.addBefore(ChainElement.MAIN_TRANSPORT.name(), entry.interceptor, entry.name); break; } } } customizeExecChain(execChainDefinition); NamedElementChain.Node current = execChainDefinition.getLast(); AsyncExecChainElement execChain = null; while (current != null) { execChain = new AsyncExecChainElement(current.getValue(), execChain); current = current.getPrevious(); } Lookup authSchemeRegistryCopy = this.authSchemeRegistry; if (authSchemeRegistryCopy == null) { authSchemeRegistryCopy = RegistryBuilder.create() .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE) .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE) .register(StandardAuthScheme.BEARER, BearerSchemeFactory.INSTANCE) .build(); } Lookup cookieSpecRegistryCopy = this.cookieSpecRegistry; if (cookieSpecRegistryCopy == null) { cookieSpecRegistryCopy = CookieSpecSupport.createDefault(); } CookieStore cookieStoreCopy = this.cookieStore; if (cookieStoreCopy == null) { cookieStoreCopy = new BasicCookieStore(); } CredentialsProvider credentialsProviderCopy = this.credentialsProvider; if (credentialsProviderCopy == null) { if (systemProperties) { credentialsProviderCopy = new SystemDefaultCredentialsProvider(); } else { credentialsProviderCopy = new BasicCredentialsProvider(); } } TlsStrategy tlsStrategyCopy = this.tlsStrategy; if (tlsStrategyCopy == null) { if (systemProperties) { tlsStrategyCopy = DefaultClientTlsStrategy.createSystemDefault(); } else { tlsStrategyCopy = DefaultClientTlsStrategy.createDefault(); } } final MultihomeConnectionInitiator connectionInitiator = new MultihomeConnectionInitiator(ioReactor, dnsResolver); final InternalH2ConnPool connPool = new InternalH2ConnPool(connectionInitiator, host -> null, tlsStrategyCopy); connPool.setConnectionConfigResolver(connectionConfigResolver); List closeablesCopy = closeables != null ? new ArrayList<>(closeables) : null; if (closeablesCopy == null) { closeablesCopy = new ArrayList<>(1); } if (evictIdleConnections) { final IdleConnectionEvictor connectionEvictor = new IdleConnectionEvictor(connPool, maxIdleTime != null ? maxIdleTime : TimeValue.ofSeconds(30L)); closeablesCopy.add(connectionEvictor::shutdown); connectionEvictor.start(); } closeablesCopy.add(connPool); return new InternalH2AsyncClient( ioReactor, execChain, pushConsumerRegistry, threadFactory != null ? threadFactory : new DefaultThreadFactory("httpclient-main", true), connPool, routePlannerCopy, cookieSpecRegistryCopy, authSchemeRegistryCopy, cookieStoreCopy, credentialsProviderCopy, defaultRequestConfig, closeablesCopy); } private static String getProperty(final String key, final String defaultValue) { return AccessController.doPrivileged((PrivilegedAction) () -> System.getProperty(key, defaultValue)); } static class IdleConnectionEvictor implements Closeable { private final Thread thread; public IdleConnectionEvictor(final InternalH2ConnPool connPool, final TimeValue maxIdleTime) { this.thread = new DefaultThreadFactory("idle-connection-evictor", true).newThread(() -> { try { while (!Thread.currentThread().isInterrupted()) { maxIdleTime.sleep(); connPool.closeIdle(maxIdleTime); } } catch (final InterruptedException ex) { Thread.currentThread().interrupt(); } catch (final Exception ignore) { } }); } public void start() { thread.start(); } public void shutdown() { thread.interrupt(); } @Override public void close() throws IOException { shutdown(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalH2ConnPool.java0100664 0000000 0000000 00000022334 14704162040 027773 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.net.InetSocketAddress; import java.util.concurrent.Future; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.core5.concurrent.CallbackContribution; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Callback; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.nio.command.ShutdownCommand; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http2.nio.command.PingCommand; import org.apache.hc.core5.http2.nio.support.BasicPingHandler; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.AbstractIOSessionPool; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; class InternalH2ConnPool implements ModalCloseable { private final SessionPool sessionPool; private volatile Resolver connectionConfigResolver; InternalH2ConnPool(final ConnectionInitiator connectionInitiator, final Resolver addressResolver, final TlsStrategy tlsStrategy) { this.sessionPool = new SessionPool(connectionInitiator, addressResolver, tlsStrategy); } @Override public void close(final CloseMode closeMode) { sessionPool.close(closeMode); } @Override public void close() { sessionPool.close(); } private ConnectionConfig resolveConnectionConfig(final HttpHost httpHost) { final Resolver resolver = this.connectionConfigResolver; final ConnectionConfig connectionConfig = resolver != null ? resolver.resolve(httpHost) : null; return connectionConfig != null ? connectionConfig : ConnectionConfig.DEFAULT; } public Future getSession( final HttpRoute route, final Timeout connectTimeout, final FutureCallback callback) { final ConnectionConfig connectionConfig = resolveConnectionConfig(route.getTargetHost()); return sessionPool.getSession( route, connectTimeout != null ? connectTimeout : connectionConfig.getConnectTimeout(), new CallbackContribution(callback) { @Override public void completed(final IOSession ioSession) { final Timeout socketTimeout = connectionConfig.getSocketTimeout(); if (socketTimeout != null) { ioSession.setSocketTimeout(socketTimeout); } callback.completed(ioSession); } }); } public void closeIdle(final TimeValue idleTime) { sessionPool.closeIdle(idleTime); } public void setConnectionConfigResolver(final Resolver connectionConfigResolver) { this.connectionConfigResolver = connectionConfigResolver; } public TimeValue getValidateAfterInactivity() { return sessionPool.validateAfterInactivity; } public void setValidateAfterInactivity(final TimeValue timeValue) { sessionPool.validateAfterInactivity = timeValue; } static class SessionPool extends AbstractIOSessionPool { private final ConnectionInitiator connectionInitiator; private final Resolver addressResolver; private final TlsStrategy tlsStrategy; private volatile TimeValue validateAfterInactivity = TimeValue.NEG_ONE_MILLISECOND; SessionPool(final ConnectionInitiator connectionInitiator, final Resolver addressResolver, final TlsStrategy tlsStrategy) { this.connectionInitiator = connectionInitiator; this.addressResolver = addressResolver; this.tlsStrategy = tlsStrategy; } @Override protected Future connectSession(final HttpRoute route, final Timeout connectTimeout, final FutureCallback callback) { final HttpHost target = route.getTargetHost(); final InetSocketAddress localAddress = route.getLocalSocketAddress(); final InetSocketAddress remoteAddress = addressResolver.resolve(target); return connectionInitiator.connect( target, remoteAddress, localAddress, connectTimeout, null, new CallbackContribution(callback) { @Override public void completed(final IOSession ioSession) { if (tlsStrategy != null && URIScheme.HTTPS.same(target.getSchemeName()) && ioSession instanceof TransportSecurityLayer) { final NamedEndpoint tlsName = route.getTargetName() != null ? route.getTargetName() : target; tlsStrategy.upgrade( (TransportSecurityLayer) ioSession, tlsName, null, connectTimeout, new CallbackContribution(callback) { @Override public void completed(final TransportSecurityLayer transportSecurityLayer) { callback.completed(ioSession); } }); ioSession.setSocketTimeout(connectTimeout); } else { callback.completed(ioSession); } } }); } @Override protected void validateSession(final IOSession ioSession, final Callback callback) { if (ioSession.isOpen()) { final TimeValue timeValue = validateAfterInactivity; if (TimeValue.isNonNegative(timeValue)) { final long lastAccessTime = Math.min(ioSession.getLastReadTime(), ioSession.getLastWriteTime()); final long deadline = lastAccessTime + timeValue.toMilliseconds(); if (deadline <= System.currentTimeMillis()) { final Timeout socketTimeoutMillis = ioSession.getSocketTimeout(); ioSession.enqueue(new PingCommand(new BasicPingHandler(result -> { ioSession.setSocketTimeout(socketTimeoutMillis); callback.execute(result); })), Command.Priority.NORMAL); return; } } callback.execute(true); } else { callback.execute(false); } } @Override protected void closeSession(final IOSession ioSession, final CloseMode closeMode) { if (closeMode == CloseMode.GRACEFUL) { ioSession.enqueue(ShutdownCommand.GRACEFUL, Command.Priority.NORMAL); } else { ioSession.close(closeMode); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalH2AsyncExecRuntime.java0100664 0000000 0000000 00000027452 14740021403 031475 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.InterruptedIOException; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.Operations; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexCancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.command.RequestExecutionCommand; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer; import org.apache.hc.core5.util.Identifiable; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; class InternalH2AsyncExecRuntime implements AsyncExecRuntime { private final Logger log; private final InternalH2ConnPool connPool; private final HandlerFactory pushHandlerFactory; private final AtomicReference sessionRef; private volatile boolean reusable; InternalH2AsyncExecRuntime( final Logger log, final InternalH2ConnPool connPool, final HandlerFactory pushHandlerFactory) { super(); this.log = log; this.connPool = connPool; this.pushHandlerFactory = pushHandlerFactory; this.sessionRef = new AtomicReference<>(); } @Override public boolean isEndpointAcquired() { return sessionRef.get() != null; } @Override public Cancellable acquireEndpoint( final String id, final HttpRoute route, final Object object, final HttpClientContext context, final FutureCallback callback) { if (sessionRef.get() == null) { final RequestConfig requestConfig = context.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); if (log.isDebugEnabled()) { log.debug("{} acquiring endpoint ({})", id, connectTimeout); } return Operations.cancellable(connPool.getSession(route, connectTimeout, new FutureCallback() { @Override public void completed(final IOSession ioSession) { sessionRef.set(new Endpoint(route, ioSession)); reusable = true; if (log.isDebugEnabled()) { log.debug("{} acquired endpoint", id); } callback.completed(InternalH2AsyncExecRuntime.this); } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } })); } callback.completed(this); return Operations.nonCancellable(); } private void closeEndpoint(final Endpoint endpoint) { endpoint.session.close(CloseMode.GRACEFUL); if (log.isDebugEnabled()) { log.debug("{} endpoint closed", ConnPoolSupport.getId(endpoint)); } } @Override public void releaseEndpoint() { final Endpoint endpoint = sessionRef.getAndSet(null); if (endpoint != null && !reusable) { closeEndpoint(endpoint); } } @Override public void discardEndpoint() { final Endpoint endpoint = sessionRef.getAndSet(null); if (endpoint != null) { closeEndpoint(endpoint); } } @Override public boolean validateConnection() { if (reusable) { final Endpoint endpoint = sessionRef.get(); return endpoint != null && endpoint.session.isOpen(); } final Endpoint endpoint = sessionRef.getAndSet(null); if (endpoint != null) { closeEndpoint(endpoint); } return false; } @Override public boolean isEndpointConnected() { final Endpoint endpoint = sessionRef.get(); return endpoint != null && endpoint.session.isOpen(); } Endpoint ensureValid() { final Endpoint endpoint = sessionRef.get(); if (endpoint == null) { throw new IllegalStateException("I/O session not acquired / already released"); } return endpoint; } @Override public Cancellable connectEndpoint( final HttpClientContext context, final FutureCallback callback) { final Endpoint endpoint = ensureValid(); if (endpoint.session.isOpen()) { callback.completed(this); return Operations.nonCancellable(); } final HttpRoute route = endpoint.route; final RequestConfig requestConfig = context.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); if (log.isDebugEnabled()) { log.debug("{} connecting endpoint ({})", ConnPoolSupport.getId(endpoint), connectTimeout); } return Operations.cancellable(connPool.getSession(route, connectTimeout, new FutureCallback() { @Override public void completed(final IOSession ioSession) { sessionRef.set(new Endpoint(route, ioSession)); reusable = true; if (log.isDebugEnabled()) { log.debug("{} endpoint connected", ConnPoolSupport.getId(endpoint)); } callback.completed(InternalH2AsyncExecRuntime.this); } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } })); } @Override public void disconnectEndpoint() { final Endpoint endpoint = sessionRef.get(); if (endpoint != null) { endpoint.session.close(CloseMode.GRACEFUL); } } @Override public void upgradeTls(final HttpClientContext context) { throw new UnsupportedOperationException(); } @Override public void upgradeTls(final HttpClientContext context, final FutureCallback callback) { throw new UnsupportedOperationException(); } @Override public EndpointInfo getEndpointInfo() { final Endpoint endpoint = sessionRef.get(); if (endpoint != null && endpoint.session.isOpen()) { if (endpoint.session instanceof TransportSecurityLayer) { final TlsDetails tlsDetails = ((TransportSecurityLayer) endpoint.session).getTlsDetails(); return new EndpointInfo(HttpVersion.HTTP_2, tlsDetails != null ? tlsDetails.getSSLSession() : null); } } return null; } @Override public Cancellable execute( final String id, final AsyncClientExchangeHandler exchangeHandler, final HttpClientContext context) { final ComplexCancellable complexCancellable = new ComplexCancellable(); final Endpoint endpoint = ensureValid(); final IOSession session = endpoint.session; if (session.isOpen()) { if (log.isDebugEnabled()) { log.debug("{} start execution {}", ConnPoolSupport.getId(endpoint), id); } context.setProtocolVersion(HttpVersion.HTTP_2); session.enqueue( new RequestExecutionCommand(exchangeHandler, pushHandlerFactory, complexCancellable, context), Command.Priority.NORMAL); } else { final HttpRoute route = endpoint.route; final RequestConfig requestConfig = context.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); connPool.getSession(route, connectTimeout, new FutureCallback() { @Override public void completed(final IOSession ioSession) { sessionRef.set(new Endpoint(route, ioSession)); reusable = true; if (log.isDebugEnabled()) { log.debug("{} start execution {}", ConnPoolSupport.getId(endpoint), id); } context.setProtocolVersion(HttpVersion.HTTP_2); session.enqueue( new RequestExecutionCommand(exchangeHandler, pushHandlerFactory, complexCancellable, context), Command.Priority.NORMAL); } @Override public void failed(final Exception ex) { exchangeHandler.failed(ex); } @Override public void cancelled() { exchangeHandler.failed(new InterruptedIOException()); } }); } return complexCancellable; } @Override public void markConnectionReusable(final Object newState, final TimeValue newValidDuration) { throw new UnsupportedOperationException(); } @Override public void markConnectionNonReusable() { reusable = false; } static class Endpoint implements Identifiable { final HttpRoute route; final IOSession session; Endpoint(final HttpRoute route, final IOSession session) { this.route = route; this.session = session; } @Override public String getId() { return session.getId(); } } @Override public AsyncExecRuntime fork() { return new InternalH2AsyncExecRuntime(log, connPool, pushHandlerFactory); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalHttpAsyncClient.java0100664 0000000 0000000 00000011646 14704162040 031132 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.Closeable; import java.util.List; import java.util.concurrent.ThreadFactory; import java.util.function.Function; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Internal implementation of {@link CloseableHttpAsyncClient} that can negotiate * the most optimal HTTP protocol version during during the {@code TLS} handshake * with {@code ALPN} extension if supported by the Java runtime. *

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

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) @Internal public final class InternalHttpAsyncClient extends InternalAbstractHttpAsyncClient { private static final Logger LOG = LoggerFactory.getLogger(InternalHttpAsyncClient.class); private final AsyncClientConnectionManager manager; private final HttpRoutePlanner routePlanner; private final TlsConfig tlsConfig; InternalHttpAsyncClient( final DefaultConnectingIOReactor ioReactor, final AsyncExecChainElement execChain, final AsyncPushConsumerRegistry pushConsumerRegistry, final ThreadFactory threadFactory, final AsyncClientConnectionManager manager, final HttpRoutePlanner routePlanner, final TlsConfig tlsConfig, final Lookup cookieSpecRegistry, final Lookup authSchemeRegistry, final CookieStore cookieStore, final CredentialsProvider credentialsProvider, final Function contextAdaptor, final RequestConfig defaultConfig, final List closeables) { super(ioReactor, pushConsumerRegistry, threadFactory, execChain, cookieSpecRegistry, authSchemeRegistry, cookieStore, credentialsProvider, contextAdaptor, defaultConfig, closeables); this.manager = manager; this.routePlanner = routePlanner; this.tlsConfig = tlsConfig; } @Override AsyncExecRuntime createAsyncExecRuntime(final HandlerFactory pushHandlerFactory) { return new InternalHttpAsyncExecRuntime(LOG, manager, getConnectionInitiator(), pushHandlerFactory, tlsConfig); } @Override HttpRoute determineRoute(final HttpHost httpHost, final HttpRequest request, final HttpClientContext clientContext) throws HttpException { return routePlanner.determineRoute(httpHost, request, clientContext); } } ././@LongLink0100644 0000000 0000000 00000000150 14704162040 011625 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AbstractMinimalHttpAsyncClientBase.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AbstractMinimalHttpAsyncClientBase.j0100664 0000000 0000000 00000007434 14704162040 032533 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.util.concurrent.Future; import java.util.concurrent.ThreadFactory; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.support.BasicClientExchangeHandler; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; abstract class AbstractMinimalHttpAsyncClientBase extends AbstractHttpAsyncClientBase { AbstractMinimalHttpAsyncClientBase( final DefaultConnectingIOReactor ioReactor, final AsyncPushConsumerRegistry pushConsumerRegistry, final ThreadFactory threadFactory) { super(ioReactor, pushConsumerRegistry, threadFactory); } @Override protected Future doExecute( final HttpHost httpHost, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback) { final ComplexFuture future = new ComplexFuture<>(callback); future.setDependency(execute(new BasicClientExchangeHandler<>( requestProducer, responseConsumer, new FutureCallback() { @Override public void completed(final T result) { future.completed(result); } @Override public void failed(final Exception ex) { future.failed(ex); } @Override public void cancelled() { future.cancel(); } }), pushHandlerFactory, context)); return future; } public final Cancellable execute(final AsyncClientExchangeHandler exchangeHandler) { return execute(exchangeHandler, null, null); } public abstract Cancellable execute( AsyncClientExchangeHandler exchangeHandler, HandlerFactory pushHandlerFactory, HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncConnectExec.java0100664 0000000 0000000 00000060300 15005672016 027550 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.io.InterruptedIOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteTracker; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.auth.AuthCacheKeeper; import org.apache.hc.client5.http.impl.auth.AuthenticationHandler; import org.apache.hc.client5.http.impl.routing.BasicRouteDirector; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRouteDirector; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the asynchronous request execution chain * that is responsible for establishing connection to the target * origin server as specified by the current connection route. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class AsyncConnectExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(AsyncConnectExec.class); private final HttpProcessor proxyHttpProcessor; private final AuthenticationStrategy proxyAuthStrategy; private final AuthenticationHandler authenticator; private final AuthCacheKeeper authCacheKeeper; private final HttpRouteDirector routeDirector; public AsyncConnectExec( final HttpProcessor proxyHttpProcessor, final AuthenticationStrategy proxyAuthStrategy, final SchemePortResolver schemePortResolver, final boolean authCachingDisabled) { Args.notNull(proxyHttpProcessor, "Proxy HTTP processor"); Args.notNull(proxyAuthStrategy, "Proxy authentication strategy"); this.proxyHttpProcessor = proxyHttpProcessor; this.proxyAuthStrategy = proxyAuthStrategy; this.authenticator = new AuthenticationHandler(); this.authCacheKeeper = authCachingDisabled ? null : new AuthCacheKeeper(schemePortResolver); this.routeDirector = BasicRouteDirector.INSTANCE; } static class State { State(final HttpRoute route) { tracker = new RouteTracker(route); } final RouteTracker tracker; volatile boolean challenged; volatile HttpResponse response; volatile boolean tunnelRefused; } @Override public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { Args.notNull(request, "HTTP request"); Args.notNull(scope, "Scope"); final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final CancellableDependency cancellableDependency = scope.cancellableDependency; final HttpClientContext clientContext = scope.clientContext; final AsyncExecRuntime execRuntime = scope.execRuntime; final State state = new State(route); if (!execRuntime.isEndpointAcquired()) { final Object userToken = clientContext.getUserToken(); if (LOG.isDebugEnabled()) { LOG.debug("{} acquiring connection with route {}", exchangeId, route); } cancellableDependency.setDependency(execRuntime.acquireEndpoint( exchangeId, route, userToken, clientContext, new FutureCallback() { @Override public void completed(final AsyncExecRuntime execRuntime) { if (execRuntime.isEndpointConnected()) { try { chain.proceed(request, entityProducer, scope, asyncExecCallback); } catch (final HttpException | IOException ex) { asyncExecCallback.failed(ex); } } else { proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); } else { if (execRuntime.isEndpointConnected()) { proceedConnected(request, entityProducer, scope, chain, asyncExecCallback); } else { proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } } } private void proceedToNextHop( final State state, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { try { doProceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } catch (final RuntimeException ex) { asyncExecCallback.failed(ex); } } private void doProceedToNextHop( final State state, final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { final RouteTracker tracker = state.tracker; final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final AsyncExecRuntime execRuntime = scope.execRuntime; final CancellableDependency operation = scope.cancellableDependency; final HttpClientContext clientContext = scope.clientContext; final HttpRoute fact = tracker.toRoute(); final int step = routeDirector.nextStep(route, fact); switch (step) { case HttpRouteDirector.CONNECT_TARGET: operation.setDependency(execRuntime.connectEndpoint(clientContext, new FutureCallback() { @Override public void completed(final AsyncExecRuntime execRuntime) { tracker.connectTarget(route.isSecure()); if (LOG.isDebugEnabled()) { LOG.debug("{} connected to target", exchangeId); } proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); break; case HttpRouteDirector.CONNECT_PROXY: operation.setDependency(execRuntime.connectEndpoint(clientContext, new FutureCallback() { @Override public void completed(final AsyncExecRuntime execRuntime) { final HttpHost proxy = route.getProxyHost(); tracker.connectProxy(proxy, route.isSecure() && !route.isTunnelled()); if (LOG.isDebugEnabled()) { LOG.debug("{} connected to proxy", exchangeId); } proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } })); break; case HttpRouteDirector.TUNNEL_TARGET: final HttpHost proxy = route.getProxyHost(); final HttpHost target = route.getTargetHost(); if (LOG.isDebugEnabled()) { LOG.debug("{} create tunnel", exchangeId); } createTunnel(state, proxy, target, scope, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse(final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse(final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { if (!execRuntime.isEndpointConnected()) { // Remote endpoint disconnected. Need to start over if (LOG.isDebugEnabled()) { LOG.debug("{} proxy disconnected", exchangeId); } state.tracker.reset(); } if (state.challenged) { if (LOG.isDebugEnabled()) { LOG.debug("{} proxy authentication required", exchangeId); } proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } else { if (state.tunnelRefused) { if (LOG.isDebugEnabled()) { LOG.debug("{} tunnel refused", exchangeId); } asyncExecCallback.completed(); } else { if (LOG.isDebugEnabled()) { LOG.debug("{} tunnel to target created", exchangeId); } tracker.tunnelTarget(false); proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } } } @Override public void failed(final Exception cause) { execRuntime.markConnectionNonReusable(); asyncExecCallback.failed(cause); } }); break; case HttpRouteDirector.TUNNEL_PROXY: // The most simple example for this case is a proxy chain // of two proxies, where P1 must be tunnelled to P2. // route: Source -> P1 -> P2 -> Target (3 hops) // fact: Source -> P1 -> Target (2 hops) asyncExecCallback.failed(new HttpException("Proxy chains are not supported")); break; case HttpRouteDirector.LAYER_PROTOCOL: execRuntime.upgradeTls(clientContext, new FutureCallback() { @Override public void completed(final AsyncExecRuntime asyncExecRuntime) { if (LOG.isDebugEnabled()) { LOG.debug("{} upgraded to TLS", exchangeId); } tracker.layerProtocol(route.isSecure()); proceedToNextHop(state, request, entityProducer, scope, chain, asyncExecCallback); } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } }); break; case HttpRouteDirector.UNREACHABLE: asyncExecCallback.failed(new HttpException("Unable to establish route: " + "planned = " + route + "; current = " + fact)); break; case HttpRouteDirector.COMPLETE: if (LOG.isDebugEnabled()) { LOG.debug("{} route fully established", exchangeId); } proceedConnected(request, entityProducer, scope, chain, asyncExecCallback); break; default: throw new IllegalStateException("Unknown step indicator " + step + " from RouteDirector."); } } private void createTunnel( final State state, final HttpHost proxy, final HttpHost nextHop, final AsyncExecChain.Scope scope, final AsyncExecCallback asyncExecCallback) { final CancellableDependency operation = scope.cancellableDependency; final HttpClientContext clientContext = scope.clientContext; final AsyncExecRuntime execRuntime = scope.execRuntime; final String exchangeId = scope.exchangeId; final AuthExchange proxyAuthExchange = proxy != null ? clientContext.getAuthExchange(proxy) : new AuthExchange(); if (authCacheKeeper != null) { authCacheKeeper.loadPreemptively(proxy, null, proxyAuthExchange, clientContext); } final AsyncClientExchangeHandler internalExchangeHandler = new AsyncClientExchangeHandler() { private final AtomicReference entityConsumerRef = new AtomicReference<>(); @Override public void releaseResources() { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } } @Override public void failed(final Exception cause) { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } asyncExecCallback.failed(cause); } @Override public void cancel() { failed(new InterruptedIOException()); } @Override public void produceRequest(final RequestChannel requestChannel, final HttpContext httpContext) throws HttpException, IOException { final HttpRequest connect = new BasicHttpRequest(Method.CONNECT, nextHop, nextHop.toHostString()); connect.setVersion(HttpVersion.HTTP_1_1); proxyHttpProcessor.process(connect, null, clientContext); authenticator.addAuthResponse(proxy, ChallengeType.PROXY, connect, proxyAuthExchange, clientContext); requestChannel.sendRequest(connect, null, clientContext); } @Override public void produce(final DataStreamChannel dataStreamChannel) throws IOException { } @Override public int available() { return 0; } @Override public void consumeInformation(final HttpResponse httpResponse, final HttpContext httpContext) throws HttpException, IOException { } @Override public void consumeResponse(final HttpResponse response, final EntityDetails entityDetails, final HttpContext httpContext) throws HttpException, IOException { clientContext.setResponse(response); proxyHttpProcessor.process(response, entityDetails, clientContext); final int status = response.getCode(); if (status < HttpStatus.SC_SUCCESS) { throw new HttpException("Unexpected response to CONNECT request: " + new StatusLine(response)); } if (needAuthentication(proxyAuthExchange, proxy, response, clientContext)) { state.challenged = true; } else { state.challenged = false; if (status >= HttpStatus.SC_REDIRECTION) { state.tunnelRefused = true; entityConsumerRef.set(asyncExecCallback.handleResponse(response, entityDetails)); } else if (status == HttpStatus.SC_OK) { clientContext.setProtocolVersion(null); asyncExecCallback.completed(); } else { throw new HttpException("Unexpected response to CONNECT request: " + new StatusLine(response)); } } } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.updateCapacity(capacityChannel); } else { capacityChannel.update(Integer.MAX_VALUE); } } @Override public void consume(final ByteBuffer src) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.consume(src); } } @Override public void streamEnd(final List trailers) throws HttpException, IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.streamEnd(trailers); } asyncExecCallback.completed(); } }; if (LOG.isDebugEnabled()) { operation.setDependency(execRuntime.execute( exchangeId, new LoggingAsyncClientExchangeHandler(LOG, exchangeId, internalExchangeHandler), clientContext)); } else { operation.setDependency(execRuntime.execute(exchangeId, internalExchangeHandler, clientContext)); } } private boolean needAuthentication( final AuthExchange proxyAuthExchange, final HttpHost proxy, final HttpResponse response, final HttpClientContext context) throws AuthenticationException, MalformedChallengeException { final RequestConfig config = context.getRequestConfigOrDefault(); if (config.isAuthenticationEnabled()) { final boolean proxyAuthRequested = authenticator.isChallenged(proxy, ChallengeType.PROXY, response, proxyAuthExchange, context); final boolean proxyMutualAuthRequired = authenticator.isChallengeExpected(proxyAuthExchange); if (authCacheKeeper != null) { if (proxyAuthRequested) { authCacheKeeper.updateOnChallenge(proxy, null, proxyAuthExchange, context); } else { authCacheKeeper.updateOnNoChallenge(proxy, null, proxyAuthExchange, context); } } if (proxyAuthRequested || proxyMutualAuthRequired) { final boolean updated = authenticator.handleResponse(proxy, ChallengeType.PROXY, response, proxyAuthStrategy, proxyAuthExchange, context); if (authCacheKeeper != null) { authCacheKeeper.updateOnResponse(proxy, null, proxyAuthExchange, context); } return updated; } } return false; } private void proceedConnected( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) { final AsyncExecRuntime execRuntime = scope.execRuntime; final HttpClientContext clientContext = scope.clientContext; final EndpointInfo endpointInfo = execRuntime.getEndpointInfo(); if (endpointInfo != null) { clientContext.setSSLSession(endpointInfo.getSslSession()); } try { chain.proceed(request, entityProducer, scope, asyncExecCallback); } catch (final HttpException | IOException ex) { asyncExecCallback.failed(ex); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncClientBuilder.java0100664 0000000 0000000 00000127036 15063503632 030752 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.Closeable; import java.net.ProxySelector; import java.security.AccessController; import java.security.PrivilegedAction; import java.util.ArrayList; import java.util.Collection; import java.util.LinkedList; import java.util.List; import java.util.concurrent.ThreadFactory; import java.util.function.Function; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.CookieSpecSupport; import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.client5.http.impl.DefaultConnectionKeepAliveStrategy; import org.apache.hc.client5.http.impl.DefaultHttpRequestRetryStrategy; import org.apache.hc.client5.http.impl.DefaultRedirectStrategy; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.DefaultUserTokenHandler; import org.apache.hc.client5.http.impl.IdleConnectionEvictor; import org.apache.hc.client5.http.impl.NoopUserTokenHandler; import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider; import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory; import org.apache.hc.client5.http.impl.auth.BearerSchemeFactory; import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory; import org.apache.hc.client5.http.impl.auth.SystemDefaultCredentialsProvider; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.impl.routing.DefaultProxyRoutePlanner; import org.apache.hc.client5.http.impl.routing.DefaultRoutePlanner; import org.apache.hc.client5.http.impl.routing.SystemDefaultRoutePlanner; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.protocol.RequestAddCookies; import org.apache.hc.client5.http.protocol.RequestDefaultHeaders; import org.apache.hc.client5.http.protocol.RequestExpectContinue; import org.apache.hc.client5.http.protocol.RequestUpgrade; import org.apache.hc.client5.http.protocol.RequestValidateTrace; import org.apache.hc.client5.http.protocol.ResponseProcessCookies; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.DefaultThreadFactory; import org.apache.hc.core5.function.Callback; import org.apache.hc.core5.function.Decorator; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.NamedElementChain; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.nio.command.ShutdownCommand; import org.apache.hc.core5.http.protocol.DefaultHttpProcessor; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http.protocol.HttpProcessorBuilder; import org.apache.hc.core5.http.protocol.RequestTargetHost; import org.apache.hc.core5.http.protocol.RequestUserAgent; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.http2.protocol.H2RequestConnControl; import org.apache.hc.core5.http2.protocol.H2RequestContent; import org.apache.hc.core5.http2.protocol.H2RequestTargetHost; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.reactor.IOSessionListener; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.VersionInfo; /** * Builder for {@link CloseableHttpAsyncClient} instances that can negotiate * the most optimal HTTP protocol version during the {@code TLS} handshake * with {@code ALPN} extension if supported by the Java runtime. *

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

*

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* For internal use. *

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

* For internal use. *

*/ @Internal protected void addCloseable(final Closeable closeable) { if (closeable == null) { return; } if (closeables == null) { closeables = new ArrayList<>(); } closeables.add(closeable); } @Internal protected Function contextAdaptor() { return HttpClientContext::castOrCreate; } @SuppressWarnings("deprecated") public CloseableHttpAsyncClient build() { AsyncClientConnectionManager connManagerCopy = this.connManager; if (connManagerCopy == null) { final PoolingAsyncClientConnectionManagerBuilder connectionManagerBuilder = PoolingAsyncClientConnectionManagerBuilder.create(); if (systemProperties) { connectionManagerBuilder.useSystemProperties(); } connManagerCopy = connectionManagerBuilder.build(); } ConnectionKeepAliveStrategy keepAliveStrategyCopy = this.keepAliveStrategy; if (keepAliveStrategyCopy == null) { keepAliveStrategyCopy = DefaultConnectionKeepAliveStrategy.INSTANCE; } UserTokenHandler userTokenHandlerCopy = this.userTokenHandler; if (userTokenHandlerCopy == null) { if (!connectionStateDisabled) { userTokenHandlerCopy = DefaultUserTokenHandler.INSTANCE; } else { userTokenHandlerCopy = NoopUserTokenHandler.INSTANCE; } } AuthenticationStrategy targetAuthStrategyCopy = this.targetAuthStrategy; if (targetAuthStrategyCopy == null) { targetAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } AuthenticationStrategy proxyAuthStrategyCopy = this.proxyAuthStrategy; if (proxyAuthStrategyCopy == null) { proxyAuthStrategyCopy = DefaultAuthenticationStrategy.INSTANCE; } String userAgentCopy = this.userAgent; if (userAgentCopy == null) { if (systemProperties) { userAgentCopy = getProperty("http.agent", null); } if (userAgentCopy == null) { userAgentCopy = VersionInfo.getSoftwareInfo("Apache-HttpAsyncClient", "org.apache.hc.client5", getClass()); } } final HttpProcessorBuilder b = HttpProcessorBuilder.create(); if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.FIRST) { b.addFirst(entry.interceptor); } } } b.addAll( new H2RequestTargetHost(), new RequestValidateTrace(), new RequestDefaultHeaders(defaultHeaders), new H2RequestContent(), new H2RequestConnControl(), new RequestUserAgent(userAgentCopy), new RequestExpectContinue(), new RequestUpgrade()); if (!cookieManagementDisabled) { b.add(RequestAddCookies.INSTANCE); } if (!cookieManagementDisabled) { b.add(ResponseProcessCookies.INSTANCE); } if (requestInterceptors != null) { for (final RequestInterceptorEntry entry: requestInterceptors) { if (entry.position == RequestInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } if (responseInterceptors != null) { for (final ResponseInterceptorEntry entry: responseInterceptors) { if (entry.position == ResponseInterceptorEntry.Position.LAST) { b.addLast(entry.interceptor); } } } final HttpProcessor httpProcessor = b.build(); final NamedElementChain execChainDefinition = new NamedElementChain<>(); execChainDefinition.addLast( new HttpAsyncMainClientExec(httpProcessor, keepAliveStrategyCopy, userTokenHandlerCopy), ChainElement.MAIN_TRANSPORT.name()); execChainDefinition.addFirst( new AsyncConnectExec( new DefaultHttpProcessor(new RequestTargetHost(), new RequestUserAgent(userAgentCopy)), proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.CONNECT.name()); execChainDefinition.addFirst( new AsyncProtocolExec( targetAuthStrategyCopy, proxyAuthStrategyCopy, schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE, authCachingDisabled), ChainElement.PROTOCOL.name()); // Add request retry executor, if not disabled if (!automaticRetriesDisabled) { HttpRequestRetryStrategy retryStrategyCopy = this.retryStrategy; if (retryStrategyCopy == null) { retryStrategyCopy = DefaultHttpRequestRetryStrategy.INSTANCE; } execChainDefinition.addFirst( new AsyncHttpRequestRetryExec(retryStrategyCopy), ChainElement.RETRY.name()); } HttpRoutePlanner routePlannerCopy = this.routePlanner; if (routePlannerCopy == null) { SchemePortResolver schemePortResolverCopy = this.schemePortResolver; if (schemePortResolverCopy == null) { schemePortResolverCopy = DefaultSchemePortResolver.INSTANCE; } if (proxy != null) { routePlannerCopy = new DefaultProxyRoutePlanner(proxy, schemePortResolverCopy); } else if (this.proxySelector != null) { routePlannerCopy = new SystemDefaultRoutePlanner(schemePortResolverCopy, this.proxySelector); } else if (systemProperties) { final ProxySelector defaultProxySelector = AccessController.doPrivileged((PrivilegedAction) ProxySelector::getDefault); routePlannerCopy = new SystemDefaultRoutePlanner(schemePortResolverCopy, defaultProxySelector); } else { routePlannerCopy = new DefaultRoutePlanner(schemePortResolverCopy); } } // Add redirect executor, if not disabled if (!redirectHandlingDisabled) { RedirectStrategy redirectStrategyCopy = this.redirectStrategy; if (redirectStrategyCopy == null) { redirectStrategyCopy = schemePortResolver != null ? new DefaultRedirectStrategy(schemePortResolver) : DefaultRedirectStrategy.INSTANCE; } execChainDefinition.addFirst( new AsyncRedirectExec(routePlannerCopy, redirectStrategyCopy), ChainElement.REDIRECT.name()); } List closeablesCopy = closeables != null ? new ArrayList<>(closeables) : null; if (!this.connManagerShared) { if (closeablesCopy == null) { closeablesCopy = new ArrayList<>(1); } if (evictExpiredConnections || evictIdleConnections) { if (connManagerCopy instanceof ConnPoolControl) { final IdleConnectionEvictor connectionEvictor = new IdleConnectionEvictor((ConnPoolControl) connManagerCopy, maxIdleTime, maxIdleTime); closeablesCopy.add(connectionEvictor::shutdown); connectionEvictor.start(); } } closeablesCopy.add(connManagerCopy); } ConnectionReuseStrategy reuseStrategyCopy = this.reuseStrategy; if (reuseStrategyCopy == null) { if (systemProperties) { final String s = getProperty("http.keepAlive", "true"); if ("true".equalsIgnoreCase(s)) { reuseStrategyCopy = DefaultClientConnectionReuseStrategy.INSTANCE; } else { reuseStrategyCopy = (request, response, context) -> false; } } else { reuseStrategyCopy = DefaultClientConnectionReuseStrategy.INSTANCE; } } final AsyncPushConsumerRegistry pushConsumerRegistry = new AsyncPushConsumerRegistry(); final IOEventHandlerFactory ioEventHandlerFactory = new HttpAsyncClientProtocolNegotiationStarter( HttpProcessorBuilder.create().build(), (request, context) -> pushConsumerRegistry.get(request), h2Config != null ? h2Config : H2Config.DEFAULT, h1Config != null ? h1Config : Http1Config.DEFAULT, charCodingConfig != null ? charCodingConfig : CharCodingConfig.DEFAULT, reuseStrategyCopy, ioReactorExceptionCallback != null ? ioReactorExceptionCallback : LoggingExceptionCallback.INSTANCE); final DefaultConnectingIOReactor ioReactor = new DefaultConnectingIOReactor( ioEventHandlerFactory, ioReactorConfig != null ? ioReactorConfig : IOReactorConfig.DEFAULT, threadFactory != null ? threadFactory : new DefaultThreadFactory("httpclient-dispatch", true), ioSessionDecorator != null ? ioSessionDecorator : LoggingIOSessionDecorator.INSTANCE, ioReactorExceptionCallback != null ? ioReactorExceptionCallback : LoggingExceptionCallback.INSTANCE, ioSessionListener, ioSession -> ioSession.enqueue(new ShutdownCommand(CloseMode.GRACEFUL), Command.Priority.IMMEDIATE)); if (execInterceptors != null) { for (final ExecInterceptorEntry entry: execInterceptors) { switch (entry.position) { case AFTER: execChainDefinition.addAfter(entry.existing, entry.interceptor, entry.name); break; case BEFORE: execChainDefinition.addBefore(entry.existing, entry.interceptor, entry.name); break; case REPLACE: execChainDefinition.replace(entry.existing, entry.interceptor); break; case FIRST: execChainDefinition.addFirst(entry.interceptor, entry.name); break; case LAST: // Don't add last, after HttpAsyncMainClientExec, as that does not delegate to the chain // Instead, add the interceptor just before it, making it effectively the last interceptor execChainDefinition.addBefore(ChainElement.MAIN_TRANSPORT.name(), entry.interceptor, entry.name); break; } } } customizeExecChain(execChainDefinition); NamedElementChain.Node current = execChainDefinition.getLast(); AsyncExecChainElement execChain = null; while (current != null) { execChain = new AsyncExecChainElement(current.getValue(), execChain); current = current.getPrevious(); } Lookup authSchemeRegistryCopy = this.authSchemeRegistry; if (authSchemeRegistryCopy == null) { authSchemeRegistryCopy = RegistryBuilder.create() .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE) .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE) .register(StandardAuthScheme.BEARER, BearerSchemeFactory.INSTANCE) .build(); } Lookup cookieSpecRegistryCopy = this.cookieSpecRegistry; if (cookieSpecRegistryCopy == null) { cookieSpecRegistryCopy = CookieSpecSupport.createDefault(); } CookieStore cookieStoreCopy = this.cookieStore; if (cookieStoreCopy == null) { cookieStoreCopy = new BasicCookieStore(); } CredentialsProvider credentialsProviderCopy = this.credentialsProvider; if (credentialsProviderCopy == null) { if (systemProperties) { credentialsProviderCopy = new SystemDefaultCredentialsProvider(); } else { credentialsProviderCopy = new BasicCredentialsProvider(); } } return new InternalHttpAsyncClient( ioReactor, execChain, pushConsumerRegistry, threadFactory != null ? threadFactory : new DefaultThreadFactory("httpclient-main", true), connManagerCopy, routePlannerCopy, tlsConfig, cookieSpecRegistryCopy, authSchemeRegistryCopy, cookieStoreCopy, credentialsProviderCopy, contextAdaptor(), defaultRequestConfig, closeablesCopy); } private String getProperty(final String key, final String defaultValue) { return AccessController.doPrivileged((PrivilegedAction) () -> System.getProperty(key, defaultValue)); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalHttpAsyncExecRuntime.java0100664 0000000 0000000 00000031623 14744133027 032150 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.InterruptedIOException; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.Operations; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.nio.AsyncConnectionEndpoint; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.CallbackContribution; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; class InternalHttpAsyncExecRuntime implements AsyncExecRuntime { static class ReUseData { final Object state; final TimeValue validDuration; ReUseData(final Object state, final TimeValue validDuration) { this.state = state; this.validDuration = validDuration; } } private final Logger log; private final AsyncClientConnectionManager manager; private final ConnectionInitiator connectionInitiator; private final HandlerFactory pushHandlerFactory; /** * @deprecated TLS should be configured by the connection manager */ @Deprecated private final TlsConfig tlsConfig; private final AtomicReference endpointRef; private final AtomicReference reuseDataRef; InternalHttpAsyncExecRuntime( final Logger log, final AsyncClientConnectionManager manager, final ConnectionInitiator connectionInitiator, final HandlerFactory pushHandlerFactory, final TlsConfig tlsConfig) { super(); this.log = log; this.manager = manager; this.connectionInitiator = connectionInitiator; this.pushHandlerFactory = pushHandlerFactory; this.tlsConfig = tlsConfig; this.endpointRef = new AtomicReference<>(); this.reuseDataRef = new AtomicReference<>(); } @Override public boolean isEndpointAcquired() { return endpointRef.get() != null; } @Override public Cancellable acquireEndpoint( final String id, final HttpRoute route, final Object object, final HttpClientContext context, final FutureCallback callback) { if (endpointRef.get() == null) { final RequestConfig requestConfig = context.getRequestConfigOrDefault(); final Timeout connectionRequestTimeout = requestConfig.getConnectionRequestTimeout(); if (log.isDebugEnabled()) { log.debug("{} acquiring endpoint ({})", id, connectionRequestTimeout); } return Operations.cancellable(manager.lease( id, route, object, connectionRequestTimeout, new FutureCallback() { @Override public void completed(final AsyncConnectionEndpoint connectionEndpoint) { endpointRef.set(connectionEndpoint); if (log.isDebugEnabled()) { log.debug("{} acquired endpoint {}", id, ConnPoolSupport.getId(connectionEndpoint)); } callback.completed(InternalHttpAsyncExecRuntime.this); } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } })); } callback.completed(this); return Operations.nonCancellable(); } private void discardEndpoint(final AsyncConnectionEndpoint endpoint) { try { endpoint.close(CloseMode.IMMEDIATE); if (log.isDebugEnabled()) { log.debug("{} endpoint closed", ConnPoolSupport.getId(endpoint)); } } finally { if (log.isDebugEnabled()) { log.debug("{} discarding endpoint", ConnPoolSupport.getId(endpoint)); } manager.release(endpoint, null, TimeValue.ZERO_MILLISECONDS); } } @Override public void releaseEndpoint() { final AsyncConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { final ReUseData reUseData = reuseDataRef.getAndSet(null); if (reUseData != null) { if (log.isDebugEnabled()) { log.debug("{} releasing valid endpoint", ConnPoolSupport.getId(endpoint)); } manager.release(endpoint, reUseData.state, reUseData.validDuration); } else { discardEndpoint(endpoint); } } } @Override public void discardEndpoint() { final AsyncConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { discardEndpoint(endpoint); } } @Override public boolean validateConnection() { if (reuseDataRef != null) { final AsyncConnectionEndpoint endpoint = endpointRef.get(); return endpoint != null && endpoint.isConnected(); } final AsyncConnectionEndpoint endpoint = endpointRef.getAndSet(null); if (endpoint != null) { discardEndpoint(endpoint); } return false; } AsyncConnectionEndpoint ensureValid() { final AsyncConnectionEndpoint endpoint = endpointRef.get(); if (endpoint == null) { throw new IllegalStateException("Endpoint not acquired / already released"); } return endpoint; } @Override public boolean isEndpointConnected() { final AsyncConnectionEndpoint endpoint = endpointRef.get(); return endpoint != null && endpoint.isConnected(); } @Override public Cancellable connectEndpoint( final HttpClientContext context, final FutureCallback callback) { final AsyncConnectionEndpoint endpoint = ensureValid(); if (endpoint.isConnected()) { callback.completed(this); return Operations.nonCancellable(); } final RequestConfig requestConfig = context.getRequestConfigOrDefault(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); if (log.isDebugEnabled()) { log.debug("{} connecting endpoint ({})", ConnPoolSupport.getId(endpoint), connectTimeout); } return Operations.cancellable(manager.connect( endpoint, connectionInitiator, connectTimeout, tlsConfig, context, new CallbackContribution(callback) { @Override public void completed(final AsyncConnectionEndpoint endpoint) { if (log.isDebugEnabled()) { log.debug("{} endpoint connected", ConnPoolSupport.getId(endpoint)); } if (callback != null) { callback.completed(InternalHttpAsyncExecRuntime.this); } } })); } @Override public void disconnectEndpoint() { final AsyncConnectionEndpoint endpoint = endpointRef.get(); if (endpoint != null) { endpoint.close(CloseMode.GRACEFUL); } } @Override public void upgradeTls(final HttpClientContext context) { upgradeTls(context, null); } @Override public void upgradeTls(final HttpClientContext context, final FutureCallback callback) { final AsyncConnectionEndpoint endpoint = ensureValid(); if (log.isDebugEnabled()) { log.debug("{} upgrading endpoint", ConnPoolSupport.getId(endpoint)); } manager.upgrade(endpoint, tlsConfig, context, new CallbackContribution(callback) { @Override public void completed(final AsyncConnectionEndpoint endpoint) { if (callback != null) { callback.completed(InternalHttpAsyncExecRuntime.this); } } }); } @Override public EndpointInfo getEndpointInfo() { final AsyncConnectionEndpoint endpoint = endpointRef.get(); return endpoint != null ? endpoint.getInfo() : null; } @Override public Cancellable execute( final String id, final AsyncClientExchangeHandler exchangeHandler, final HttpClientContext context) { final AsyncConnectionEndpoint endpoint = ensureValid(); if (endpoint.isConnected()) { if (log.isDebugEnabled()) { log.debug("{} start execution {}", ConnPoolSupport.getId(endpoint), id); } final RequestConfig requestConfig = context.getRequestConfigOrDefault(); final Timeout responseTimeout = requestConfig.getResponseTimeout(); if (responseTimeout != null) { endpoint.setSocketTimeout(responseTimeout); } endpoint.execute(id, exchangeHandler, pushHandlerFactory, context); if (context.getRequestConfigOrDefault().isHardCancellationEnabled()) { return () -> { exchangeHandler.cancel(); return true; }; } } else { connectEndpoint(context, new FutureCallback() { @Override public void completed(final AsyncExecRuntime runtime) { if (log.isDebugEnabled()) { log.debug("{} start execution {}", ConnPoolSupport.getId(endpoint), id); } try { endpoint.execute(id, exchangeHandler, pushHandlerFactory, context); } catch (final RuntimeException ex) { failed(ex); } } @Override public void failed(final Exception ex) { exchangeHandler.failed(ex); } @Override public void cancelled() { exchangeHandler.failed(new InterruptedIOException()); } }); } return Operations.nonCancellable(); } @Override public void markConnectionReusable(final Object newState, final TimeValue newValidDuration) { reuseDataRef.set(new ReUseData(newState, newValidDuration)); } @Override public void markConnectionNonReusable() { reuseDataRef.set(null); } @Override public AsyncExecRuntime fork() { return new InternalHttpAsyncExecRuntime(log, manager, connectionInitiator, pushHandlerFactory, tlsConfig); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/CloseableHttpAsyncClient.java0100664 0000000 0000000 00000014245 14704162040 031245 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.HttpAsyncClient; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.reactor.IOReactorStatus; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; /** * Base implementation of {@link HttpAsyncClient} that also implements {@link ModalCloseable}. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public abstract class CloseableHttpAsyncClient implements HttpAsyncClient, ModalCloseable { public abstract void start(); public abstract IOReactorStatus getStatus(); public abstract void awaitShutdown(TimeValue waitTime) throws InterruptedException; public abstract void initiateShutdown(); protected abstract Future doExecute( final HttpHost target, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback); public final Future execute( final HttpHost target, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback) { Args.notNull(requestProducer, "Request producer"); Args.notNull(responseConsumer, "Response consumer"); return doExecute(target, requestProducer, responseConsumer, pushHandlerFactory, context, callback); } @Override public final Future execute( final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback) { Args.notNull(requestProducer, "Request producer"); Args.notNull(responseConsumer, "Response consumer"); return doExecute(null, requestProducer, responseConsumer, pushHandlerFactory, context, callback); } public final Future execute( final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HttpContext context, final FutureCallback callback) { Args.notNull(requestProducer, "Request producer"); Args.notNull(responseConsumer, "Response consumer"); return execute(requestProducer, responseConsumer, null, context, callback); } public final Future execute( final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final FutureCallback callback) { Args.notNull(requestProducer, "Request producer"); Args.notNull(responseConsumer, "Response consumer"); return execute(requestProducer, responseConsumer, null, callback); } public final Future execute( final SimpleHttpRequest request, final HttpContext context, final FutureCallback callback) { Args.notNull(request, "Request"); return execute(SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), context, callback); } public final Future execute( final SimpleHttpRequest request, final FutureCallback callback) { return execute(request, null, callback); } /** * @deprecated Use {@link org.apache.hc.core5.http.impl.routing.RequestRouter} * at the construction time */ @Deprecated public abstract void register(String hostname, String uriPattern, Supplier supplier); /** * @deprecated Use {@link org.apache.hc.core5.http.impl.routing.RequestRouter} * at the construction time */ @Deprecated public final void register(final String uriPattern, final Supplier supplier) { register(null, uriPattern, supplier); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncPushConsumerRegistry.java0100664 0000000 0000000 00000010242 14704162040 031532 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.util.Locale; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.util.Args; @SuppressWarnings("deprecation") class AsyncPushConsumerRegistry { private final org.apache.hc.core5.http.protocol.UriPatternMatcher> primary; private final ConcurrentMap>> hostMap; public AsyncPushConsumerRegistry() { this.primary = new org.apache.hc.core5.http.protocol.UriPatternMatcher<>(); this.hostMap = new ConcurrentHashMap<>(); } private org.apache.hc.core5.http.protocol.UriPatternMatcher> getPatternMatcher(final String hostname) { if (hostname == null) { return primary; } final org.apache.hc.core5.http.protocol.UriPatternMatcher> hostMatcher = hostMap.get(hostname); if (hostMatcher != null) { return hostMatcher; } return primary; } public AsyncPushConsumer get(final HttpRequest request) { Args.notNull(request, "Request"); final URIAuthority authority = request.getAuthority(); final String key = authority != null ? authority.getHostName().toLowerCase(Locale.ROOT) : null; final org.apache.hc.core5.http.protocol.UriPatternMatcher> patternMatcher = getPatternMatcher(key); if (patternMatcher == null) { return null; } String path = request.getPath(); final int i = path.indexOf('?'); if (i != -1) { path = path.substring(0, i); } final Supplier supplier = patternMatcher.lookup(path); return supplier != null ? supplier.get() : null; } public void register(final String hostname, final String uriPattern, final Supplier supplier) { Args.notBlank(uriPattern, "URI pattern"); Args.notNull(supplier, "Supplier"); if (hostname == null) { primary.register(uriPattern, supplier); } else { final String key = hostname.toLowerCase(Locale.ROOT); org.apache.hc.core5.http.protocol.UriPatternMatcher> matcher = hostMap.get(key); if (matcher == null) { final org.apache.hc.core5.http.protocol.UriPatternMatcher> newMatcher = new org.apache.hc.core5.http.protocol.UriPatternMatcher<>(); matcher = hostMap.putIfAbsent(key, newMatcher); if (matcher == null) { matcher = newMatcher; } } matcher.register(uriPattern, supplier); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AbstractHttpAsyncClientBase.java0100664 0000000 0000000 00000012633 15063503637 031723 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.net.SocketAddress; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.ThreadFactory; import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.reactor.IOReactorStatus; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; abstract class AbstractHttpAsyncClientBase extends CloseableHttpAsyncClient implements ConnectionInitiator { enum Status { READY, RUNNING, TERMINATED } private static final Logger LOG = LoggerFactory.getLogger(AbstractHttpAsyncClientBase.class); private final AsyncPushConsumerRegistry pushConsumerRegistry; private final DefaultConnectingIOReactor ioReactor; private final ExecutorService executorService; private final AtomicReference status; AbstractHttpAsyncClientBase( final DefaultConnectingIOReactor ioReactor, final AsyncPushConsumerRegistry pushConsumerRegistry, final ThreadFactory threadFactory) { super(); this.ioReactor = ioReactor; this.pushConsumerRegistry = pushConsumerRegistry; this.executorService = Executors.newSingleThreadExecutor(threadFactory); this.status = new AtomicReference<>(Status.READY); } @Override public final void start() { if (status.compareAndSet(Status.READY, Status.RUNNING)) { executorService.execute(ioReactor::start); } } /** * @deprecated Use {@link org.apache.hc.core5.http.impl.routing.RequestRouter} * at the construction time */ @Deprecated @Override public void register(final String hostname, final String uriPattern, final Supplier supplier) { pushConsumerRegistry.register(hostname, uriPattern, supplier); } boolean isRunning() { return status.get() == Status.RUNNING; } @Override public Future connect( final NamedEndpoint remoteEndpoint, final SocketAddress remoteAddress, final SocketAddress localAddress, final Timeout timeout, final Object attachment, final FutureCallback callback) { return ioReactor.connect(remoteEndpoint, remoteAddress, localAddress, timeout, attachment, callback); } ConnectionInitiator getConnectionInitiator() { return ioReactor; } @Override public final IOReactorStatus getStatus() { return ioReactor.getStatus(); } @Override public final void awaitShutdown(final TimeValue waitTime) throws InterruptedException { ioReactor.awaitShutdown(waitTime); } @Override public final void initiateShutdown() { if (LOG.isDebugEnabled()) { LOG.debug("Initiating shutdown"); } ioReactor.initiateShutdown(); } void internalClose(final CloseMode closeMode) { } @Override public final void close(final CloseMode closeMode) { if (LOG.isDebugEnabled()) { LOG.debug("Shutdown {}", closeMode); } ioReactor.initiateShutdown(); ioReactor.close(closeMode); if (closeMode == CloseMode.GRACEFUL) { executorService.shutdown(); try { if (!executorService.awaitTermination(1, TimeUnit.SECONDS)) { executorService.shutdownNow(); } } catch (final InterruptedException ignore) { Thread.currentThread().interrupt(); } } else { executorService.shutdownNow(); } internalClose(closeMode); } @Override public void close() { close(CloseMode.GRACEFUL); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/MinimalHttpAsyncClient.java0100664 0000000 0000000 00000055724 14704162040 030751 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.CancellationException; import java.util.concurrent.Future; import java.util.concurrent.ThreadFactory; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicInteger; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.impl.classic.RequestFailedException; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.nio.AsyncConnectionEndpoint; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.BasicFuture; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexCancellable; import org.apache.hc.core5.concurrent.ComplexFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.nio.AsyncClientEndpoint; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.nio.command.ShutdownCommand; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.Closer; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Minimal implementation of {@link CloseableHttpAsyncClient}. This client is * optimized for HTTP/1.1 and HTTP/2 message transport and does not support * advanced HTTP protocol functionality such as request execution via a proxy, * state management, authentication and request redirects. *

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

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public final class MinimalHttpAsyncClient extends AbstractMinimalHttpAsyncClientBase { private static final Logger LOG = LoggerFactory.getLogger(MinimalHttpAsyncClient.class); private final AsyncClientConnectionManager manager; private final SchemePortResolver schemePortResolver; private final TlsConfig tlsConfig; MinimalHttpAsyncClient( final IOEventHandlerFactory eventHandlerFactory, final AsyncPushConsumerRegistry pushConsumerRegistry, final IOReactorConfig reactorConfig, final ThreadFactory threadFactory, final ThreadFactory workerThreadFactory, final AsyncClientConnectionManager manager, final SchemePortResolver schemePortResolver, final TlsConfig tlsConfig) { super(new DefaultConnectingIOReactor( eventHandlerFactory, reactorConfig, workerThreadFactory, LoggingIOSessionDecorator.INSTANCE, LoggingExceptionCallback.INSTANCE, null, ioSession -> ioSession.enqueue(new ShutdownCommand(CloseMode.GRACEFUL), Command.Priority.NORMAL)), pushConsumerRegistry, threadFactory); this.manager = manager; this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; this.tlsConfig = tlsConfig; } private Future leaseEndpoint( final HttpHost host, final Timeout connectionRequestTimeout, final Timeout connectTimeout, final HttpClientContext clientContext, final FutureCallback callback) { final HttpRoute route = new HttpRoute(RoutingSupport.normalize(host, schemePortResolver)); final ComplexFuture resultFuture = new ComplexFuture<>(callback); final String exchangeId = ExecSupport.getNextExchangeId(); clientContext.setExchangeId(exchangeId); final Future leaseFuture = manager.lease( exchangeId, route, null, connectionRequestTimeout, new FutureCallback() { @Override public void completed(final AsyncConnectionEndpoint connectionEndpoint) { if (connectionEndpoint.isConnected()) { resultFuture.completed(connectionEndpoint); } else { final Future connectFuture = manager.connect( connectionEndpoint, getConnectionInitiator(), connectTimeout, tlsConfig, clientContext, new FutureCallback() { @Override public void completed(final AsyncConnectionEndpoint result) { resultFuture.completed(result); } @Override public void failed(final Exception ex) { try { Closer.closeQuietly(connectionEndpoint); manager.release(connectionEndpoint, null, TimeValue.ZERO_MILLISECONDS); } finally { resultFuture.failed(ex); } } @Override public void cancelled() { try { Closer.closeQuietly(connectionEndpoint); manager.release(connectionEndpoint, null, TimeValue.ZERO_MILLISECONDS); } finally { resultFuture.cancel(true); } } }); resultFuture.setDependency(connectFuture); } } @Override public void failed(final Exception ex) { callback.failed(ex); } @Override public void cancelled() { callback.cancelled(); } }); resultFuture.setDependency(leaseFuture); return resultFuture; } public Future lease( final HttpHost host, final FutureCallback callback) { return lease(host, null, callback); } public Future lease( final HttpHost host, final HttpContext context, final FutureCallback callback) { Args.notNull(host, "Host"); final BasicFuture future = new BasicFuture<>(callback); if (!isRunning()) { future.failed(new CancellationException("Connection lease cancelled")); return future; } final HttpClientContext clientContext = HttpClientContext.castOrCreate(context); final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault(); final Timeout connectionRequestTimeout = requestConfig.getConnectionRequestTimeout(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); leaseEndpoint( host, connectionRequestTimeout, connectTimeout, clientContext, new FutureCallback() { @Override public void completed(final AsyncConnectionEndpoint result) { future.completed(new InternalAsyncClientEndpoint(result)); } @Override public void failed(final Exception ex) { future.failed(ex); } @Override public void cancelled() { future.cancel(true); } }); return future; } @Override public Cancellable execute( final AsyncClientExchangeHandler exchangeHandler, final HandlerFactory pushHandlerFactory, final HttpContext context) { final ComplexCancellable cancellable = new ComplexCancellable(); try { if (!isRunning()) { throw new CancellationException("Request execution cancelled"); } final HttpClientContext clientContext = HttpClientContext.castOrCreate(context); exchangeHandler.produceRequest((request, entityDetails, context1) -> { RequestConfig requestConfig = null; if (request instanceof Configurable) { requestConfig = ((Configurable) request).getConfig(); } if (requestConfig != null) { clientContext.setRequestConfig(requestConfig); } else { requestConfig = clientContext.getRequestConfigOrDefault(); } final Timeout connectionRequestTimeout = requestConfig.getConnectionRequestTimeout(); @SuppressWarnings("deprecation") final Timeout connectTimeout = requestConfig.getConnectTimeout(); final Timeout responseTimeout = requestConfig.getResponseTimeout(); final HttpHost target = new HttpHost(request.getScheme(), request.getAuthority()); final Future leaseFuture = leaseEndpoint( target, connectionRequestTimeout, connectTimeout, clientContext, new FutureCallback() { @Override public void completed(final AsyncConnectionEndpoint connectionEndpoint) { final InternalAsyncClientEndpoint endpoint = new InternalAsyncClientEndpoint(connectionEndpoint); final AtomicInteger messageCountDown = new AtomicInteger(2); final AsyncClientExchangeHandler internalExchangeHandler = new AsyncClientExchangeHandler() { @Override public void releaseResources() { try { exchangeHandler.releaseResources(); } finally { endpoint.releaseAndDiscard(); } } @Override public void failed(final Exception cause) { try { exchangeHandler.failed(cause); } finally { endpoint.releaseAndDiscard(); } } @Override public void cancel() { failed(new RequestFailedException("Request aborted")); } @Override public void produceRequest( final RequestChannel channel, final HttpContext context1) throws HttpException, IOException { channel.sendRequest(request, entityDetails, context1); if (entityDetails == null) { messageCountDown.decrementAndGet(); } } @Override public int available() { return exchangeHandler.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { exchangeHandler.produce(new DataStreamChannel() { @Override public void requestOutput() { channel.requestOutput(); } @Override public int write(final ByteBuffer src) throws IOException { return channel.write(src); } @Override public void endStream(final List trailers) throws IOException { channel.endStream(trailers); if (messageCountDown.decrementAndGet() <= 0) { endpoint.releaseAndReuse(); } } @Override public void endStream() throws IOException { channel.endStream(); if (messageCountDown.decrementAndGet() <= 0) { endpoint.releaseAndReuse(); } } }); } @Override public void consumeInformation( final HttpResponse response, final HttpContext context1) throws HttpException, IOException { exchangeHandler.consumeInformation(response, context1); } @Override public void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context1) throws HttpException, IOException { exchangeHandler.consumeResponse(response, entityDetails, context1); if (response.getCode() >= HttpStatus.SC_CLIENT_ERROR) { messageCountDown.decrementAndGet(); } if (entityDetails == null) { if (messageCountDown.decrementAndGet() <= 0) { endpoint.releaseAndReuse(); } } } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { exchangeHandler.updateCapacity(capacityChannel); } @Override public void consume(final ByteBuffer src) throws IOException { exchangeHandler.consume(src); } @Override public void streamEnd(final List trailers) throws HttpException, IOException { if (messageCountDown.decrementAndGet() <= 0) { endpoint.releaseAndReuse(); } exchangeHandler.streamEnd(trailers); } }; if (responseTimeout != null) { endpoint.setSocketTimeout(responseTimeout); } endpoint.execute(internalExchangeHandler, pushHandlerFactory, clientContext); } @Override public void failed(final Exception ex) { exchangeHandler.failed(ex); } @Override public void cancelled() { exchangeHandler.cancel(); } }); cancellable.setDependency(() -> leaseFuture.cancel(true)); }, context); } catch (final HttpException | IOException | IllegalStateException ex) { exchangeHandler.failed(ex); } return cancellable; } private class InternalAsyncClientEndpoint extends AsyncClientEndpoint { private final AsyncConnectionEndpoint connectionEndpoint; private final AtomicBoolean released; InternalAsyncClientEndpoint(final AsyncConnectionEndpoint connectionEndpoint) { this.connectionEndpoint = connectionEndpoint; this.released = new AtomicBoolean(false); } boolean isReleased() { return released.get(); } @Override public boolean isConnected() { return !isReleased() && connectionEndpoint.isConnected(); } @Override public void execute( final AsyncClientExchangeHandler exchangeHandler, final HandlerFactory pushHandlerFactory, final HttpContext context) { Asserts.check(!released.get(), "Endpoint has already been released"); final HttpClientContext clientContext = HttpClientContext.castOrCreate(context); final String exchangeId = ExecSupport.getNextExchangeId(); clientContext.setExchangeId(exchangeId); if (LOG.isDebugEnabled()) { LOG.debug("{} executing message exchange {}", exchangeId, ConnPoolSupport.getId(connectionEndpoint)); connectionEndpoint.execute( exchangeId, new LoggingAsyncClientExchangeHandler(LOG, exchangeId, exchangeHandler), pushHandlerFactory, clientContext); } else { connectionEndpoint.execute(exchangeId, exchangeHandler, clientContext); } } public void setSocketTimeout(final Timeout timeout) { connectionEndpoint.setSocketTimeout(timeout); } @Override public void releaseAndReuse() { if (released.compareAndSet(false, true)) { manager.release(connectionEndpoint, null, TimeValue.NEG_ONE_MILLISECOND); } } @Override public void releaseAndDiscard() { if (released.compareAndSet(false, true)) { Closer.closeQuietly(connectionEndpoint); manager.release(connectionEndpoint, null, TimeValue.ZERO_MILLISECONDS); } } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LogAppendable.java0100664 0000000 0000000 00000004615 14666635064 027076 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import org.slf4j.Logger; final class LogAppendable implements Appendable { private final Logger log; private final String prefix; private final StringBuilder buffer; public LogAppendable(final Logger log, final String prefix) { this.log = log; this.prefix = prefix; this.buffer = new StringBuilder(); } @Override public Appendable append(final CharSequence text) throws IOException { return append(text, 0, text.length()); } @Override public Appendable append(final CharSequence text, final int start, final int end) throws IOException { for (int i = start; i < end; i++) { append(text.charAt(i)); } return this; } @Override public Appendable append(final char ch) throws IOException { if (ch == '\n') { log.debug("{} {}", prefix, buffer); buffer.setLength(0); } else if (ch != '\r') { buffer.append(ch); } return this; } public void flush() { if (buffer.length() > 0) { log.debug("{} {}", prefix, buffer); buffer.setLength(0); } } } ././@LongLink0100644 0000000 0000000 00000000145 15005672035 011636 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalAbstractHttpAsyncClient.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/async/InternalAbstractHttpAsyncClient.java0100664 0000000 0000000 00000047064 15005672035 032626 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.Closeable; import java.io.IOException; import java.util.List; import java.util.Set; import java.util.concurrent.CancellationException; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.ThreadFactory; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicInteger; import java.util.function.Function; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexFuture; import org.apache.hc.core5.concurrent.DefaultThreadFactory; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.io.ModalCloseable; import org.apache.hc.core5.net.URIAuthority; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; abstract class InternalAbstractHttpAsyncClient extends AbstractHttpAsyncClientBase { private final static ThreadFactory SCHEDULER_THREAD_FACTORY = new DefaultThreadFactory("Scheduled-executor", true); private static final Logger LOG = LoggerFactory.getLogger(InternalAbstractHttpAsyncClient.class); private final AsyncExecChainElement execChain; private final Lookup cookieSpecRegistry; private final Lookup authSchemeRegistry; private final CookieStore cookieStore; private final CredentialsProvider credentialsProvider; private final Function contextAdaptor; private final RequestConfig defaultConfig; private final ConcurrentLinkedQueue closeables; private final ScheduledExecutorService scheduledExecutorService; private final AsyncExecChain.Scheduler scheduler; InternalAbstractHttpAsyncClient( final DefaultConnectingIOReactor ioReactor, final AsyncPushConsumerRegistry pushConsumerRegistry, final ThreadFactory threadFactory, final AsyncExecChainElement execChain, final Lookup cookieSpecRegistry, final Lookup authSchemeRegistry, final CookieStore cookieStore, final CredentialsProvider credentialsProvider, final Function contextAdaptor, final RequestConfig defaultConfig, final List closeables) { super(ioReactor, pushConsumerRegistry, threadFactory); this.execChain = execChain; this.cookieSpecRegistry = cookieSpecRegistry; this.authSchemeRegistry = authSchemeRegistry; this.cookieStore = cookieStore; this.credentialsProvider = credentialsProvider; this.contextAdaptor = contextAdaptor; this.defaultConfig = defaultConfig; this.closeables = closeables != null ? new ConcurrentLinkedQueue<>(closeables) : null; this.scheduledExecutorService = Executors.newSingleThreadScheduledExecutor(SCHEDULER_THREAD_FACTORY); this.scheduler = new AsyncExecChain.Scheduler() { @Override public void scheduleExecution( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecCallback asyncExecCallback, final TimeValue delay) { executeScheduled(request, entityProducer, scope, execChain::execute, asyncExecCallback, delay); } @Override public void scheduleExecution( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback, final TimeValue delay) { executeScheduled(request, entityProducer, scope, chain, asyncExecCallback, delay); } }; } @Override void internalClose(final CloseMode closeMode) { if (this.closeables != null) { Closeable closeable; while ((closeable = this.closeables.poll()) != null) { try { if (closeable instanceof ModalCloseable) { ((ModalCloseable) closeable).close(closeMode); } else { closeable.close(); } } catch (final IOException ex) { LOG.error(ex.getMessage(), ex); } } } final List runnables = this.scheduledExecutorService.shutdownNow(); for (final Runnable runnable: runnables) { if (runnable instanceof Cancellable) { ((Cancellable) runnable).cancel(); } } } private void setupContext(final HttpClientContext context) { if (context.getAuthSchemeRegistry() == null) { context.setAuthSchemeRegistry(authSchemeRegistry); } if (context.getCookieSpecRegistry() == null) { context.setCookieSpecRegistry(cookieSpecRegistry); } if (context.getCookieStore() == null) { context.setCookieStore(cookieStore); } if (context.getCredentialsProvider() == null) { context.setCredentialsProvider(credentialsProvider); } if (context.getRequestConfig() == null) { context.setRequestConfig(defaultConfig); } } abstract AsyncExecRuntime createAsyncExecRuntime(HandlerFactory pushHandlerFactory); abstract HttpRoute determineRoute(HttpHost httpHost, HttpRequest request, HttpClientContext clientContext) throws HttpException; @Override protected Future doExecute( final HttpHost target, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer responseConsumer, final HandlerFactory pushHandlerFactory, final HttpContext context, final FutureCallback callback) { final ComplexFuture future = new ComplexFuture<>(callback); try { if (!isRunning()) { throw new CancellationException("Request execution cancelled"); } final HttpClientContext clientContext = contextAdaptor.apply(context); requestProducer.sendRequest((request, entityDetails, c) -> { RequestConfig requestConfig = null; if (request instanceof Configurable) { requestConfig = ((Configurable) request).getConfig(); } if (requestConfig != null) { clientContext.setRequestConfig(requestConfig); } setupContext(clientContext); final HttpHost resolvedTarget = target != null ? target : RoutingSupport.determineHost(request); if (resolvedTarget != null) { if (request.getScheme() == null) { request.setScheme(resolvedTarget.getSchemeName()); } if (request.getAuthority() == null) { request.setAuthority(new URIAuthority(resolvedTarget)); } } final HttpRoute route = determineRoute( resolvedTarget, request, clientContext); final String exchangeId = ExecSupport.getNextExchangeId(); clientContext.setExchangeId(exchangeId); if (LOG.isDebugEnabled()) { LOG.debug("{} preparing request execution", exchangeId); } final AsyncExecRuntime execRuntime = createAsyncExecRuntime(pushHandlerFactory); final AsyncExecChain.Scope scope = new AsyncExecChain.Scope(exchangeId, route, request, future, clientContext, execRuntime, scheduler, new AtomicInteger(1)); final AtomicBoolean outputTerminated = new AtomicBoolean(false); executeImmediate( BasicRequestBuilder.copy(request).build(), entityDetails != null ? new AsyncEntityProducer() { @Override public void releaseResources() { requestProducer.releaseResources(); } @Override public void failed(final Exception cause) { requestProducer.failed(cause); } @Override public boolean isRepeatable() { return requestProducer.isRepeatable(); } @Override public long getContentLength() { return entityDetails.getContentLength(); } @Override public String getContentType() { return entityDetails.getContentType(); } @Override public String getContentEncoding() { return entityDetails.getContentEncoding(); } @Override public boolean isChunked() { return entityDetails.isChunked(); } @Override public Set getTrailerNames() { return entityDetails.getTrailerNames(); } @Override public int available() { return requestProducer.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { if (outputTerminated.get()) { channel.endStream(); return; } requestProducer.produce(channel); } } : null, scope, execChain::execute, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { if (response.getCode() >= HttpStatus.SC_CLIENT_ERROR) { outputTerminated.set(true); requestProducer.releaseResources(); } responseConsumer.consumeResponse(response, entityDetails, c, new FutureCallback() { @Override public void completed(final T result) { future.completed(result); } @Override public void failed(final Exception ex) { future.failed(ex); } @Override public void cancelled() { future.cancel(); } }); return entityDetails != null ? responseConsumer : null; } @Override public void handleInformationResponse( final HttpResponse response) throws HttpException, IOException { responseConsumer.informationResponse(response, c); } @Override public void completed() { if (LOG.isDebugEnabled()) { LOG.debug("{} message exchange successfully completed", exchangeId); } try { execRuntime.releaseEndpoint(); } finally { responseConsumer.releaseResources(); requestProducer.releaseResources(); } } @Override public void failed(final Exception cause) { if (LOG.isDebugEnabled()) { LOG.debug("{} request failed: {}", exchangeId, cause.getMessage()); } try { execRuntime.discardEndpoint(); responseConsumer.failed(cause); } finally { try { future.failed(cause); } finally { responseConsumer.releaseResources(); requestProducer.releaseResources(); } } } }); }, clientContext); } catch (final HttpException | IOException | IllegalStateException ex) { future.failed(ex); } return future; } void executeImmediate( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { chain.proceed(request, entityProducer, scope, asyncExecCallback); } void executeScheduled( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback, final TimeValue delay) { final ScheduledRequestExecution scheduledTask = new ScheduledRequestExecution( request, entityProducer, scope, chain, asyncExecCallback, delay); if (TimeValue.isPositive(delay)) { scheduledExecutorService.schedule(scheduledTask, delay.getDuration(), delay.getTimeUnit()); } else { scheduledExecutorService.execute(scheduledTask); } } class ScheduledRequestExecution implements Runnable, Cancellable { final HttpRequest request; final AsyncEntityProducer entityProducer; final AsyncExecChain.Scope scope; final AsyncExecChain chain; final AsyncExecCallback asyncExecCallback; final TimeValue delay; ScheduledRequestExecution(final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback, final TimeValue delay) { this.request = request; this.entityProducer = entityProducer; this.scope = scope; this.chain = chain; this.asyncExecCallback = asyncExecCallback; this.delay = delay; } @Override public void run() { try { chain.proceed(request, entityProducer, scope, asyncExecCallback); } catch (final Exception ex) { asyncExecCallback.failed(ex); } } @Override public boolean cancel() { asyncExecCallback.failed(new CancellationException("Request execution cancelled")); return true; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/H2AsyncMainClientExec.java0100664 0000000 0000000 00000020301 14740035240 030366 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.io.InterruptedIOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Usually the last HTTP/2 request execution handler in the asynchronous * request execution chain that is responsible for execution of * request / response exchanges with the opposite endpoint. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public class H2AsyncMainClientExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(H2AsyncMainClientExec.class); private final HttpProcessor httpProcessor; H2AsyncMainClientExec(final HttpProcessor httpProcessor) { this.httpProcessor = Args.notNull(httpProcessor, "HTTP protocol processor"); } @Override public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final CancellableDependency operation = scope.cancellableDependency; final HttpClientContext clientContext = scope.clientContext; final AsyncExecRuntime execRuntime = scope.execRuntime; if (LOG.isDebugEnabled()) { LOG.debug("{} executing {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } final AsyncClientExchangeHandler internalExchangeHandler = new AsyncClientExchangeHandler() { private final AtomicReference entityConsumerRef = new AtomicReference<>(); @Override public void releaseResources() { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } } @Override public void failed(final Exception cause) { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } execRuntime.markConnectionNonReusable(); asyncExecCallback.failed(cause); } @Override public void cancel() { failed(new InterruptedIOException()); } @Override public void produceRequest(final RequestChannel channel, final HttpContext context) throws HttpException, IOException { clientContext.setRequest(request); clientContext.setRoute(route); httpProcessor.process(request, entityProducer, clientContext); channel.sendRequest(request, entityProducer, context); } @Override public int available() { return entityProducer.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { entityProducer.produce(channel); } @Override public void consumeInformation(final HttpResponse response, final HttpContext context) throws HttpException, IOException { } @Override public void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { clientContext.setResponse(response); httpProcessor.process(response, entityDetails, clientContext); entityConsumerRef.set(asyncExecCallback.handleResponse(response, entityDetails)); if (entityDetails == null) { execRuntime.validateConnection(); asyncExecCallback.completed(); } } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.updateCapacity(capacityChannel); } else { capacityChannel.update(Integer.MAX_VALUE); } } @Override public void consume(final ByteBuffer src) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.consume(src); } } @Override public void streamEnd(final List trailers) throws HttpException, IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.streamEnd(trailers); } else { execRuntime.validateConnection(); } asyncExecCallback.completed(); } }; if (LOG.isDebugEnabled()) { operation.setDependency(execRuntime.execute( exchangeId, new LoggingAsyncClientExchangeHandler(LOG, exchangeId, internalExchangeHandler), clientContext)); } else { operation.setDependency(execRuntime.execute(exchangeId, internalExchangeHandler, clientContext)); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LoggingIOSession.java0100664 0000000 0000000 00000023166 14704162040 027543 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.net.SocketAddress; import java.nio.ByteBuffer; import java.nio.channels.ByteChannel; import java.nio.channels.SelectionKey; import java.util.concurrent.locks.Lock; import org.apache.hc.core5.http.Chars; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.IOEventHandler; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; class LoggingIOSession implements IOSession { private final Logger log; private final Logger wireLog; private final IOSession session; public LoggingIOSession(final IOSession session, final Logger log, final Logger wireLog) { super(); this.session = session; this.log = log; this.wireLog = wireLog; } @Override public String getId() { return session.getId(); } @Override public Lock getLock() { return session.getLock(); } @Override public boolean hasCommands() { return session.hasCommands(); } @Override public Command poll() { return session.poll(); } @Override public void enqueue(final Command command, final Command.Priority priority) { session.enqueue(command, priority); if (log.isDebugEnabled()) { log.debug("{} Enqueued {} with priority {}", session, command.getClass().getSimpleName(), priority); } } @Override public ByteChannel channel() { return session.channel(); } @Override public SocketAddress getLocalAddress() { return session.getLocalAddress(); } @Override public SocketAddress getRemoteAddress() { return session.getRemoteAddress(); } @Override public int getEventMask() { return session.getEventMask(); } private static String formatOps(final int ops) { final StringBuilder buffer = new StringBuilder(6); buffer.append('['); if ((ops & SelectionKey.OP_READ) > 0) { buffer.append('r'); } if ((ops & SelectionKey.OP_WRITE) > 0) { buffer.append('w'); } if ((ops & SelectionKey.OP_ACCEPT) > 0) { buffer.append('a'); } if ((ops & SelectionKey.OP_CONNECT) > 0) { buffer.append('c'); } buffer.append(']'); return buffer.toString(); } @Override public void setEventMask(final int ops) { session.setEventMask(ops); if (log.isDebugEnabled()) { log.debug("{} Event mask set {}", session, formatOps(ops)); } } @Override public void setEvent(final int op) { session.setEvent(op); if (log.isDebugEnabled()) { log.debug("{} Event set {}", session, formatOps(op)); } } @Override public void clearEvent(final int op) { session.clearEvent(op); if (log.isDebugEnabled()) { log.debug("{} Event cleared {}", session, formatOps(op)); } } @Override public boolean isOpen() { return session.isOpen(); } @Override public void close() { if (log.isDebugEnabled()) { log.debug("{} Close", session); } session.close(); } @Override public Status getStatus() { return session.getStatus(); } @Override public void close(final CloseMode closeMode) { if (log.isDebugEnabled()) { log.debug("{} Close {}", session, closeMode); } session.close(closeMode); } @Override public Timeout getSocketTimeout() { return session.getSocketTimeout(); } @Override public void setSocketTimeout(final Timeout timeout) { if (log.isDebugEnabled()) { log.debug("{} Set timeout {}", session, timeout); } session.setSocketTimeout(timeout); } @Override public long getLastReadTime() { return session.getLastReadTime(); } @Override public long getLastWriteTime() { return session.getLastWriteTime(); } @Override public void updateReadTime() { session.updateReadTime(); } @Override public void updateWriteTime() { session.updateWriteTime(); } @Override public long getLastEventTime() { return session.getLastEventTime(); } @Override public IOEventHandler getHandler() { return session.getHandler(); } @Override public void upgrade(final IOEventHandler handler) { Args.notNull(handler, "Protocol handler"); if (log.isDebugEnabled()) { log.debug("{} protocol upgrade {}", session, handler.getClass()); } session.upgrade(new IOEventHandler() { @Override public void connected(final IOSession protocolSession) throws IOException { handler.connected(protocolSession); } @Override public void inputReady(final IOSession protocolSession, final ByteBuffer src) throws IOException { if (src != null && wireLog.isDebugEnabled()) { final ByteBuffer b = src.duplicate(); logData(b, "<< "); } handler.inputReady(protocolSession, src); } @Override public void outputReady(final IOSession protocolSession) throws IOException { handler.outputReady(protocolSession); } @Override public void timeout(final IOSession protocolSession, final Timeout timeout) throws IOException { handler.timeout(protocolSession, timeout); } @Override public void exception(final IOSession protocolSession, final Exception cause) { handler.exception(protocolSession, cause); } @Override public void disconnected(final IOSession protocolSession) { handler.disconnected(protocolSession); } }); } private void logData(final ByteBuffer data, final String prefix) { final byte[] line = new byte[16]; final StringBuilder buf = new StringBuilder(); while (data.hasRemaining()) { buf.setLength(0); buf.append(session).append(" ").append(prefix); final int chunk = Math.min(data.remaining(), line.length); data.get(line, 0, chunk); for (int i = 0; i < chunk; i++) { final char ch = (char) line[i]; if (ch > Chars.SP && ch <= Chars.DEL) { buf.append(ch); } else if (Character.isWhitespace(ch)) { buf.append(' '); } else { buf.append('.'); } } for (int i = chunk; i < 17; i++) { buf.append(' '); } for (int i = 0; i < chunk; i++) { buf.append(' '); final int b = line[i] & 0xff; final String s = Integer.toHexString(b); if (s.length() == 1) { buf.append("0"); } buf.append(s); } wireLog.debug(buf.toString()); } } @Override public int read(final ByteBuffer dst) throws IOException { final int bytesRead = session.read(dst); if (log.isDebugEnabled()) { log.debug("{} {} bytes read", session, bytesRead); } if (bytesRead > 0 && wireLog.isDebugEnabled()) { final ByteBuffer b = dst.duplicate(); final int p = b.position(); b.limit(p); b.position(p - bytesRead); logData(b, "<< "); } return bytesRead; } @Override public int write(final ByteBuffer src) throws IOException { final int byteWritten = session.write(src); if (log.isDebugEnabled()) { log.debug("{} {} bytes written", session, byteWritten); } if (byteWritten > 0 && wireLog.isDebugEnabled()) { final ByteBuffer b = src.duplicate(); final int p = b.position(); b.limit(p); b.position(p - byteWritten); logData(b, ">> "); } return byteWritten; } @Override public String toString() { return session.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/MinimalH2AsyncClient.java0100664 0000000 0000000 00000030615 14704162040 030273 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.CancellationException; import java.util.concurrent.Future; import java.util.concurrent.ThreadFactory; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.config.Configurable; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.ExecSupport; import org.apache.hc.client5.http.impl.classic.RequestFailedException; import org.apache.hc.client5.http.impl.nio.MultihomeConnectionInitiator; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.Cancellable; import org.apache.hc.core5.concurrent.ComplexCancellable; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.nio.command.RequestExecutionCommand; import org.apache.hc.core5.http.nio.command.ShutdownCommand; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.DefaultConnectingIOReactor; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Minimal implementation of HTTP/2 only {@link CloseableHttpAsyncClient}. This client * is optimized for HTTP/2 multiplexing message transport and does not support advanced * HTTP protocol functionality such as request execution via a proxy, state management, * authentication and request redirects. *

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

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

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

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) @Internal public final class InternalH2AsyncClient extends InternalAbstractHttpAsyncClient { private static final Logger LOG = LoggerFactory.getLogger(InternalH2AsyncClient.class); private final HttpRoutePlanner routePlanner; private final InternalH2ConnPool connPool; InternalH2AsyncClient( final DefaultConnectingIOReactor ioReactor, final AsyncExecChainElement execChain, final AsyncPushConsumerRegistry pushConsumerRegistry, final ThreadFactory threadFactory, final InternalH2ConnPool connPool, final HttpRoutePlanner routePlanner, final Lookup cookieSpecRegistry, final Lookup authSchemeRegistry, final CookieStore cookieStore, final CredentialsProvider credentialsProvider, final RequestConfig defaultConfig, final List closeables) { super(ioReactor, pushConsumerRegistry, threadFactory, execChain, cookieSpecRegistry, authSchemeRegistry, cookieStore, credentialsProvider, HttpClientContext::castOrCreate, defaultConfig, closeables); this.connPool = connPool; this.routePlanner = routePlanner; } @Override AsyncExecRuntime createAsyncExecRuntime(final HandlerFactory pushHandlerFactory) { return new InternalH2AsyncExecRuntime(LOG, connPool, pushHandlerFactory); } @Override HttpRoute determineRoute(final HttpHost httpHost, final HttpRequest request, final HttpClientContext clientContext) throws HttpException { final HttpRoute route = routePlanner.determineRoute(httpHost, request, clientContext); if (route.isTunnelled()) { throw new HttpException("HTTP/2 tunneling not supported"); } return route; } } ././@LongLink0100644 0000000 0000000 00000000157 15005672035 011641 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncClientProtocolNegotiationStarter.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncClientProtocolNegotiationSt0100664 0000000 0000000 00000034167 15005672035 032757 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.util.Iterator; import java.util.List; import org.apache.hc.client5.http.impl.DefaultClientConnectionReuseStrategy; import org.apache.hc.core5.function.Callback; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.Http1StreamListener; import org.apache.hc.core5.http.impl.nio.ClientHttp1IOEventHandler; import org.apache.hc.core5.http.impl.nio.ClientHttp1StreamDuplexerFactory; import org.apache.hc.core5.http.impl.nio.DefaultHttpRequestWriterFactory; import org.apache.hc.core5.http.impl.nio.DefaultHttpResponseParserFactory; import org.apache.hc.core5.http.message.RequestLine; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.NHttpMessageParserFactory; import org.apache.hc.core5.http.nio.NHttpMessageWriterFactory; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.http2.frame.FramePrinter; import org.apache.hc.core5.http2.frame.RawFrame; import org.apache.hc.core5.http2.impl.nio.ClientH2PrefaceHandler; import org.apache.hc.core5.http2.impl.nio.ClientH2StreamMultiplexerFactory; import org.apache.hc.core5.http2.impl.nio.ClientH2UpgradeHandler; import org.apache.hc.core5.http2.impl.nio.ClientHttp1UpgradeHandler; import org.apache.hc.core5.http2.impl.nio.H2StreamListener; import org.apache.hc.core5.http2.impl.nio.HttpProtocolNegotiator; import org.apache.hc.core5.http2.ssl.ApplicationProtocol; import org.apache.hc.core5.reactor.IOEventHandler; import org.apache.hc.core5.reactor.IOEventHandlerFactory; import org.apache.hc.core5.reactor.ProtocolIOSession; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; class HttpAsyncClientProtocolNegotiationStarter implements IOEventHandlerFactory { private static final Logger STREAM_LOG = LoggerFactory.getLogger(InternalHttpAsyncClient.class); private static final Logger HEADER_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.headers"); private static final Logger FRAME_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.frame"); private static final Logger FRAME_PAYLOAD_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.frame.payload"); private static final Logger FLOW_CTRL_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http2.flow"); private final HttpProcessor httpProcessor; private final HandlerFactory exchangeHandlerFactory; private final H2Config h2Config; private final Http1Config h1Config; private final CharCodingConfig charCodingConfig; private final ConnectionReuseStrategy http1ConnectionReuseStrategy; private final NHttpMessageParserFactory http1ResponseParserFactory; private final NHttpMessageWriterFactory http1RequestWriterFactory; private final Callback exceptionCallback; HttpAsyncClientProtocolNegotiationStarter( final HttpProcessor httpProcessor, final HandlerFactory exchangeHandlerFactory, final H2Config h2Config, final Http1Config h1Config, final CharCodingConfig charCodingConfig, final ConnectionReuseStrategy connectionReuseStrategy, final Callback exceptionCallback) { this.httpProcessor = Args.notNull(httpProcessor, "HTTP processor"); this.exchangeHandlerFactory = exchangeHandlerFactory; this.h2Config = h2Config != null ? h2Config : H2Config.DEFAULT; this.h1Config = h1Config != null ? h1Config : Http1Config.DEFAULT; this.charCodingConfig = charCodingConfig != null ? charCodingConfig : CharCodingConfig.DEFAULT; this.http1ConnectionReuseStrategy = connectionReuseStrategy != null ? connectionReuseStrategy : DefaultClientConnectionReuseStrategy.INSTANCE; this.http1ResponseParserFactory = new DefaultHttpResponseParserFactory(h1Config); this.http1RequestWriterFactory = DefaultHttpRequestWriterFactory.INSTANCE; this.exceptionCallback = exceptionCallback; } @Override public IOEventHandler createHandler(final ProtocolIOSession ioSession, final Object attachment) { final ClientHttp1StreamDuplexerFactory http1StreamHandlerFactory; final ClientH2StreamMultiplexerFactory http2StreamHandlerFactory; if (STREAM_LOG.isDebugEnabled() || HEADER_LOG.isDebugEnabled() || FRAME_LOG.isDebugEnabled() || FRAME_PAYLOAD_LOG.isDebugEnabled() || FLOW_CTRL_LOG.isDebugEnabled()) { final String id = ioSession.getId(); http1StreamHandlerFactory = new ClientHttp1StreamDuplexerFactory( httpProcessor, h1Config, charCodingConfig, http1ConnectionReuseStrategy, http1ResponseParserFactory, http1RequestWriterFactory, new Http1StreamListener() { @Override public void onRequestHead(final HttpConnection connection, final HttpRequest request) { if (HEADER_LOG.isDebugEnabled()) { HEADER_LOG.debug("{} >> {}", id, new RequestLine(request)); for (final Iterator
it = request.headerIterator(); it.hasNext(); ) { HEADER_LOG.debug("{} >> {}", id, it.next()); } } } @Override public void onResponseHead(final HttpConnection connection, final HttpResponse response) { if (HEADER_LOG.isDebugEnabled()) { HEADER_LOG.debug("{} << {}", id, new StatusLine(response)); for (final Iterator
it = response.headerIterator(); it.hasNext(); ) { HEADER_LOG.debug("{} << {}", id, it.next()); } } } @Override public void onExchangeComplete(final HttpConnection connection, final boolean keepAlive) { if (STREAM_LOG.isDebugEnabled()) { if (keepAlive) { STREAM_LOG.debug("{} Connection is kept alive", id); } else { STREAM_LOG.debug("{} Connection is not kept alive", id); } } } }); http2StreamHandlerFactory = new ClientH2StreamMultiplexerFactory( httpProcessor, exchangeHandlerFactory, h2Config, charCodingConfig, new H2StreamListener() { final FramePrinter framePrinter = new FramePrinter(); private void logFrameInfo(final String prefix, final RawFrame frame) { try { final LogAppendable logAppendable = new LogAppendable(FRAME_LOG, prefix); framePrinter.printFrameInfo(frame, logAppendable); logAppendable.flush(); } catch (final IOException ignore) { } } private void logFramePayload(final String prefix, final RawFrame frame) { try { final LogAppendable logAppendable = new LogAppendable(FRAME_PAYLOAD_LOG, prefix); framePrinter.printPayload(frame, logAppendable); logAppendable.flush(); } catch (final IOException ignore) { } } private void logFlowControl(final String prefix, final int streamId, final int delta, final int actualSize) { FLOW_CTRL_LOG.debug("{} stream {} flow control {} -> {}", prefix, streamId, delta, actualSize); } @Override public void onHeaderInput(final HttpConnection connection, final int streamId, final List headers) { if (HEADER_LOG.isDebugEnabled()) { for (int i = 0; i < headers.size(); i++) { HEADER_LOG.debug("{} << {}", id, headers.get(i)); } } } @Override public void onHeaderOutput(final HttpConnection connection, final int streamId, final List headers) { if (HEADER_LOG.isDebugEnabled()) { for (int i = 0; i < headers.size(); i++) { HEADER_LOG.debug("{} >> {}", id, headers.get(i)); } } } @Override public void onFrameInput(final HttpConnection connection, final int streamId, final RawFrame frame) { if (FRAME_LOG.isDebugEnabled()) { logFrameInfo(id + " <<", frame); } if (FRAME_PAYLOAD_LOG.isDebugEnabled()) { logFramePayload(id + " <<", frame); } } @Override public void onFrameOutput(final HttpConnection connection, final int streamId, final RawFrame frame) { if (FRAME_LOG.isDebugEnabled()) { logFrameInfo(id + " >>", frame); } if (FRAME_PAYLOAD_LOG.isDebugEnabled()) { logFramePayload(id + " >>", frame); } } @Override public void onInputFlowControl(final HttpConnection connection, final int streamId, final int delta, final int actualSize) { if (FLOW_CTRL_LOG.isDebugEnabled()) { logFlowControl(id + " <<", streamId, delta, actualSize); } } @Override public void onOutputFlowControl(final HttpConnection connection, final int streamId, final int delta, final int actualSize) { if (FLOW_CTRL_LOG.isDebugEnabled()) { logFlowControl(id + " >>", streamId, delta, actualSize); } } }); } else { http1StreamHandlerFactory = new ClientHttp1StreamDuplexerFactory( httpProcessor, h1Config, charCodingConfig, http1ConnectionReuseStrategy, http1ResponseParserFactory, http1RequestWriterFactory, null); http2StreamHandlerFactory = new ClientH2StreamMultiplexerFactory( httpProcessor, exchangeHandlerFactory, h2Config, charCodingConfig, null); } ioSession.registerProtocol(ApplicationProtocol.HTTP_1_1.id, new ClientHttp1UpgradeHandler(http1StreamHandlerFactory)); ioSession.registerProtocol(ApplicationProtocol.HTTP_2.id, new ClientH2UpgradeHandler(http2StreamHandlerFactory, exceptionCallback)); final HttpVersionPolicy versionPolicy = attachment instanceof HttpVersionPolicy ? (HttpVersionPolicy) attachment : HttpVersionPolicy.NEGOTIATE; switch (versionPolicy) { case FORCE_HTTP_2: return new ClientH2PrefaceHandler(ioSession, http2StreamHandlerFactory, false, exceptionCallback); case FORCE_HTTP_1: return new ClientHttp1IOEventHandler(http1StreamHandlerFactory.create(ioSession)); default: return new HttpProtocolNegotiator(ioSession, null); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncExecChainElement.java0100664 0000000 0000000 00000004661 14666635064 030541 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.nio.AsyncEntityProducer; class AsyncExecChainElement { private final AsyncExecChainHandler handler; private final AsyncExecChainElement next; AsyncExecChainElement(final AsyncExecChainHandler handler, final AsyncExecChainElement next) { this.handler = handler; this.next = next; } public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { handler.execute(request, entityProducer, scope, next != null ? next::execute : null, asyncExecCallback); } @Override public String toString() { return "{" + "handler=" + handler.getClass() + ", next=" + (next != null ? next.handler.getClass() : "null") + '}'; } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/HttpAsyncMainClientExec.java0100664 0000000 0000000 00000031212 14740035240 031037 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.io.InterruptedIOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.async.AsyncExecRuntime; import org.apache.hc.client5.http.impl.ProtocolSwitchStrategy; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Usually the last HTTP/1.1 request execution handler in the asynchronous * request execution chain that is responsible for execution of * request/response exchanges with the opposite endpoint. * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal class HttpAsyncMainClientExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(HttpAsyncMainClientExec.class); private final HttpProcessor httpProcessor; private final ConnectionKeepAliveStrategy keepAliveStrategy; private final UserTokenHandler userTokenHandler; private final ProtocolSwitchStrategy protocolSwitchStrategy; HttpAsyncMainClientExec(final HttpProcessor httpProcessor, final ConnectionKeepAliveStrategy keepAliveStrategy, final UserTokenHandler userTokenHandler) { this.httpProcessor = Args.notNull(httpProcessor, "HTTP protocol processor"); this.keepAliveStrategy = keepAliveStrategy; this.userTokenHandler = userTokenHandler; this.protocolSwitchStrategy = new ProtocolSwitchStrategy(); } @Override public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final String exchangeId = scope.exchangeId; final HttpRoute route = scope.route; final CancellableDependency operation = scope.cancellableDependency; final HttpClientContext clientContext = scope.clientContext; final AsyncExecRuntime execRuntime = scope.execRuntime; if (LOG.isDebugEnabled()) { LOG.debug("{} executing {} {}", exchangeId, request.getMethod(), request.getRequestUri()); } final AtomicInteger messageCountDown = new AtomicInteger(2); final AsyncClientExchangeHandler internalExchangeHandler = new AsyncClientExchangeHandler() { private final AtomicReference entityConsumerRef = new AtomicReference<>(); @Override public void releaseResources() { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } } @Override public void failed(final Exception cause) { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.releaseResources(); } execRuntime.markConnectionNonReusable(); asyncExecCallback.failed(cause); } @Override public void cancel() { if (messageCountDown.get() > 0) { failed(new InterruptedIOException()); } } @Override public void produceRequest( final RequestChannel channel, final HttpContext context) throws HttpException, IOException { clientContext.setRoute(route); clientContext.setRequest(request); httpProcessor.process(request, entityProducer, clientContext); channel.sendRequest(request, entityProducer, context); if (entityProducer == null) { messageCountDown.decrementAndGet(); } } @Override public int available() { return entityProducer.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { entityProducer.produce(new DataStreamChannel() { @Override public void requestOutput() { channel.requestOutput(); } @Override public int write(final ByteBuffer src) throws IOException { return channel.write(src); } @Override public void endStream(final List trailers) throws IOException { channel.endStream(trailers); if (messageCountDown.decrementAndGet() <= 0) { asyncExecCallback.completed(); } } @Override public void endStream() throws IOException { channel.endStream(); if (messageCountDown.decrementAndGet() <= 0) { asyncExecCallback.completed(); } } }); } @Override public void consumeInformation( final HttpResponse response, final HttpContext context) throws HttpException, IOException { if (response.getCode() == HttpStatus.SC_SWITCHING_PROTOCOLS) { final ProtocolVersion upgradeProtocol = protocolSwitchStrategy.switchProtocol(response); if (upgradeProtocol == null || !upgradeProtocol.getProtocol().equals("TLS")) { throw new ProtocolException("Failure switching protocols"); } if (LOG.isDebugEnabled()) { LOG.debug("Switching to {}", upgradeProtocol); } execRuntime.upgradeTls(clientContext, new FutureCallback() { @Override public void completed(final AsyncExecRuntime result) { LOG.debug("Successfully switched to {}", upgradeProtocol); } @Override public void failed(final Exception ex) { asyncExecCallback.failed(ex); } @Override public void cancelled() { asyncExecCallback.failed(new InterruptedIOException()); } }); } else { asyncExecCallback.handleInformationResponse(response); } } @Override public void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { clientContext.setResponse(response); httpProcessor.process(response, entityDetails, clientContext); entityConsumerRef.set(asyncExecCallback.handleResponse(response, entityDetails)); if (response.getCode() >= HttpStatus.SC_CLIENT_ERROR) { messageCountDown.decrementAndGet(); } final TimeValue keepAliveDuration = keepAliveStrategy.getKeepAliveDuration(response, clientContext); Object userToken = clientContext.getUserToken(); if (userToken == null) { userToken = userTokenHandler.getUserToken(route, request, clientContext); clientContext.setUserToken(userToken); } execRuntime.markConnectionReusable(userToken, keepAliveDuration); if (entityDetails == null) { execRuntime.validateConnection(); if (messageCountDown.decrementAndGet() <= 0) { asyncExecCallback.completed(); } } } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.updateCapacity(capacityChannel); } else { capacityChannel.update(Integer.MAX_VALUE); } } @Override public void consume(final ByteBuffer src) throws IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.get(); if (entityConsumer != null) { entityConsumer.consume(src); } } @Override public void streamEnd(final List trailers) throws HttpException, IOException { final AsyncDataConsumer entityConsumer = entityConsumerRef.getAndSet(null); if (entityConsumer != null) { entityConsumer.streamEnd(trailers); } else { execRuntime.validateConnection(); } if (messageCountDown.decrementAndGet() <= 0) { asyncExecCallback.completed(); } } }; if (LOG.isDebugEnabled()) { operation.setDependency(execRuntime.execute( exchangeId, new LoggingAsyncClientExchangeHandler(LOG, exchangeId, internalExchangeHandler), clientContext)); } else { operation.setDependency(execRuntime.execute(exchangeId, internalExchangeHandler, clientContext)); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/AsyncRedirectExec.java0100664 0000000 0000000 00000032462 15005672035 027731 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import java.io.IOException; import java.net.URI; import java.util.Objects; import org.apache.hc.client5.http.CircularRedirectException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RedirectException; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectLocations; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.client5.http.utils.URIUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Request execution handler in the asynchronous request execution chain * responsible for handling of request redirects. *

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

* * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) @Internal public final class AsyncRedirectExec implements AsyncExecChainHandler { private static final Logger LOG = LoggerFactory.getLogger(AsyncRedirectExec.class); private final HttpRoutePlanner routePlanner; private final RedirectStrategy redirectStrategy; AsyncRedirectExec(final HttpRoutePlanner routePlanner, final RedirectStrategy redirectStrategy) { this.routePlanner = routePlanner; this.redirectStrategy = redirectStrategy; } private static class State { volatile URI redirectURI; volatile int maxRedirects; volatile int redirectCount; volatile HttpRequest currentRequest; volatile AsyncEntityProducer currentEntityProducer; volatile RedirectLocations redirectLocations; volatile AsyncExecChain.Scope currentScope; volatile boolean reroute; } private void internalExecute( final State state, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final HttpRequest request = state.currentRequest; final AsyncEntityProducer entityProducer = state.currentEntityProducer; final AsyncExecChain.Scope scope = state.currentScope; final HttpClientContext clientContext = scope.clientContext; final String exchangeId = scope.exchangeId; chain.proceed(request, entityProducer, scope, new AsyncExecCallback() { @Override public AsyncDataConsumer handleResponse( final HttpResponse response, final EntityDetails entityDetails) throws HttpException, IOException { state.redirectURI = null; final RequestConfig config = clientContext.getRequestConfigOrDefault(); if (config.isRedirectsEnabled() && redirectStrategy.isRedirected(request, response, clientContext)) { if (state.redirectCount >= state.maxRedirects) { throw new RedirectException("Maximum redirects (" + state.maxRedirects + ") exceeded"); } state.redirectCount++; final URI redirectUri = redirectStrategy.getLocationURI(request, response, clientContext); if (LOG.isDebugEnabled()) { LOG.debug("{} redirect requested to location '{}'", exchangeId, redirectUri); } if (!config.isCircularRedirectsAllowed()) { if (state.redirectLocations.contains(redirectUri)) { throw new CircularRedirectException("Circular redirect to '" + redirectUri + "'"); } } final AsyncExecChain.Scope currentScope = state.currentScope; final HttpHost newTarget = URIUtils.extractHost(redirectUri); if (newTarget == null) { throw new ProtocolException("Redirect URI does not specify a valid host name: " + redirectUri); } final int statusCode = response.getCode(); final BasicRequestBuilder redirectBuilder; switch (statusCode) { case HttpStatus.SC_MOVED_PERMANENTLY: case HttpStatus.SC_MOVED_TEMPORARILY: if (Method.POST.isSame(request.getMethod())) { redirectBuilder = BasicRequestBuilder.get(); state.currentEntityProducer = null; } else { redirectBuilder = BasicRequestBuilder.copy(currentScope.originalRequest); } break; case HttpStatus.SC_SEE_OTHER: if (!Method.GET.isSame(request.getMethod()) && !Method.HEAD.isSame(request.getMethod())) { redirectBuilder = BasicRequestBuilder.get(); state.currentEntityProducer = null; } else { redirectBuilder = BasicRequestBuilder.copy(currentScope.originalRequest); } break; default: redirectBuilder = BasicRequestBuilder.copy(currentScope.originalRequest); } redirectBuilder.setUri(redirectUri); final BasicHttpRequest redirect = redirectBuilder.build(); final HttpRoute currentRoute = currentScope.route; final HttpHost currentHost = currentRoute.getTargetHost(); if (!redirectStrategy.isRedirectAllowed(currentHost, newTarget, redirect, clientContext)) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot redirect due to safety restrictions", exchangeId); } return asyncExecCallback.handleResponse(response, entityDetails); } state.redirectLocations.add(redirectUri); state.reroute = false; state.redirectURI = redirectUri; state.currentRequest = redirect; final HttpRoute newRoute; if (!Objects.equals(currentHost, newTarget)) { newRoute = routePlanner.determineRoute(newTarget, clientContext); if (!Objects.equals(currentRoute, newRoute)) { state.reroute = true; final AuthExchange targetAuthExchange = clientContext.getAuthExchange(currentHost); if (LOG.isDebugEnabled()) { LOG.debug("{} resetting target auth state", exchangeId); } targetAuthExchange.reset(); if (currentRoute.getProxyHost() != null) { final AuthExchange proxyAuthExchange = clientContext.getAuthExchange(currentRoute.getProxyHost()); if (proxyAuthExchange.isConnectionBased()) { if (LOG.isDebugEnabled()) { LOG.debug("{} resetting proxy auth state", exchangeId); } proxyAuthExchange.reset(); } } } } else { newRoute = currentRoute; } state.currentScope = new AsyncExecChain.Scope( scope.exchangeId, newRoute, BasicRequestBuilder.copy(redirect).build(), scope.cancellableDependency, scope.clientContext, scope.execRuntime, scope.scheduler, scope.execCount); if (LOG.isDebugEnabled()) { LOG.debug("{} redirecting to '{}' via {}", exchangeId, redirectUri, newRoute); } return null; } return asyncExecCallback.handleResponse(response, entityDetails); } @Override public void handleInformationResponse( final HttpResponse response) throws HttpException, IOException { asyncExecCallback.handleInformationResponse(response); } @Override public void completed() { if (state.redirectURI == null) { asyncExecCallback.completed(); } else { final AsyncEntityProducer entityProducer = state.currentEntityProducer; if (entityProducer != null) { entityProducer.releaseResources(); } if (entityProducer != null && !entityProducer.isRepeatable()) { if (LOG.isDebugEnabled()) { LOG.debug("{} cannot redirect non-repeatable request", exchangeId); } asyncExecCallback.completed(); } else { try { if (state.reroute) { scope.execRuntime.releaseEndpoint(); } internalExecute(state, chain, asyncExecCallback); } catch (final IOException | HttpException ex) { asyncExecCallback.failed(ex); } } } } @Override public void failed(final Exception cause) { asyncExecCallback.failed(cause); } }); } @Override public void execute( final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { final HttpClientContext clientContext = scope.clientContext; RedirectLocations redirectLocations = clientContext.getRedirectLocations(); if (redirectLocations == null) { redirectLocations = new RedirectLocations(); clientContext.setRedirectLocations(redirectLocations); } redirectLocations.clear(); final RequestConfig config = clientContext.getRequestConfigOrDefault(); final State state = new State(); state.maxRedirects = config.getMaxRedirects() > 0 ? config.getMaxRedirects() : 50; state.redirectCount = 0; state.currentRequest = request; state.currentEntityProducer = entityProducer; state.redirectLocations = redirectLocations; state.currentScope = scope; internalExecute(state, chain, asyncExecCallback); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/async/LoggingExceptionCallback.java0100664 0000000 0000000 00000003435 14704162040 031240 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.async; import org.apache.hc.core5.function.Callback; import org.slf4j.Logger; import org.slf4j.LoggerFactory; class LoggingExceptionCallback implements Callback { /** * Singleton instance of LoggingExceptionCallback. */ static final LoggingExceptionCallback INSTANCE = new LoggingExceptionCallback(); private static final Logger LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.impl.async"); private LoggingExceptionCallback() { } @Override public void execute(final Exception ex) { LOG.error(ex.getMessage(), ex); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ConnectionHolder.java0100664 0000000 0000000 00000002707 15063503617 026507 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.HttpConnection; /** * Internal interface to expose the underlying connection * @since 5.5 */ @Internal public interface ConnectionHolder { HttpConnection get(); } httpclient5/src/main/java/org/apache/hc/client5/http/impl/InMemoryDnsResolver.java0100664 0000000 0000000 00000007243 15005672016 027174 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.net.InetAddress; import java.net.UnknownHostException; import java.util.Arrays; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * In-memory {@link DnsResolver} implementation. * * @since 4.2 */ @Contract(threading = ThreadingBehavior.STATELESS) public class InMemoryDnsResolver implements DnsResolver { /** Logger associated to this class. */ private static final Logger LOG = LoggerFactory.getLogger(InMemoryDnsResolver.class); /** * In-memory collection that will hold the associations between a host name * and an array of InetAddress instances. */ private final Map dnsMap; /** * Builds a DNS resolver that will resolve the host names against a * collection held in-memory. */ public InMemoryDnsResolver() { dnsMap = new ConcurrentHashMap<>(); } /** * Associates the given array of IP addresses to the given host in this DNS overrider. * The IP addresses are assumed to be already resolved. * * @param host * The host name to be associated with the given IP. * @param ips * array of IP addresses to be resolved by this DNS overrider to the given * host name. */ public void add(final String host, final InetAddress... ips) { Args.notNull(host, "Host name"); Args.notNull(ips, "Array of IP addresses"); dnsMap.put(host, ips); } /** * {@inheritDoc} */ @Override public InetAddress[] resolve(final String host) throws UnknownHostException { final InetAddress[] resolvedAddresses = dnsMap.get(host); if (LOG.isInfoEnabled()) { LOG.info("Resolving {} to {}", host, Arrays.deepToString(resolvedAddresses)); } if (resolvedAddresses == null) { throw new UnknownHostException(host); } return resolvedAddresses; } @Override public String resolveCanonicalHostname(final String host) throws UnknownHostException { final InetAddress[] resolvedAddresses = resolve(host); if (resolvedAddresses.length > 0) { return resolvedAddresses[0].getCanonicalHostName(); } return host; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/0040775 0000000 0000000 00000000000 15063503637 023173 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/package-info.java0100664 0000000 0000000 00000002466 14666635064 026377 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client connection management functions based the asynchronous * connection management APIs. */ package org.apache.hc.client5.http.impl.nio; ././@LongLink0100644 0000000 0000000 00000000147 15063503637 011645 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManager.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/nio/PoolingAsyncClientConnectionManager.ja0100664 0000000 0000000 00000103541 15063503637 032567 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.nio; import java.util.Set; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.ConnectionHolder; import org.apache.hc.client5.http.impl.ConnectionShutdownException; import org.apache.hc.client5.http.impl.PrefixedIncrementingId; import org.apache.hc.client5.http.nio.AsyncClientConnectionManager; import org.apache.hc.client5.http.nio.AsyncClientConnectionOperator; import org.apache.hc.client5.http.nio.AsyncConnectionEndpoint; import org.apache.hc.client5.http.nio.ManagedAsyncClientConnection; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.BasicFuture; import org.apache.hc.core5.concurrent.CallbackContribution; import org.apache.hc.core5.concurrent.ComplexFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.HandlerFactory; import org.apache.hc.core5.http.nio.command.RequestExecutionCommand; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.nio.command.PingCommand; import org.apache.hc.core5.http2.nio.support.BasicPingHandler; import org.apache.hc.core5.http2.ssl.ApplicationProtocol; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.pool.DefaultDisposalCallback; import org.apache.hc.core5.pool.LaxConnPool; import org.apache.hc.core5.pool.ManagedConnPool; import org.apache.hc.core5.pool.PoolConcurrencyPolicy; import org.apache.hc.core5.pool.PoolEntry; import org.apache.hc.core5.pool.PoolReusePolicy; import org.apache.hc.core5.pool.PoolStats; import org.apache.hc.core5.pool.StrictConnPool; import org.apache.hc.core5.reactor.Command; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.ProtocolIOSession; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Deadline; import org.apache.hc.core5.util.Identifiable; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * {@code PoolingAsyncClientConnectionManager} maintains a pool of non-blocking * {@link org.apache.hc.core5.http.HttpConnection}s and is able to service * connection requests from multiple execution threads. Connections are pooled * on a per route basis. A request for a route which already the manager has * persistent connections for available in the pool will be services by leasing * a connection from the pool rather than creating a new connection. *

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

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

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

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

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

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

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

* This feature is considered experimenal * * @since 5.5 * @return this instance. */ @Experimental public final PoolingAsyncClientConnectionManagerBuilder setMessageMultiplexing(final boolean messageMultiplexing) { this.messageMultiplexing = messageMultiplexing; return this; } @Internal protected AsyncClientConnectionOperator createConnectionOperator( final TlsStrategy tlsStrategy, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver) { return new DefaultAsyncClientConnectionOperator( RegistryBuilder.create() .register(URIScheme.HTTPS.getId(), tlsStrategy) .build(), schemePortResolver, dnsResolver); } public PoolingAsyncClientConnectionManager build() { final TlsStrategy tlsStrategyCopy; if (tlsStrategy != null) { tlsStrategyCopy = tlsStrategy; } else { if (ReflectionUtils.determineJRELevel() <= 8 && ConscryptClientTlsStrategy.isSupported()) { if (systemProperties) { tlsStrategyCopy = ConscryptClientTlsStrategy.getSystemDefault(); } else { tlsStrategyCopy = ConscryptClientTlsStrategy.getDefault(); } } else { if (systemProperties) { tlsStrategyCopy = DefaultClientTlsStrategy.createSystemDefault(); } else { tlsStrategyCopy = DefaultClientTlsStrategy.createDefault(); } } } final PoolingAsyncClientConnectionManager poolingmgr = new PoolingAsyncClientConnectionManager( createConnectionOperator(tlsStrategyCopy, schemePortResolver, dnsResolver), poolConcurrencyPolicy, poolReusePolicy, null, messageMultiplexing); poolingmgr.setConnectionConfigResolver(connectionConfigResolver); poolingmgr.setTlsConfigResolver(tlsConfigResolver); if (maxConnTotal > 0) { poolingmgr.setMaxTotal(maxConnTotal); } if (maxConnPerRoute > 0) { poolingmgr.setDefaultMaxPerRoute(maxConnPerRoute); } return poolingmgr; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/RequestSupport.java0100664 0000000 0000000 00000005112 14764633120 026270 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.net.URISyntaxException; import java.nio.charset.StandardCharsets; import java.util.List; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.net.PercentCodec; import org.apache.hc.core5.net.URIBuilder; /** * Protocol support methods. For internal use only. * * @since 5.2 */ @Internal public final class RequestSupport { public static String extractPathPrefix(final HttpRequest request) { final String path = request.getPath(); try { final URIBuilder uriBuilder = new URIBuilder(path); uriBuilder.setFragment(null); uriBuilder.clearParameters(); uriBuilder.optimize(); final List pathSegments = uriBuilder.getPathSegments(); if (!pathSegments.isEmpty()) { pathSegments.remove(pathSegments.size() - 1); } if (pathSegments.isEmpty()) { return "/"; } final StringBuilder buf = new StringBuilder(); buf.append('/'); for (final String pathSegment : pathSegments) { PercentCodec.encode(buf, pathSegment, StandardCharsets.US_ASCII); buf.append('/'); } return buf.toString(); } catch (final URISyntaxException ex) { return path; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/IdleConnectionEvictor.java0100664 0000000 0000000 00000007326 15005672016 027501 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.concurrent.ThreadFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.DefaultThreadFactory; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * This class maintains a background thread to enforce an eviction policy for expired / idle * persistent connections kept alive in the connection pool. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public final class IdleConnectionEvictor { private final ThreadFactory threadFactory; private final Thread thread; public IdleConnectionEvictor(final ConnPoolControl connectionManager, final ThreadFactory threadFactory, final TimeValue sleepTime, final TimeValue maxIdleTime) { Args.notNull(connectionManager, "Connection manager"); this.threadFactory = threadFactory != null ? threadFactory : new DefaultThreadFactory("idle-connection-evictor", true); final TimeValue localSleepTime = sleepTime != null ? sleepTime : TimeValue.ofSeconds(5); this.thread = this.threadFactory.newThread(() -> { try { while (!Thread.currentThread().isInterrupted()) { localSleepTime.sleep(); connectionManager.closeExpired(); if (maxIdleTime != null) { connectionManager.closeIdle(maxIdleTime); } } } catch (final InterruptedException ex) { Thread.currentThread().interrupt(); } catch (final Exception ignore) { } }); } public IdleConnectionEvictor(final ConnPoolControl connectionManager, final TimeValue sleepTime, final TimeValue maxIdleTime) { this(connectionManager, null, sleepTime, maxIdleTime); } public IdleConnectionEvictor(final ConnPoolControl connectionManager, final TimeValue maxIdleTime) { this(connectionManager, null, maxIdleTime, maxIdleTime); } public void start() { thread.start(); } public void shutdown() { thread.interrupt(); } public boolean isRunning() { return thread.isAlive(); } public void awaitTermination(final Timeout timeout) throws InterruptedException { thread.join(timeout != null ? timeout.toMilliseconds() : Long.MAX_VALUE); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ProtocolSwitchStrategy.java0100664 0000000 0000000 00000014243 15005672035 027753 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.Iterator; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.FormattedHeader; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpMessage; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.ProtocolVersionParser; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.Tokenizer; /** * Protocol switch handler. * * @since 5.4 */ @Internal public final class ProtocolSwitchStrategy { private static final ProtocolVersionParser PROTOCOL_VERSION_PARSER = ProtocolVersionParser.INSTANCE; private static final Tokenizer TOKENIZER = Tokenizer.INSTANCE; private static final Tokenizer.Delimiter UPGRADE_TOKEN_DELIMITER = Tokenizer.delimiters(','); private static final Tokenizer.Delimiter LAX_PROTO_DELIMITER = Tokenizer.delimiters('/', ','); @FunctionalInterface private interface HeaderConsumer { void accept(CharSequence buffer, ParserCursor cursor) throws ProtocolException; } public ProtocolVersion switchProtocol(final HttpMessage response) throws ProtocolException { final AtomicReference tlsUpgrade = new AtomicReference<>(); parseHeaders(response, HttpHeaders.UPGRADE, (buffer, cursor) -> { final ProtocolVersion protocolVersion = parseProtocolVersion(buffer, cursor); if (protocolVersion != null) { if ("TLS".equalsIgnoreCase(protocolVersion.getProtocol())) { tlsUpgrade.set(protocolVersion); } else if (!protocolVersion.equals(HttpVersion.HTTP_1_1)) { throw new ProtocolException("Unsupported protocol or HTTP version: " + protocolVersion); } } }); final ProtocolVersion result = tlsUpgrade.get(); if (result != null) { return result; } else { throw new ProtocolException("Invalid protocol switch response: no TLS version found"); } } private ProtocolVersion parseProtocolVersion(final CharSequence buffer, final ParserCursor cursor) throws ProtocolException { TOKENIZER.skipWhiteSpace(buffer, cursor); final String proto = TOKENIZER.parseToken(buffer, cursor, LAX_PROTO_DELIMITER); if (!cursor.atEnd()) { final char ch = buffer.charAt(cursor.getPos()); if (ch == '/') { if (proto.isEmpty()) { throw new ParseException("Invalid protocol", buffer, cursor.getLowerBound(), cursor.getUpperBound(), cursor.getPos()); } cursor.updatePos(cursor.getPos() + 1); return PROTOCOL_VERSION_PARSER.parse(proto, null, buffer, cursor, UPGRADE_TOKEN_DELIMITER); } } if (proto.isEmpty()) { return null; } else if (proto.equalsIgnoreCase("TLS")) { return TLS.V_1_2.getVersion(); } else { throw new ProtocolException("Unsupported or invalid protocol: " + proto); } } private void parseHeaders(final HttpMessage message, final String name, final HeaderConsumer consumer) throws ProtocolException { final Iterator

it = message.headerIterator(name); while (it.hasNext()) { parseHeader(it.next(), consumer); } } private void parseHeader(final Header header, final HeaderConsumer consumer) throws ProtocolException { Args.notNull(header, "Header"); if (header instanceof FormattedHeader) { final CharArrayBuffer buf = ((FormattedHeader) header).getBuffer(); final ParserCursor cursor = new ParserCursor(0, buf.length()); cursor.updatePos(((FormattedHeader) header).getValuePos()); parseHeaderElements(buf, cursor, consumer); } else { final String value = header.getValue(); if (value == null) { return; } final ParserCursor cursor = new ParserCursor(0, value.length()); parseHeaderElements(value, cursor, consumer); } } private void parseHeaderElements(final CharSequence buffer, final ParserCursor cursor, final HeaderConsumer consumer) throws ProtocolException { while (!cursor.atEnd()) { consumer.accept(buffer, cursor); if (!cursor.atEnd()) { final char ch = buffer.charAt(cursor.getPos()); if (ch == ',') { cursor.updatePos(cursor.getPos() + 1); } } } } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/ExecSupport.java0100664 0000000 0000000 00000003223 14666635064 025537 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.annotation.Internal; /** * Request execution support methods. * * @since 5.0 */ @Internal public final class ExecSupport { private static final PrefixedIncrementingId INCREMENTING_ID = new PrefixedIncrementingId("ex-"); public static long getNextExecNumber() { return INCREMENTING_ID.getNextNumber(); } public static String getNextExchangeId() { return INCREMENTING_ID.getNextId(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/RequestCopier.java0100664 0000000 0000000 00000004416 14704162040 026033 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.Iterator; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.message.BasicHttpRequest; /** * {@link HttpRequest} copier. * * @since 5.0 * * @deprecated Use {@link org.apache.hc.core5.http.support.BasicRequestBuilder} */ @Deprecated public final class RequestCopier implements MessageCopier { /** * Default instance of {@link RequestCopier}. */ public static final RequestCopier INSTANCE = new RequestCopier(); @Override public HttpRequest copy(final HttpRequest original) { if (original == null) { return null; } final BasicHttpRequest copy = new BasicHttpRequest(original.getMethod(), null, original.getPath()); copy.setScheme(original.getScheme()); copy.setAuthority(original.getAuthority()); copy.setVersion(original.getVersion()); for (final Iterator
it = original.headerIterator(); it.hasNext(); ) { copy.addHeader(it.next()); } return copy; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/Wire.java0100664 0000000 0000000 00000012731 15005672016 024152 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.nio.ByteBuffer; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; @Internal public class Wire { private static final int MAX_STRING_BUILDER_SIZE = 2048; private static final ThreadLocal THREAD_LOCAL = new ThreadLocal<>(); /** * Returns a {@code StringBuilder} that this Layout implementation can use to write the formatted log event to. * * @return a {@code StringBuilder} */ private static StringBuilder getStringBuilder() { StringBuilder result = THREAD_LOCAL.get(); if (result == null) { result = new StringBuilder(MAX_STRING_BUILDER_SIZE); THREAD_LOCAL.set(result); } trimToMaxSize(result, MAX_STRING_BUILDER_SIZE); result.setLength(0); return result; } /** * Ensures that the char[] array of the specified StringBuilder does not exceed the specified number of characters. * This method is useful to ensure that excessively long char[] arrays are not kept in memory forever. * * @param stringBuilder the StringBuilder to check * @param maxSize the maximum number of characters the StringBuilder is allowed to have */ private static void trimToMaxSize(final StringBuilder stringBuilder, final int maxSize) { if (stringBuilder != null && stringBuilder.capacity() > maxSize) { stringBuilder.setLength(maxSize); stringBuilder.trimToSize(); } } private final Logger log; private final String id; public Wire(final Logger log, final String id) { super(); this.log = log; this.id = id; } private void wire(final String header, final byte[] b, final int pos, final int off) { final StringBuilder buffer = getStringBuilder(); for (int i = 0; i < off; i++) { final int ch = b[pos + i]; if (ch == 13) { buffer.append("[\\r]"); } else if (ch == 10) { buffer.append("[\\n]\""); buffer.insert(0, "\""); buffer.insert(0, header); log.debug("{} {}", this.id, buffer); buffer.setLength(0); } else if (ch < 32 || ch >= 127) { buffer.append("[0x"); buffer.append(Integer.toHexString(ch)); buffer.append("]"); } else { buffer.append((char) ch); } } if (buffer.length() > 0) { buffer.append('\"'); buffer.insert(0, '\"'); buffer.insert(0, header); log.debug("{} {}", this.id, buffer); } } public boolean isEnabled() { return log.isDebugEnabled(); } public void output(final byte[] b, final int pos, final int off) { Args.notNull(b, "Output"); wire(">> ", b, pos, off); } public void input(final byte[] b, final int pos, final int off) { Args.notNull(b, "Input"); wire("<< ", b, pos, off); } public void output(final byte[] b) { Args.notNull(b, "Output"); output(b, 0, b.length); } public void input(final byte[] b) { Args.notNull(b, "Input"); input(b, 0, b.length); } public void output(final int b) { output(new byte[] {(byte) b}); } public void input(final int b) { input(new byte[] {(byte) b}); } public void output(final String s) { Args.notNull(s, "Output"); output(s.getBytes()); } public void input(final String s) { Args.notNull(s, "Input"); input(s.getBytes()); } public void output(final ByteBuffer b) { Args.notNull(b, "Output"); if (b.hasArray()) { output(b.array(), b.arrayOffset() + b.position(), b.remaining()); } else { final byte[] tmp = new byte[b.remaining()]; b.get(tmp); output(tmp); } } public void input(final ByteBuffer b) { Args.notNull(b, "Input"); if (b.hasArray()) { input(b.array(), b.arrayOffset() + b.position(), b.remaining()); } else { final byte[] tmp = new byte[b.remaining()]; b.get(tmp); input(tmp); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/MessageCopier.java0100664 0000000 0000000 00000002750 14704162040 025766 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.http.HttpMessage; /** * Abstract HTTP message copier. * * @param The type of {@link HttpMessage}. * @since 5.0 * * @deprecated Use message builders. */ @Deprecated public interface MessageCopier { T copy(T object); } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/0040775 0000000 0000000 00000000000 15063503637 023015 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/package-info.java0100664 0000000 0000000 00000002460 14666635064 026213 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client connection management functions based the classic * connection management APIs. */ package org.apache.hc.client5.http.impl.io; ././@LongLink0100644 0000000 0000000 00000000145 15063503632 011636 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/DefaultManagedHttpClientConnection.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/io/DefaultManagedHttpClientConnection.java0100664 0000000 0000000 00000020453 15063503632 032534 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.io.InterruptedIOException; import java.net.Socket; import java.nio.charset.CharsetDecoder; import java.nio.charset.CharsetEncoder; import java.util.concurrent.atomic.AtomicBoolean; import javax.net.ssl.SSLSession; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ContentLengthStrategy; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.io.DefaultBHttpClientConnection; import org.apache.hc.core5.http.impl.io.SocketHolder; import org.apache.hc.core5.http.io.HttpMessageParserFactory; import org.apache.hc.core5.http.io.HttpMessageWriterFactory; import org.apache.hc.core5.http.io.ResponseOutOfOrderStrategy; import org.apache.hc.core5.http.message.RequestLine; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Identifiable; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; final class DefaultManagedHttpClientConnection extends DefaultBHttpClientConnection implements ManagedHttpClientConnection, Identifiable { private static final Logger LOG = LoggerFactory.getLogger(DefaultManagedHttpClientConnection.class); private static final Logger HEADER_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.headers"); private static final Logger WIRE_LOG = LoggerFactory.getLogger("org.apache.hc.client5.http.wire"); private final String id; private final AtomicBoolean closed; private Timeout socketTimeout; public DefaultManagedHttpClientConnection( final String id, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder, final Http1Config h1Config, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy, final ResponseOutOfOrderStrategy responseOutOfOrderStrategy, final HttpMessageWriterFactory requestWriterFactory, final HttpMessageParserFactory responseParserFactory) { super( h1Config, charDecoder, charEncoder, incomingContentStrategy, outgoingContentStrategy, responseOutOfOrderStrategy, requestWriterFactory, responseParserFactory); this.id = id; this.closed = new AtomicBoolean(); } public DefaultManagedHttpClientConnection( final String id, final CharsetDecoder charDecoder, final CharsetEncoder charEncoder, final Http1Config h1Config, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy, final HttpMessageWriterFactory requestWriterFactory, final HttpMessageParserFactory responseParserFactory) { this( id, charDecoder, charEncoder, h1Config, incomingContentStrategy, outgoingContentStrategy, null, requestWriterFactory, responseParserFactory); } public DefaultManagedHttpClientConnection(final String id) { this(id, null, null, null, null, null, null, null); } @Override public String getId() { return this.id; } @Override public void bind(final SocketHolder socketHolder) throws IOException { if (this.closed.get()) { final Socket socket = socketHolder.getSocket(); socket.close(); // allow this to throw... // ...but if it doesn't, explicitly throw one ourselves. throw new InterruptedIOException("Connection already shutdown"); } super.bind(socketHolder); socketTimeout = Timeout.ofMilliseconds(socketHolder.getSocket().getSoTimeout()); } @Override public Socket getSocket() { final SocketHolder socketHolder = getSocketHolder(); return socketHolder != null ? socketHolder.getSocket() : null; } @Override public SSLSession getSSLSession() { final Socket socket = getSocket(); if (socket instanceof SSLSocket) { return ((SSLSocket) socket).getSession(); } return null; } @Override public void close() throws IOException { if (this.closed.compareAndSet(false, true)) { if (LOG.isDebugEnabled()) { LOG.debug("{} Close connection", this.id); } super.close(); } } @Override public void setSocketTimeout(final Timeout timeout) { if (LOG.isDebugEnabled()) { LOG.debug("{} set socket timeout to {}", this.id, timeout); } super.setSocketTimeout(timeout); socketTimeout = timeout; } @Override public void close(final CloseMode closeMode) { if (this.closed.compareAndSet(false, true)) { if (LOG.isDebugEnabled()) { LOG.debug("{} close connection {}", this.id, closeMode); } super.close(closeMode); } } @Override public void bind(final Socket socket) throws IOException { super.bind(WIRE_LOG.isDebugEnabled() ? new LoggingSocketHolder(socket, this.id, WIRE_LOG) : new SocketHolder(socket)); socketTimeout = Timeout.ofMilliseconds(socket.getSoTimeout()); } @Override public void bind(final SSLSocket sslSocket, final Socket socket) throws IOException { super.bind(WIRE_LOG.isDebugEnabled() ? new LoggingSocketHolder(sslSocket, socket, this.id, WIRE_LOG) : new SocketHolder(sslSocket, socket)); socketTimeout = Timeout.ofMilliseconds(sslSocket.getSoTimeout()); } @Override protected void onResponseReceived(final ClassicHttpResponse response) { if (response != null && HEADER_LOG.isDebugEnabled()) { HEADER_LOG.debug("{} << {}", this.id, new StatusLine(response)); final Header[] headers = response.getHeaders(); for (final Header header : headers) { HEADER_LOG.debug("{} << {}", this.id, header); } } } @Override protected void onRequestSubmitted(final ClassicHttpRequest request) { if (request != null && HEADER_LOG.isDebugEnabled()) { HEADER_LOG.debug("{} >> {}", this.id, new RequestLine(request)); final Header[] headers = request.getHeaders(); for (final Header header : headers) { HEADER_LOG.debug("{} >> {}", this.id, header); } } } @Override public void passivate() { super.setSocketTimeout(Timeout.ZERO_MILLISECONDS); } @Override public void activate() { super.setSocketTimeout(socketTimeout); } } ././@LongLink0100644 0000000 0000000 00000000154 15063503632 011636 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManagerBuilder.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManagerBuild0100664 0000000 0000000 00000030116 15063503632 032632 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.io.HttpClientConnectionOperator; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.pool.PoolConcurrencyPolicy; import org.apache.hc.core5.pool.PoolReusePolicy; import org.apache.hc.core5.util.TimeValue; /** * Builder for {@link PoolingHttpClientConnectionManager} instances. *

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

*
    *
  • ssl.TrustManagerFactory.algorithm
    • *
  • javax.net.ssl.trustStoreType
    • *
  • javax.net.ssl.trustStore
    • *
  • javax.net.ssl.trustStoreProvider
    • *
  • javax.net.ssl.trustStorePassword
    • *
  • ssl.KeyManagerFactory.algorithm
    • *
  • javax.net.ssl.keyStoreType
    • *
  • javax.net.ssl.keyStore
    • *
  • javax.net.ssl.keyStoreProvider
    • *
  • javax.net.ssl.keyStorePassword
    • *
  • https.protocols
    • *
  • https.cipherSuites
    • *
* * @since 5.0 */ public class PoolingHttpClientConnectionManagerBuilder { private HttpConnectionFactory connectionFactory; private TlsSocketStrategy tlsSocketStrategy; private SchemePortResolver schemePortResolver; private DnsResolver dnsResolver; private PoolConcurrencyPolicy poolConcurrencyPolicy; private PoolReusePolicy poolReusePolicy; private Resolver socketConfigResolver; private Resolver connectionConfigResolver; private Resolver tlsConfigResolver; private boolean systemProperties; private int maxConnTotal; private int maxConnPerRoute; public static PoolingHttpClientConnectionManagerBuilder create() { return new PoolingHttpClientConnectionManagerBuilder(); } @Internal protected PoolingHttpClientConnectionManagerBuilder() { super(); } /** * Sets {@link HttpConnectionFactory} instance. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setConnectionFactory( final HttpConnectionFactory connectionFactory) { this.connectionFactory = connectionFactory; return this; } /** * Sets {@link org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory} instance. * * @return this instance. * @deprecated Use {@link #setTlsSocketStrategy(TlsSocketStrategy)} */ @Deprecated public final PoolingHttpClientConnectionManagerBuilder setSSLSocketFactory( final org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory sslSocketFactory) { this.tlsSocketStrategy = (socket, target, port, attachment, context) -> (SSLSocket) sslSocketFactory.createLayeredSocket(socket, target, port, context); return this; } /** * Sets {@link TlsSocketStrategy} instance. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setTlsSocketStrategy(final TlsSocketStrategy tlsSocketStrategy) { this.tlsSocketStrategy = tlsSocketStrategy; return this; } /** * Sets {@link DnsResolver} instance. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setDnsResolver(final DnsResolver dnsResolver) { this.dnsResolver = dnsResolver; return this; } /** * Sets {@link SchemePortResolver} instance. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setSchemePortResolver(final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver; return this; } /** * Sets {@link PoolConcurrencyPolicy} value. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setPoolConcurrencyPolicy(final PoolConcurrencyPolicy poolConcurrencyPolicy) { this.poolConcurrencyPolicy = poolConcurrencyPolicy; return this; } /** * Sets {@link PoolReusePolicy} value. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setConnPoolPolicy(final PoolReusePolicy poolReusePolicy) { this.poolReusePolicy = poolReusePolicy; return this; } /** * Sets maximum total connection value. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setMaxConnTotal(final int maxConnTotal) { this.maxConnTotal = maxConnTotal; return this; } /** * Sets maximum connection per route value. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setMaxConnPerRoute(final int maxConnPerRoute) { this.maxConnPerRoute = maxConnPerRoute; return this; } /** * Sets the same {@link SocketConfig} for all routes. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder setDefaultSocketConfig(final SocketConfig config) { this.socketConfigResolver = route -> config; return this; } /** * Sets {@link Resolver} of {@link SocketConfig} on a per route basis. * * @return this instance. * @since 5.2 */ public final PoolingHttpClientConnectionManagerBuilder setSocketConfigResolver( final Resolver socketConfigResolver) { this.socketConfigResolver = socketConfigResolver; return this; } /** * Sets the same {@link ConnectionConfig} for all routes. * * @return this instance. * @since 5.2 */ public final PoolingHttpClientConnectionManagerBuilder setDefaultConnectionConfig(final ConnectionConfig config) { this.connectionConfigResolver = route -> config; return this; } /** * Sets {@link Resolver} of {@link ConnectionConfig} on a per route basis. * * @return this instance. * @since 5.2 */ public final PoolingHttpClientConnectionManagerBuilder setConnectionConfigResolver( final Resolver connectionConfigResolver) { this.connectionConfigResolver = connectionConfigResolver; return this; } /** * Sets the same {@link TlsConfig} for all hosts. * * @return this instance. * @since 5.2 */ public final PoolingHttpClientConnectionManagerBuilder setDefaultTlsConfig(final TlsConfig config) { this.tlsConfigResolver = host -> config; return this; } /** * Sets {@link Resolver} of {@link TlsConfig} on a per host basis. * * @return this instance. * @since 5.2 */ public final PoolingHttpClientConnectionManagerBuilder setTlsConfigResolver( final Resolver tlsConfigResolver) { this.tlsConfigResolver = tlsConfigResolver; return this; } /** * Sets maximum time to live for persistent connections * * @return this instance. * @deprecated Use {@link #setDefaultConnectionConfig(ConnectionConfig)}. */ @Deprecated public final PoolingHttpClientConnectionManagerBuilder setConnectionTimeToLive(final TimeValue timeToLive) { setDefaultConnectionConfig(ConnectionConfig.custom() .setTimeToLive(timeToLive) .build()); return this; } /** * Sets period after inactivity after which persistent * connections must be checked to ensure they are still valid. * * @return this instance. * @deprecated Use {@link #setDefaultConnectionConfig(ConnectionConfig)}. */ @Deprecated public final PoolingHttpClientConnectionManagerBuilder setValidateAfterInactivity(final TimeValue validateAfterInactivity) { setDefaultConnectionConfig(ConnectionConfig.custom() .setValidateAfterInactivity(validateAfterInactivity) .build()); return this; } /** * Use system properties when creating and configuring default * implementations. * * @return this instance. */ public final PoolingHttpClientConnectionManagerBuilder useSystemProperties() { this.systemProperties = true; return this; } @Internal protected HttpClientConnectionOperator createConnectionOperator( final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver, final TlsSocketStrategy tlsSocketStrategy) { return new DefaultHttpClientConnectionOperator(schemePortResolver, dnsResolver, RegistryBuilder.create() .register(URIScheme.HTTPS.id, tlsSocketStrategy) .build()); } public PoolingHttpClientConnectionManager build() { final TlsSocketStrategy tlsSocketStrategyCopy; if (tlsSocketStrategy != null) { tlsSocketStrategyCopy = tlsSocketStrategy; } else { if (systemProperties) { tlsSocketStrategyCopy = DefaultClientTlsStrategy.createSystemDefault(); } else { tlsSocketStrategyCopy = DefaultClientTlsStrategy.createDefault(); } } final PoolingHttpClientConnectionManager poolingmgr = new PoolingHttpClientConnectionManager( createConnectionOperator(schemePortResolver, dnsResolver, tlsSocketStrategyCopy), poolConcurrencyPolicy, poolReusePolicy, null, connectionFactory); poolingmgr.setSocketConfigResolver(socketConfigResolver); poolingmgr.setConnectionConfigResolver(connectionConfigResolver); poolingmgr.setTlsConfigResolver(tlsConfigResolver); if (maxConnTotal > 0) { poolingmgr.setMaxTotal(maxConnTotal); } if (maxConnPerRoute > 0) { poolingmgr.setDefaultMaxPerRoute(maxConnPerRoute); } return poolingmgr; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/LenientHttpResponseParser.java0100664 0000000 0000000 00000007022 14704162040 030776 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponseFactory; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.io.DefaultHttpResponseParser; import org.apache.hc.core5.http.message.LineParser; import org.apache.hc.core5.util.CharArrayBuffer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Lenient HTTP response parser implementation that can skip malformed data until * a valid HTTP response message head is encountered. * * @since 4.2 */ public class LenientHttpResponseParser extends DefaultHttpResponseParser { private static final Logger LOG = LoggerFactory.getLogger(LenientHttpResponseParser.class); /** * Creates new instance of DefaultHttpResponseParser. * * @param lineParser the line parser. If {@code null} * {@link org.apache.hc.core5.http.message.BasicLineParser#INSTANCE} will be used. * @param responseFactory HTTP response factory. If {@code null} * {@link org.apache.hc.core5.http.impl.io.DefaultClassicHttpResponseFactory#INSTANCE} * will be used. * @param h1Config HTTP/1.1 parameters. If {@code null}. {@link Http1Config#DEFAULT} will be used. * * @since 4.3 */ public LenientHttpResponseParser( final LineParser lineParser, final HttpResponseFactory responseFactory, final Http1Config h1Config) { super(h1Config, lineParser, responseFactory); } /** * Creates new instance of DefaultHttpResponseParser. * * @param h1Config HTTP/1.1 parameters. If {@code null}. {@link Http1Config#DEFAULT} will be used. * * @since 4.3 */ public LenientHttpResponseParser(final Http1Config h1Config) { this(null, null, h1Config); } @Override protected ClassicHttpResponse createMessage(final CharArrayBuffer buffer) throws IOException { try { return super.createMessage(buffer); } catch (final HttpException ex) { if (LOG.isDebugEnabled()) { LOG.debug("Garbage in response: {}", buffer); } return null; } } } ././@LongLink0100644 0000000 0000000 00000000145 15063503637 011643 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManager.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/io/PoolingHttpClientConnectionManager.java0100664 0000000 0000000 00000104615 15063503637 032605 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.util.Set; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicReference; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.ConnectionHolder; import org.apache.hc.client5.http.impl.ConnectionShutdownException; import org.apache.hc.client5.http.impl.PrefixedIncrementingId; import org.apache.hc.client5.http.io.ConnectionEndpoint; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.io.HttpClientConnectionOperator; import org.apache.hc.client5.http.io.LeaseRequest; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.function.Resolver; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Registry; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.pool.DefaultDisposalCallback; import org.apache.hc.core5.pool.LaxConnPool; import org.apache.hc.core5.pool.ManagedConnPool; import org.apache.hc.core5.pool.PoolConcurrencyPolicy; import org.apache.hc.core5.pool.PoolEntry; import org.apache.hc.core5.pool.PoolReusePolicy; import org.apache.hc.core5.pool.PoolStats; import org.apache.hc.core5.pool.StrictConnPool; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Deadline; import org.apache.hc.core5.util.Identifiable; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * {@code PoolingHttpClientConnectionManager} maintains a pool of * {@link ManagedHttpClientConnection}s and is able to service connection requests * from multiple execution threads. Connections are pooled on a per route * basis. A request for a route which already the manager has persistent * connections for available in the pool will be serviced by leasing * a connection from the pool rather than creating a new connection. *

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

* Total time to live (TTL) set at construction time defines maximum life span * of persistent connections regardless of their expiration setting. No persistent * connection will be re-used past its TTL value. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public class PoolingHttpClientConnectionManager implements HttpClientConnectionManager, ConnPoolControl { private static final Logger LOG = LoggerFactory.getLogger(PoolingHttpClientConnectionManager.class); public static final int DEFAULT_MAX_TOTAL_CONNECTIONS = 25; public static final int DEFAULT_MAX_CONNECTIONS_PER_ROUTE = 5; private final HttpClientConnectionOperator connectionOperator; private final ManagedConnPool pool; private final HttpConnectionFactory connFactory; private final AtomicBoolean closed; private volatile Resolver socketConfigResolver; private volatile Resolver connectionConfigResolver; private volatile Resolver tlsConfigResolver; public PoolingHttpClientConnectionManager() { this(new DefaultHttpClientConnectionOperator(null, null, RegistryBuilder.create() .register(URIScheme.HTTPS.id, DefaultClientTlsStrategy.createDefault()) .build()), PoolConcurrencyPolicy.STRICT, PoolReusePolicy.LIFO, TimeValue.NEG_ONE_MILLISECOND, null); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry) { this(socketFactoryRegistry, null); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry, final HttpConnectionFactory connFactory) { this(socketFactoryRegistry, PoolConcurrencyPolicy.STRICT, TimeValue.NEG_ONE_MILLISECOND, connFactory); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry, final PoolConcurrencyPolicy poolConcurrencyPolicy, final TimeValue timeToLive, final HttpConnectionFactory connFactory) { this(socketFactoryRegistry, poolConcurrencyPolicy, PoolReusePolicy.LIFO, timeToLive, connFactory); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive) { this(socketFactoryRegistry, poolConcurrencyPolicy, poolReusePolicy, timeToLive, null); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive, final HttpConnectionFactory connFactory) { this(socketFactoryRegistry, poolConcurrencyPolicy, poolReusePolicy, timeToLive, null, null, connFactory); } /** * @deprecated Use {@link PoolingHttpClientConnectionManagerBuilder} */ @Deprecated public PoolingHttpClientConnectionManager( final Registry socketFactoryRegistry, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver, final HttpConnectionFactory connFactory) { this(new DefaultHttpClientConnectionOperator(socketFactoryRegistry, schemePortResolver, dnsResolver), poolConcurrencyPolicy, poolReusePolicy, timeToLive, connFactory); } @Internal public PoolingHttpClientConnectionManager( final HttpClientConnectionOperator httpClientConnectionOperator, final PoolConcurrencyPolicy poolConcurrencyPolicy, final PoolReusePolicy poolReusePolicy, final TimeValue timeToLive, final HttpConnectionFactory connFactory) { super(); this.connectionOperator = Args.notNull(httpClientConnectionOperator, "Connection operator"); switch (poolConcurrencyPolicy != null ? poolConcurrencyPolicy : PoolConcurrencyPolicy.STRICT) { case STRICT: this.pool = new StrictConnPool( DEFAULT_MAX_CONNECTIONS_PER_ROUTE, DEFAULT_MAX_TOTAL_CONNECTIONS, timeToLive, poolReusePolicy, new DefaultDisposalCallback<>(), null) { @Override public void closeExpired() { enumAvailable(e -> closeIfExpired(e)); } }; break; case LAX: this.pool = new LaxConnPool( DEFAULT_MAX_CONNECTIONS_PER_ROUTE, timeToLive, poolReusePolicy, null) { @Override public void closeExpired() { enumAvailable(e -> closeIfExpired(e)); } }; break; default: throw new IllegalArgumentException("Unexpected PoolConcurrencyPolicy value: " + poolConcurrencyPolicy); } this.connFactory = connFactory != null ? connFactory : ManagedHttpClientConnectionFactory.INSTANCE; this.closed = new AtomicBoolean(false); } @Internal protected PoolingHttpClientConnectionManager( final HttpClientConnectionOperator httpClientConnectionOperator, final ManagedConnPool pool, final HttpConnectionFactory connFactory) { super(); this.connectionOperator = Args.notNull(httpClientConnectionOperator, "Connection operator"); this.pool = Args.notNull(pool, "Connection pool"); this.connFactory = connFactory != null ? connFactory : ManagedHttpClientConnectionFactory.INSTANCE; this.closed = new AtomicBoolean(false); } @Override public void close() { close(CloseMode.GRACEFUL); } @Override public void close(final CloseMode closeMode) { if (this.closed.compareAndSet(false, true)) { if (LOG.isDebugEnabled()) { LOG.debug("Shutdown connection pool {}", closeMode); } this.pool.close(closeMode); LOG.debug("Connection pool shut down"); } } private InternalConnectionEndpoint cast(final ConnectionEndpoint endpoint) { if (endpoint instanceof InternalConnectionEndpoint) { return (InternalConnectionEndpoint) endpoint; } throw new IllegalStateException("Unexpected endpoint class: " + endpoint.getClass()); } private SocketConfig resolveSocketConfig(final HttpRoute route) { final Resolver resolver = this.socketConfigResolver; final SocketConfig socketConfig = resolver != null ? resolver.resolve(route) : null; return socketConfig != null ? socketConfig : SocketConfig.DEFAULT; } private ConnectionConfig resolveConnectionConfig(final HttpRoute route) { final Resolver resolver = this.connectionConfigResolver; final ConnectionConfig connectionConfig = resolver != null ? resolver.resolve(route) : null; return connectionConfig != null ? connectionConfig : ConnectionConfig.DEFAULT; } private TlsConfig resolveTlsConfig(final HttpHost host) { final Resolver resolver = this.tlsConfigResolver; final TlsConfig tlsConfig = resolver != null ? resolver.resolve(host) : null; return tlsConfig != null ? tlsConfig : TlsConfig.DEFAULT; } private TimeValue resolveValidateAfterInactivity(final ConnectionConfig connectionConfig) { final TimeValue timeValue = connectionConfig.getValidateAfterInactivity(); return timeValue != null ? timeValue : TimeValue.ofSeconds(2); } public LeaseRequest lease(final String id, final HttpRoute route, final Object state) { return lease(id, route, Timeout.DISABLED, state); } @Override public LeaseRequest lease( final String id, final HttpRoute route, final Timeout requestTimeout, final Object state) { Args.notNull(route, "HTTP route"); if (LOG.isDebugEnabled()) { LOG.debug("{} endpoint lease request ({}) {}", id, requestTimeout, ConnPoolSupport.formatStats(route, state, pool)); } final Future> leaseFuture = this.pool.lease(route, state, requestTimeout, null); return new LeaseRequest() { // Using a ReentrantLock specific to each LeaseRequest instance to maintain the original // synchronization semantics. This ensures that each LeaseRequest has its own unique lock. private final ReentrantLock lock = new ReentrantLock(); private volatile ConnectionEndpoint endpoint; @Override public ConnectionEndpoint get( final Timeout timeout) throws InterruptedException, ExecutionException, TimeoutException { lock.lock(); try { Args.notNull(timeout, "Operation timeout"); if (this.endpoint != null) { return this.endpoint; } final PoolEntry poolEntry; try { poolEntry = leaseFuture.get(timeout.getDuration(), timeout.getTimeUnit()); } catch (final TimeoutException ex) { leaseFuture.cancel(true); throw ex; } if (LOG.isDebugEnabled()) { LOG.debug("{} endpoint leased {}", id, ConnPoolSupport.formatStats(route, state, pool)); } final ConnectionConfig connectionConfig = resolveConnectionConfig(route); try { if (poolEntry.hasConnection()) { final TimeValue timeToLive = connectionConfig.getTimeToLive(); if (TimeValue.isNonNegative(timeToLive)) { if (timeToLive.getDuration() == 0 || Deadline.calculate(poolEntry.getCreated(), timeToLive).isExpired()) { poolEntry.discardConnection(CloseMode.GRACEFUL); } } } if (poolEntry.hasConnection()) { final TimeValue timeValue = resolveValidateAfterInactivity(connectionConfig); if (TimeValue.isNonNegative(timeValue)) { if (timeValue.getDuration() == 0 || Deadline.calculate(poolEntry.getUpdated(), timeValue).isExpired()) { final ManagedHttpClientConnection conn = poolEntry.getConnection(); boolean stale; try { stale = conn.isStale(); } catch (final IOException ignore) { stale = true; } if (stale) { if (LOG.isDebugEnabled()) { LOG.debug("{} connection {} is stale", id, ConnPoolSupport.getId(conn)); } poolEntry.discardConnection(CloseMode.IMMEDIATE); } } } } final ManagedHttpClientConnection conn = poolEntry.getConnection(); if (conn != null) { conn.activate(); if (connectionConfig.getSocketTimeout() != null) { conn.setSocketTimeout(connectionConfig.getSocketTimeout()); } } else { poolEntry.assignConnection(connFactory.createConnection(null)); } this.endpoint = new InternalConnectionEndpoint(poolEntry); if (LOG.isDebugEnabled()) { LOG.debug("{} acquired {}", id, ConnPoolSupport.getId(endpoint)); } return this.endpoint; } catch (final Exception ex) { if (LOG.isDebugEnabled()) { LOG.debug("{} endpoint lease failed", id); } pool.release(poolEntry, false); throw new ExecutionException(ex.getMessage(), ex); } } finally { lock.unlock(); } } @Override public boolean cancel() { return leaseFuture.cancel(true); } }; } @Override public void release(final ConnectionEndpoint endpoint, final Object state, final TimeValue keepAlive) { Args.notNull(endpoint, "Managed endpoint"); final PoolEntry entry = cast(endpoint).detach(); if (entry == null) { return; } if (LOG.isDebugEnabled()) { LOG.debug("{} releasing endpoint", ConnPoolSupport.getId(endpoint)); } if (this.isClosed()) { return; } final ManagedHttpClientConnection conn = entry.getConnection(); if (conn != null && keepAlive == null) { conn.close(CloseMode.GRACEFUL); } boolean reusable = conn != null && conn.isOpen() && conn.isConsistent(); try { if (reusable) { entry.updateState(state); entry.updateExpiry(keepAlive); conn.passivate(); if (LOG.isDebugEnabled()) { final String s; if (TimeValue.isPositive(keepAlive)) { s = "for " + keepAlive; } else { s = "indefinitely"; } LOG.debug("{} connection {} can be kept alive {}", ConnPoolSupport.getId(endpoint), ConnPoolSupport.getId(conn), s); } } else { if (LOG.isDebugEnabled()) { if (conn != null && !conn.isConsistent()) { LOG.debug("{} connection is in an inconsistent state and cannot be kept alive", ConnPoolSupport.getId(endpoint)); } else { LOG.debug("{} connection is not kept alive", ConnPoolSupport.getId(endpoint)); } } } } catch (final RuntimeException ex) { reusable = false; throw ex; } finally { this.pool.release(entry, reusable); if (LOG.isDebugEnabled()) { LOG.debug("{} connection released {}", ConnPoolSupport.getId(endpoint), ConnPoolSupport.formatStats(entry.getRoute(), entry.getState(), pool)); } } } @Override public void connect(final ConnectionEndpoint endpoint, final TimeValue timeout, final HttpContext context) throws IOException { Args.notNull(endpoint, "Managed endpoint"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); if (internalEndpoint.isConnected()) { return; } final PoolEntry poolEntry = internalEndpoint.getPoolEntry(); if (!poolEntry.hasConnection()) { poolEntry.assignConnection(connFactory.createConnection(null)); } final HttpRoute route = poolEntry.getRoute(); final HttpHost firstHop = route.getProxyHost() != null ? route.getProxyHost() : route.getTargetHost(); final SocketConfig socketConfig = resolveSocketConfig(route); final ConnectionConfig connectionConfig = resolveConnectionConfig(route); final Timeout connectTimeout = timeout != null ? Timeout.of(timeout.getDuration(), timeout.getTimeUnit()) : connectionConfig.getConnectTimeout(); if (LOG.isDebugEnabled()) { LOG.debug("{} connecting endpoint to {} ({})", ConnPoolSupport.getId(endpoint), firstHop, connectTimeout); } final ManagedHttpClientConnection conn = poolEntry.getConnection(); this.connectionOperator.connect( conn, firstHop, route.getTargetName(), route.getLocalSocketAddress(), connectTimeout, socketConfig, route.isTunnelled() ? null : resolveTlsConfig(route.getTargetHost()), context); if (LOG.isDebugEnabled()) { LOG.debug("{} connected {}", ConnPoolSupport.getId(endpoint), ConnPoolSupport.getId(conn)); } final Timeout socketTimeout = connectionConfig.getSocketTimeout(); if (socketTimeout != null) { conn.setSocketTimeout(socketTimeout); } } @Override public void upgrade(final ConnectionEndpoint endpoint, final HttpContext context) throws IOException { Args.notNull(endpoint, "Managed endpoint"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); final PoolEntry poolEntry = internalEndpoint.getValidatedPoolEntry(); final HttpRoute route = poolEntry.getRoute(); final HttpHost target = route.getTargetHost(); final TlsConfig tlsConfig = resolveTlsConfig(target); this.connectionOperator.upgrade( poolEntry.getConnection(), target, route.getTargetName(), tlsConfig, context); } @Override public void closeIdle(final TimeValue idleTime) { Args.notNull(idleTime, "Idle time"); if (LOG.isDebugEnabled()) { LOG.debug("Closing connections idle longer than {}", idleTime); } if (isClosed()) { return; } this.pool.closeIdle(idleTime); } @Override public void closeExpired() { if (isClosed()) { return; } LOG.debug("Closing expired connections"); this.pool.closeExpired(); } @Override public Set getRoutes() { return this.pool.getRoutes(); } @Override public int getMaxTotal() { return this.pool.getMaxTotal(); } @Override public void setMaxTotal(final int max) { this.pool.setMaxTotal(max); } @Override public int getDefaultMaxPerRoute() { return this.pool.getDefaultMaxPerRoute(); } @Override public void setDefaultMaxPerRoute(final int max) { this.pool.setDefaultMaxPerRoute(max); } @Override public int getMaxPerRoute(final HttpRoute route) { return this.pool.getMaxPerRoute(route); } @Override public void setMaxPerRoute(final HttpRoute route, final int max) { this.pool.setMaxPerRoute(route, max); } @Override public PoolStats getTotalStats() { return this.pool.getTotalStats(); } @Override public PoolStats getStats(final HttpRoute route) { return this.pool.getStats(route); } /** * Sets the same {@link SocketConfig} for all routes */ public void setDefaultSocketConfig(final SocketConfig config) { this.socketConfigResolver = route -> config; } /** * Sets {@link Resolver} of {@link SocketConfig} on a per route basis. * * @since 5.2 */ public void setSocketConfigResolver(final Resolver socketConfigResolver) { this.socketConfigResolver = socketConfigResolver; } /** * Sets the same {@link ConnectionConfig} for all routes * * @since 5.2 */ public void setDefaultConnectionConfig(final ConnectionConfig config) { this.connectionConfigResolver = route -> config; } /** * Sets {@link Resolver} of {@link ConnectionConfig} on a per route basis. * * @since 5.2 */ public void setConnectionConfigResolver(final Resolver connectionConfigResolver) { this.connectionConfigResolver = connectionConfigResolver; } /** * Sets the same {@link ConnectionConfig} for all hosts * * @since 5.2 */ public void setDefaultTlsConfig(final TlsConfig config) { this.tlsConfigResolver = host -> config; } /** * Sets {@link Resolver} of {@link TlsConfig} on a per host basis. * * @since 5.2 */ public void setTlsConfigResolver(final Resolver tlsConfigResolver) { this.tlsConfigResolver = tlsConfigResolver; } void closeIfExpired(final PoolEntry entry) { final long now = System.currentTimeMillis(); if (entry.getExpiryDeadline().isBefore(now)) { entry.discardConnection(CloseMode.GRACEFUL); } else { final ConnectionConfig connectionConfig = resolveConnectionConfig(entry.getRoute()); final TimeValue timeToLive = connectionConfig.getTimeToLive(); if (timeToLive != null && Deadline.calculate(entry.getCreated(), timeToLive).isBefore(now)) { entry.discardConnection(CloseMode.GRACEFUL); } } } /** * @deprecated Use custom {@link #setConnectionConfigResolver(Resolver)} */ @Deprecated public SocketConfig getDefaultSocketConfig() { return SocketConfig.DEFAULT; } /** * @since 4.4 * * @deprecated Use {@link #setConnectionConfigResolver(Resolver)}. */ @Deprecated public TimeValue getValidateAfterInactivity() { return ConnectionConfig.DEFAULT.getValidateAfterInactivity(); } /** * Defines period of inactivity after which persistent connections must * be re-validated prior to being {@link #lease(String, HttpRoute, Object)} leased} to the consumer. * Negative values passed to this method disable connection validation. This check helps * detect connections that have become stale (half-closed) while kept inactive in the pool. * * @since 4.4 * * @deprecated Use {@link #setConnectionConfigResolver(Resolver)}. */ @Deprecated public void setValidateAfterInactivity(final TimeValue validateAfterInactivity) { setDefaultConnectionConfig(ConnectionConfig.custom() .setValidateAfterInactivity(validateAfterInactivity) .build()); } private static final PrefixedIncrementingId INCREMENTING_ID = new PrefixedIncrementingId("ep-"); static class InternalConnectionEndpoint extends ConnectionEndpoint implements ConnectionHolder, Identifiable { private final AtomicReference> poolEntryRef; private final String id; InternalConnectionEndpoint( final PoolEntry poolEntry) { this.poolEntryRef = new AtomicReference<>(poolEntry); this.id = INCREMENTING_ID.getNextId(); } @Override public String getId() { return id; } PoolEntry getPoolEntry() { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry == null) { throw new ConnectionShutdownException(); } return poolEntry; } PoolEntry getValidatedPoolEntry() { final PoolEntry poolEntry = getPoolEntry(); final ManagedHttpClientConnection connection = poolEntry.getConnection(); if (connection == null || !connection.isOpen()) { throw new ConnectionShutdownException(); } return poolEntry; } PoolEntry detach() { return poolEntryRef.getAndSet(null); } @Override public void close(final CloseMode closeMode) { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry != null) { poolEntry.discardConnection(closeMode); } } @Override public void close() throws IOException { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry != null) { poolEntry.discardConnection(CloseMode.GRACEFUL); } } @Override public boolean isConnected() { final PoolEntry poolEntry = getPoolEntry(); final ManagedHttpClientConnection connection = poolEntry.getConnection(); return connection != null && connection.isOpen(); } @Override public void setSocketTimeout(final Timeout timeout) { getValidatedPoolEntry().getConnection().setSocketTimeout(timeout); } /** * @deprecated Use {@link #execute(String, ClassicHttpRequest, RequestExecutor, HttpContext)} */ @Deprecated @Override public ClassicHttpResponse execute( final String exchangeId, final ClassicHttpRequest request, final HttpRequestExecutor requestExecutor, final HttpContext context) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(requestExecutor, "Request executor"); final ManagedHttpClientConnection connection = getValidatedPoolEntry().getConnection(); if (LOG.isDebugEnabled()) { LOG.debug("{} executing exchange {} over {}", id, exchangeId, ConnPoolSupport.getId(connection)); } return requestExecutor.execute(request, connection, context); } /** * @since 5.4 */ @Override public ClassicHttpResponse execute( final String exchangeId, final ClassicHttpRequest request, final RequestExecutor requestExecutor, final HttpContext context) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(requestExecutor, "Request executor"); final ManagedHttpClientConnection connection = getValidatedPoolEntry().getConnection(); if (LOG.isDebugEnabled()) { LOG.debug("{} executing exchange {} over {}", id, exchangeId, ConnPoolSupport.getId(connection)); } return requestExecutor.execute(request, connection, context); } /** * @since 5.4 */ @Override public EndpointInfo getInfo() { final PoolEntry poolEntry = poolEntryRef.get(); if (poolEntry != null) { final ManagedHttpClientConnection connection = poolEntry.getConnection(); if (connection != null && connection.isOpen()) { return new EndpointInfo(connection.getProtocolVersion(), connection.getSSLSession()); } } return null; } @Override public HttpConnection get() { final PoolEntry poolEntry = poolEntryRef.get(); return poolEntry != null ? poolEntry.getConnection() : null; } } /** * Method that can be called to determine whether the connection manager has been shut down and * is closed or not. * * @return {@code true} if the connection manager has been shut down and is closed, otherwise * return {@code false}. * @since 5.4 */ public boolean isClosed() { return this.closed.get(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/LoggingInputStream.java0100664 0000000 0000000 00000007363 14704162040 027436 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.FilterInputStream; import java.io.IOException; import java.io.InputStream; import org.apache.hc.client5.http.impl.Wire; /** * Delegates {@link InputStream} calls and logs to a {@link Wire}. */ class LoggingInputStream extends FilterInputStream { private final Wire wire; LoggingInputStream(final InputStream in, final Wire wire) { super(in); this.wire = wire; } @Override public int read() throws IOException { try { final int b = in.read(); if (b == -1) { wire.input("end of stream"); } else { wire.input(b); } return b; } catch (final IOException ex) { wire.input("[read] I/O error: " + ex.getMessage()); throw ex; } } @Override public int read(final byte[] b) throws IOException { try { final int bytesRead = in.read(b); if (bytesRead == -1) { wire.input("end of stream"); } else if (bytesRead > 0) { wire.input(b, 0, bytesRead); } return bytesRead; } catch (final IOException ex) { wire.input("[read] I/O error: " + ex.getMessage()); throw ex; } } @Override public int read(final byte[] b, final int off, final int len) throws IOException { try { final int bytesRead = in.read(b, off, len); if (bytesRead == -1) { wire.input("end of stream"); } else if (bytesRead > 0) { wire.input(b, off, bytesRead); } return bytesRead; } catch (final IOException ex) { wire.input("[read] I/O error: " + ex.getMessage()); throw ex; } } @Override public long skip(final long n) throws IOException { try { return in.skip(n); } catch (final IOException ex) { wire.input("[skip] I/O error: " + ex.getMessage()); throw ex; } } @Override public int available() throws IOException { try { return in.available(); } catch (final IOException ex) { wire.input("[available] I/O error: " + ex.getMessage()); throw ex; } } @Override public void close() throws IOException { try { in.close(); } catch (final IOException ex) { wire.input("[close] I/O error: " + ex.getMessage()); throw ex; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/LoggingOutputStream.java0100664 0000000 0000000 00000005664 14666635064 027663 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.io.OutputStream; import org.apache.hc.client5.http.impl.Wire; class LoggingOutputStream extends OutputStream { private final OutputStream out; private final Wire wire; public LoggingOutputStream(final OutputStream out, final Wire wire) { super(); this.out = out; this.wire = wire; } @Override public void write(final int b) throws IOException { try { out.write(b); wire.output(b); } catch (final IOException ex) { wire.output("[write] I/O error: " + ex.getMessage()); throw ex; } } @Override public void write(final byte[] b) throws IOException { try { wire.output(b); out.write(b); } catch (final IOException ex) { wire.output("[write] I/O error: " + ex.getMessage()); throw ex; } } @Override public void write(final byte[] b, final int off, final int len) throws IOException { try { wire.output(b, off, len); out.write(b, off, len); } catch (final IOException ex) { wire.output("[write] I/O error: " + ex.getMessage()); throw ex; } } @Override public void flush() throws IOException { try { out.flush(); } catch (final IOException ex) { wire.output("[flush] I/O error: " + ex.getMessage()); throw ex; } } @Override public void close() throws IOException { try { out.close(); } catch (final IOException ex) { wire.output("[close] I/O error: " + ex.getMessage()); throw ex; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/LoggingSocketHolder.java0100664 0000000 0000000 00000004370 14704162040 027544 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.net.Socket; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.impl.Wire; import org.apache.hc.core5.http.impl.io.SocketHolder; import org.slf4j.Logger; class LoggingSocketHolder extends SocketHolder { private final Wire wire; public LoggingSocketHolder(final Socket socket, final String id, final Logger log) { super(socket); this.wire = new Wire(log, id); } LoggingSocketHolder(final SSLSocket sslSocket, final Socket baseSocket, final String id, final Logger log) { super(sslSocket, baseSocket); this.wire = new Wire(log, id); } @Override protected InputStream getInputStream(final Socket socket) throws IOException { return new LoggingInputStream(super.getInputStream(socket), wire); } @Override protected OutputStream getOutputStream(final Socket socket) throws IOException { return new LoggingOutputStream(super.getOutputStream(socket), wire); } } ././@LongLink0100644 0000000 0000000 00000000146 15063503632 011637 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/DefaultHttpClientConnectionOperator.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/io/DefaultHttpClientConnectionOperator.jav0100664 0000000 0000000 00000035633 15063503632 032640 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.Socket; import java.net.SocketAddress; import java.util.Collections; import java.util.List; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.ConnectExceptionSupport; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.client5.http.UnsupportedSchemeException; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.io.DetachedSocketFactory; import org.apache.hc.client5.http.io.HttpClientConnectionOperator; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ConnectionClosedException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.Closer; import org.apache.hc.core5.io.SocketSupport; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Default implementation of {@link HttpClientConnectionOperator} used as default in Http client, * when no instance provided by user to {@link BasicHttpClientConnectionManager} or {@link * PoolingHttpClientConnectionManager} constructor. * * @since 4.4 */ @Internal @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultHttpClientConnectionOperator implements HttpClientConnectionOperator { private static final Logger LOG = LoggerFactory.getLogger(DefaultHttpClientConnectionOperator.class); static final DetachedSocketFactory PLAIN_SOCKET_FACTORY = socksProxy -> socksProxy == null ? new Socket() : new Socket(socksProxy); private final DetachedSocketFactory detachedSocketFactory; private final Lookup tlsSocketStrategyLookup; private final SchemePortResolver schemePortResolver; private final DnsResolver dnsResolver; /** * @deprecated Provided for backward compatibility */ @Deprecated static Lookup adapt(final Lookup lookup) { return name -> { final org.apache.hc.client5.http.socket.ConnectionSocketFactory sf = lookup.lookup(name); return sf instanceof org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory ? (socket, target, port, attachment, context) -> (SSLSocket) ((org.apache.hc.client5.http.socket.LayeredConnectionSocketFactory) sf).createLayeredSocket(socket, target, port, attachment, context) : null; }; } public DefaultHttpClientConnectionOperator( final DetachedSocketFactory detachedSocketFactory, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver, final Lookup tlsSocketStrategyLookup) { super(); this.detachedSocketFactory = Args.notNull(detachedSocketFactory, "Plain socket factory"); this.tlsSocketStrategyLookup = Args.notNull(tlsSocketStrategyLookup, "Socket factory registry"); this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; this.dnsResolver = dnsResolver != null ? dnsResolver : SystemDefaultDnsResolver.INSTANCE; } /** * @deprecated Do not use. */ @Deprecated public DefaultHttpClientConnectionOperator( final Lookup socketFactoryRegistry, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver) { this(PLAIN_SOCKET_FACTORY, schemePortResolver, dnsResolver, adapt(socketFactoryRegistry)); } public DefaultHttpClientConnectionOperator( final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver, final Lookup tlsSocketStrategyLookup) { this(PLAIN_SOCKET_FACTORY, schemePortResolver, dnsResolver, tlsSocketStrategyLookup); } @Override public void connect( final ManagedHttpClientConnection conn, final HttpHost host, final InetSocketAddress localAddress, final TimeValue connectTimeout, final SocketConfig socketConfig, final HttpContext context) throws IOException { final Timeout timeout = connectTimeout != null ? Timeout.of(connectTimeout.getDuration(), connectTimeout.getTimeUnit()) : null; connect(conn, host, null, localAddress, timeout, socketConfig, null, context); } @Override public void connect( final ManagedHttpClientConnection conn, final HttpHost endpointHost, final NamedEndpoint endpointName, final InetSocketAddress localAddress, final Timeout connectTimeout, final SocketConfig socketConfig, final Object attachment, final HttpContext context) throws IOException { Args.notNull(conn, "Connection"); Args.notNull(endpointHost, "Host"); Args.notNull(socketConfig, "Socket config"); Args.notNull(context, "Context"); final SocketAddress socksProxyAddress = socketConfig.getSocksProxyAddress(); final Proxy socksProxy = socksProxyAddress != null ? new Proxy(Proxy.Type.SOCKS, socksProxyAddress) : null; final List remoteAddresses; if (endpointHost.getAddress() != null) { remoteAddresses = Collections.singletonList( new InetSocketAddress(endpointHost.getAddress(), this.schemePortResolver.resolve(endpointHost.getSchemeName(), endpointHost))); } else { final int port = this.schemePortResolver.resolve(endpointHost.getSchemeName(), endpointHost); remoteAddresses = this.dnsResolver.resolve(endpointHost.getHostName(), port); } for (int i = 0; i < remoteAddresses.size(); i++) { final InetSocketAddress remoteAddress = remoteAddresses.get(i); final boolean last = i == remoteAddresses.size() - 1; onBeforeSocketConnect(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} connecting {}->{} ({})", endpointHost, localAddress, remoteAddress, connectTimeout); } final Socket socket = detachedSocketFactory.create(endpointHost.getSchemeName(), socksProxy); try { // Always bind to the local address if it's provided. if (localAddress != null) { socket.bind(localAddress); } conn.bind(socket); final Timeout socketTimeout = socketConfig.getSoTimeout(); if (socketTimeout != null) { socket.setSoTimeout(socketTimeout.toMillisecondsIntBound()); } socket.setReuseAddress(socketConfig.isSoReuseAddress()); socket.setTcpNoDelay(socketConfig.isTcpNoDelay()); socket.setKeepAlive(socketConfig.isSoKeepAlive()); if (socketConfig.getRcvBufSize() > 0) { socket.setReceiveBufferSize(socketConfig.getRcvBufSize()); } if (socketConfig.getSndBufSize() > 0) { socket.setSendBufferSize(socketConfig.getSndBufSize()); } if (socketConfig.getTcpKeepIdle() > 0) { SocketSupport.setOption(socket, SocketSupport.TCP_KEEPIDLE, socketConfig.getTcpKeepIdle()); } if (socketConfig.getTcpKeepInterval() > 0) { SocketSupport.setOption(socket, SocketSupport.TCP_KEEPINTERVAL, socketConfig.getTcpKeepInterval()); } if (socketConfig.getTcpKeepCount() > 0) { SocketSupport.setOption(socket, SocketSupport.TCP_KEEPCOUNT, socketConfig.getTcpKeepCount()); } final int linger = socketConfig.getSoLinger().toMillisecondsIntBound(); if (linger >= 0) { socket.setSoLinger(true, linger); } socket.connect(remoteAddress, TimeValue.isPositive(connectTimeout) ? connectTimeout.toMillisecondsIntBound() : 0); conn.bind(socket); onAfterSocketConnect(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} {} connected {}->{}", ConnPoolSupport.getId(conn), endpointHost, conn.getLocalAddress(), conn.getRemoteAddress()); } final TlsSocketStrategy tlsSocketStrategy = tlsSocketStrategyLookup != null ? tlsSocketStrategyLookup.lookup(endpointHost.getSchemeName()) : null; if (tlsSocketStrategy != null) { final NamedEndpoint tlsName = endpointName != null ? endpointName : endpointHost; onBeforeTlsHandshake(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} {} upgrading to TLS", ConnPoolSupport.getId(conn), tlsName); } final TlsConfig tlsConfig = attachment instanceof TlsConfig ? (TlsConfig) attachment : TlsConfig.DEFAULT; final int soTimeout = socket.getSoTimeout(); final Timeout handshakeTimeout = tlsConfig.getHandshakeTimeout() != null ? tlsConfig.getHandshakeTimeout() : connectTimeout; if (handshakeTimeout != null) { socket.setSoTimeout(handshakeTimeout.toMillisecondsIntBound()); } final SSLSocket sslSocket = tlsSocketStrategy.upgrade(socket, tlsName.getHostName(), tlsName.getPort(), attachment, context); conn.bind(sslSocket, socket); socket.setSoTimeout(soTimeout); onAfterTlsHandshake(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} {} upgraded to TLS", ConnPoolSupport.getId(conn), tlsName); } } return; } catch (final RuntimeException ex) { Closer.closeQuietly(socket); throw ex; } catch (final IOException ex) { Closer.closeQuietly(socket); if (last) { if (LOG.isDebugEnabled()) { LOG.debug("{} connection to {} failed ({}); terminating operation", endpointHost, remoteAddress, ex.getClass()); } throw ConnectExceptionSupport.enhance(ex, endpointHost); } if (LOG.isDebugEnabled()) { LOG.debug("{} connection to {} failed ({}); retrying connection to the next address", endpointHost, remoteAddress, ex.getClass()); } } } } @Override public void upgrade( final ManagedHttpClientConnection conn, final HttpHost host, final HttpContext context) throws IOException { upgrade(conn, host, null, null, context); } @Override public void upgrade( final ManagedHttpClientConnection conn, final HttpHost endpointHost, final NamedEndpoint endpointName, final Object attachment, final HttpContext context) throws IOException { final Socket socket = conn.getSocket(); if (socket == null) { throw new ConnectionClosedException("Connection is closed"); } final String newProtocol = URIScheme.HTTP.same(endpointHost.getSchemeName()) ? URIScheme.HTTPS.id : endpointHost.getSchemeName(); final TlsSocketStrategy tlsSocketStrategy = tlsSocketStrategyLookup != null ? tlsSocketStrategyLookup.lookup(newProtocol) : null; if (tlsSocketStrategy != null) { final NamedEndpoint tlsName = endpointName != null ? endpointName : endpointHost; onBeforeTlsHandshake(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} upgrading to TLS {}:{}", ConnPoolSupport.getId(conn), tlsName.getHostName(), tlsName.getPort()); } final SSLSocket upgradedSocket = tlsSocketStrategy.upgrade(socket, tlsName.getHostName(), tlsName.getPort(), attachment, context); conn.bind(upgradedSocket, socket); onAfterTlsHandshake(context, endpointHost); if (LOG.isDebugEnabled()) { LOG.debug("{} upgraded to TLS {}:{}", ConnPoolSupport.getId(conn), tlsName.getHostName(), tlsName.getPort()); } } else { throw new UnsupportedSchemeException(newProtocol + " protocol is not supported"); } } protected void onBeforeSocketConnect(final HttpContext httpContext, final HttpHost endpointHost) { } protected void onAfterSocketConnect(final HttpContext httpContext, final HttpHost endpointHost) { } protected void onBeforeTlsHandshake(final HttpContext httpContext, final HttpHost endpointHost) { } protected void onAfterTlsHandshake(final HttpContext httpContext, final HttpHost endpointHost) { } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/DefaultHttpResponseParserFactory.java0100664 0000000 0000000 00000007614 14704162040 032323 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpResponseFactory; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.io.DefaultClassicHttpResponseFactory; import org.apache.hc.core5.http.io.HttpMessageParser; import org.apache.hc.core5.http.io.HttpMessageParserFactory; import org.apache.hc.core5.http.message.BasicLineParser; import org.apache.hc.core5.http.message.LineParser; /** * Default factory for response message parsers. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultHttpResponseParserFactory implements HttpMessageParserFactory { /** * Default instance DefaultHttpResponseParserFactory. */ public static final DefaultHttpResponseParserFactory INSTANCE = new DefaultHttpResponseParserFactory(); private final Http1Config h1Config; private final LineParser lineParser; private final HttpResponseFactory responseFactory; /** * @since 5.4 */ public DefaultHttpResponseParserFactory( final Http1Config h1Config, final LineParser lineParser, final HttpResponseFactory responseFactory) { super(); this.h1Config = h1Config != null ? h1Config : Http1Config.DEFAULT; this.lineParser = lineParser != null ? lineParser : BasicLineParser.INSTANCE; this.responseFactory = responseFactory != null ? responseFactory : DefaultClassicHttpResponseFactory.INSTANCE; } /** * @since 5.4 */ public DefaultHttpResponseParserFactory(final Http1Config h1Config) { this(h1Config, null, null); } public DefaultHttpResponseParserFactory( final LineParser lineParser, final HttpResponseFactory responseFactory) { this(null, lineParser, responseFactory); } public DefaultHttpResponseParserFactory(final HttpResponseFactory responseFactory) { this(null, null, responseFactory); } public DefaultHttpResponseParserFactory() { this(null, null, null); } @Override public HttpMessageParser create() { return new LenientHttpResponseParser(this.lineParser, this.responseFactory, h1Config); } /** * @deprecated Use {@link #create()} */ @Deprecated @Override public HttpMessageParser create(final Http1Config h1Config) { return new LenientHttpResponseParser(this.lineParser, this.responseFactory, h1Config); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/BasicHttpClientConnectionManager.java0100664 0000000 0000000 00000063556 15063503637 032227 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.time.Instant; import java.util.Objects; import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; import java.util.concurrent.atomic.AtomicReference; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.EndpointInfo; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.ConnPoolSupport; import org.apache.hc.client5.http.impl.ConnectionHolder; import org.apache.hc.client5.http.impl.ConnectionShutdownException; import org.apache.hc.client5.http.io.ConnectionEndpoint; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.io.HttpClientConnectionOperator; import org.apache.hc.client5.http.io.LeaseRequest; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.Deadline; import org.apache.hc.core5.util.Identifiable; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * A connection manager for a single connection. This connection manager maintains only one active * connection. Even though this class is fully thread-safe it ought to be used by one execution * thread only, as only one thread a time can lease the connection at a time. *

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

*

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

* * @since 4.3 */ @Contract(threading = ThreadingBehavior.SAFE) public class BasicHttpClientConnectionManager implements HttpClientConnectionManager { private static final Logger LOG = LoggerFactory.getLogger(BasicHttpClientConnectionManager.class); private static final AtomicLong COUNT = new AtomicLong(0); private final HttpClientConnectionOperator connectionOperator; private final HttpConnectionFactory connFactory; private final String id; private final ReentrantLock lock; private ManagedHttpClientConnection conn; private HttpRoute route; private Object state; private long created; private long updated; private long expiry; private boolean leased; private SocketConfig socketConfig; private ConnectionConfig connectionConfig; private TlsConfig tlsConfig; private final AtomicBoolean closed; /** * @since 4.4 */ public BasicHttpClientConnectionManager( final HttpClientConnectionOperator httpClientConnectionOperator, final HttpConnectionFactory connFactory) { super(); this.connectionOperator = Args.notNull(httpClientConnectionOperator, "Connection operator"); this.connFactory = connFactory != null ? connFactory : ManagedHttpClientConnectionFactory.INSTANCE; this.id = String.format("ep-%010d", COUNT.getAndIncrement()); this.expiry = Long.MAX_VALUE; this.socketConfig = SocketConfig.DEFAULT; this.connectionConfig = ConnectionConfig.DEFAULT; this.tlsConfig = TlsConfig.DEFAULT; this.closed = new AtomicBoolean(false); this.lock = new ReentrantLock(); } /** * @since 5.4 */ public static BasicHttpClientConnectionManager create( final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver, final Lookup tlsSocketStrategyRegistry, final HttpConnectionFactory connFactory) { return new BasicHttpClientConnectionManager( new DefaultHttpClientConnectionOperator(schemePortResolver, dnsResolver, tlsSocketStrategyRegistry), connFactory); } /** * @since 5.4 */ public static BasicHttpClientConnectionManager create( final Lookup tlsSocketStrategyRegistry, final HttpConnectionFactory connFactory) { return new BasicHttpClientConnectionManager( new DefaultHttpClientConnectionOperator(null, null, tlsSocketStrategyRegistry), connFactory); } /** * @since 5.4 */ public static BasicHttpClientConnectionManager create( final Lookup tlsSocketStrategyRegistry) { return new BasicHttpClientConnectionManager( new DefaultHttpClientConnectionOperator(null, null, tlsSocketStrategyRegistry), null); } /** * @deprecated Use {@link #create(SchemePortResolver, DnsResolver, Lookup, HttpConnectionFactory)} */ @Deprecated public BasicHttpClientConnectionManager( final Lookup socketFactoryRegistry, final HttpConnectionFactory connFactory, final SchemePortResolver schemePortResolver, final DnsResolver dnsResolver) { this(new DefaultHttpClientConnectionOperator( socketFactoryRegistry, schemePortResolver, dnsResolver), connFactory); } /** * @deprecated Use {@link #create(Lookup, HttpConnectionFactory)} */ @Deprecated public BasicHttpClientConnectionManager( final Lookup socketFactoryRegistry, final HttpConnectionFactory connFactory) { this(socketFactoryRegistry, connFactory, null, null); } /** * @deprecated Use {@link #create(Lookup)} */ @Deprecated public BasicHttpClientConnectionManager( final Lookup socketFactoryRegistry) { this(socketFactoryRegistry, null, null, null); } public BasicHttpClientConnectionManager() { this(new DefaultHttpClientConnectionOperator(null, null, RegistryBuilder.create() .register(URIScheme.HTTPS.id, DefaultClientTlsStrategy.createDefault()) .build()), null); } @Override public void close() { close(CloseMode.GRACEFUL); } @Override public void close(final CloseMode closeMode) { if (this.closed.compareAndSet(false, true)) { closeConnection(closeMode); } } HttpRoute getRoute() { return route; } Object getState() { return state; } public SocketConfig getSocketConfig() { lock.lock(); try { return socketConfig; } finally { lock.unlock(); } } public void setSocketConfig(final SocketConfig socketConfig) { lock.lock(); try { this.socketConfig = socketConfig != null ? socketConfig : SocketConfig.DEFAULT; } finally { lock.unlock(); } } /** * @since 5.2 */ public ConnectionConfig getConnectionConfig() { lock.lock(); try { return connectionConfig; } finally { lock.unlock(); } } /** * @since 5.2 */ public void setConnectionConfig(final ConnectionConfig connectionConfig) { lock.lock(); try { this.connectionConfig = connectionConfig != null ? connectionConfig : ConnectionConfig.DEFAULT; } finally { lock.unlock(); } } /** * @since 5.2 */ public TlsConfig getTlsConfig() { lock.lock(); try { return tlsConfig; } finally { lock.unlock(); } } /** * @since 5.2 */ public void setTlsConfig(final TlsConfig tlsConfig) { lock.lock(); try { this.tlsConfig = tlsConfig != null ? tlsConfig : TlsConfig.DEFAULT; } finally { lock.unlock(); } } public LeaseRequest lease(final String id, final HttpRoute route, final Object state) { return lease(id, route, Timeout.DISABLED, state); } @Override public LeaseRequest lease(final String id, final HttpRoute route, final Timeout requestTimeout, final Object state) { return new LeaseRequest() { @Override public ConnectionEndpoint get( final Timeout timeout) throws InterruptedException, ExecutionException, TimeoutException { try { return new InternalConnectionEndpoint(route, getConnection(route, state)); } catch (final IOException ex) { throw new ExecutionException(ex.getMessage(), ex); } } @Override public boolean cancel() { return false; } }; } private void closeConnection(final CloseMode closeMode) { lock.lock(); try { if (this.conn != null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Closing connection {}", id, closeMode); } this.conn.close(closeMode); this.conn = null; } } finally { lock.unlock(); } } private void checkExpiry() { if (this.conn != null && System.currentTimeMillis() >= this.expiry) { if (LOG.isDebugEnabled()) { LOG.debug("{} Connection expired @ {}", id, Instant.ofEpochMilli(this.expiry)); } closeConnection(CloseMode.GRACEFUL); } } private void validate() { if (this.conn != null) { final TimeValue timeToLive = connectionConfig.getTimeToLive(); if (TimeValue.isNonNegative(timeToLive)) { final Deadline deadline = Deadline.calculate(created, timeToLive); if (deadline.isExpired()) { closeConnection(CloseMode.GRACEFUL); } } } if (this.conn != null) { final TimeValue timeValue = connectionConfig.getValidateAfterInactivity() != null ? connectionConfig.getValidateAfterInactivity() : TimeValue.ofSeconds(2); if (TimeValue.isNonNegative(timeValue)) { final Deadline deadline = Deadline.calculate(updated, timeValue); if (deadline.isExpired()) { boolean stale; try { stale = conn.isStale(); } catch (final IOException ignore) { stale = true; } if (stale) { if (LOG.isDebugEnabled()) { LOG.debug("{} connection {} is stale", id, ConnPoolSupport.getId(conn)); } closeConnection(CloseMode.GRACEFUL); } } } } } ManagedHttpClientConnection getConnection(final HttpRoute route, final Object state) throws IOException { lock.lock(); try { Asserts.check(!isClosed(), "Connection manager has been shut down"); if (LOG.isDebugEnabled()) { LOG.debug("{} Get connection for route {}", id, route); } Asserts.check(!this.leased, "Connection %s is still allocated", conn); if (!Objects.equals(this.route, route) || !Objects.equals(this.state, state)) { closeConnection(CloseMode.GRACEFUL); } this.route = route; this.state = state; checkExpiry(); validate(); if (this.conn == null) { this.conn = this.connFactory.createConnection(null); this.created = System.currentTimeMillis(); } else { this.conn.activate(); if (connectionConfig.getSocketTimeout() != null) { conn.setSocketTimeout(connectionConfig.getSocketTimeout()); } } this.leased = true; if (LOG.isDebugEnabled()) { LOG.debug("{} Using connection {}", id, conn); } return this.conn; } finally { lock.unlock(); } } private InternalConnectionEndpoint cast(final ConnectionEndpoint endpoint) { if (endpoint instanceof InternalConnectionEndpoint) { return (InternalConnectionEndpoint) endpoint; } throw new IllegalStateException("Unexpected endpoint class: " + endpoint.getClass()); } @Override public void release(final ConnectionEndpoint endpoint, final Object state, final TimeValue keepAlive) { lock.lock(); try { Args.notNull(endpoint, "Managed endpoint"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); final ManagedHttpClientConnection conn = internalEndpoint.detach(); if (LOG.isDebugEnabled()) { LOG.debug("{} Releasing connection {}", id, conn); } if (isClosed()) { return; } try { if (keepAlive == null && conn != null) { conn.close(CloseMode.GRACEFUL); } this.updated = System.currentTimeMillis(); if (conn != null && conn.isOpen() && conn.isConsistent()) { this.state = state; conn.passivate(); if (TimeValue.isPositive(keepAlive)) { if (LOG.isDebugEnabled()) { LOG.debug("{} Connection can be kept alive for {}", id, keepAlive); } this.expiry = this.updated + keepAlive.toMilliseconds(); } else { if (LOG.isDebugEnabled()) { LOG.debug("{} Connection can be kept alive indefinitely", id); } this.expiry = Long.MAX_VALUE; } } else { this.route = null; this.conn = null; this.expiry = Long.MAX_VALUE; if (LOG.isDebugEnabled()) { LOG.debug("{} Connection is not kept alive", id); } } } finally { this.leased = false; } } finally { lock.unlock(); } } @Override public void connect(final ConnectionEndpoint endpoint, final TimeValue timeout, final HttpContext context) throws IOException { lock.lock(); try { Args.notNull(endpoint, "Endpoint"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); if (internalEndpoint.isConnected()) { return; } final HttpRoute route = internalEndpoint.getRoute(); final HttpHost firstHop = route.getProxyHost() != null ? route.getProxyHost() : route.getTargetHost(); final Timeout connectTimeout = timeout != null ? Timeout.of(timeout.getDuration(), timeout.getTimeUnit()) : connectionConfig.getConnectTimeout(); final ManagedHttpClientConnection connection = internalEndpoint.getConnection(); if (LOG.isDebugEnabled()) { LOG.debug("{} connecting endpoint to {} ({})", ConnPoolSupport.getId(endpoint), firstHop, connectTimeout); } this.connectionOperator.connect( connection, firstHop, route.getTargetName(), route.getLocalSocketAddress(), connectTimeout, socketConfig, route.isTunnelled() ? null : tlsConfig, context); if (LOG.isDebugEnabled()) { LOG.debug("{} connected {}", ConnPoolSupport.getId(endpoint), ConnPoolSupport.getId(conn)); } final Timeout socketTimeout = connectionConfig.getSocketTimeout(); if (socketTimeout != null) { connection.setSocketTimeout(socketTimeout); } } finally { lock.unlock(); } } @Override public void upgrade( final ConnectionEndpoint endpoint, final HttpContext context) throws IOException { lock.lock(); try { Args.notNull(endpoint, "Endpoint"); Args.notNull(route, "HTTP route"); final InternalConnectionEndpoint internalEndpoint = cast(endpoint); final HttpRoute route = internalEndpoint.getRoute(); this.connectionOperator.upgrade( internalEndpoint.getConnection(), route.getTargetHost(), route.getTargetName(), tlsConfig, context); } finally { lock.unlock(); } } public void closeExpired() { lock.lock(); try { if (isClosed()) { return; } if (!this.leased) { checkExpiry(); } } finally { lock.unlock(); } } public void closeIdle(final TimeValue idleTime) { lock.lock(); try { Args.notNull(idleTime, "Idle time"); if (isClosed()) { return; } if (!this.leased) { long time = idleTime.toMilliseconds(); if (time < 0) { time = 0; } final long deadline = System.currentTimeMillis() - time; if (this.updated <= deadline) { closeConnection(CloseMode.GRACEFUL); } } } finally { lock.unlock(); } } /** * @see #setValidateAfterInactivity(TimeValue) * * @since 5.1 * * @deprecated Use {@link #getConnectionConfig()} */ @Deprecated public TimeValue getValidateAfterInactivity() { return connectionConfig.getValidateAfterInactivity(); } /** * Defines period of inactivity after which persistent connections must * be re-validated prior to being {@link #lease(String, HttpRoute, Object)} leased} to the consumer. * Negative values passed to this method disable connection validation. This check helps * detect connections that have become stale (half-closed) while kept inactive in the pool. * * @since 5.1 * * @deprecated Use {@link #setConnectionConfig(ConnectionConfig)} */ @Deprecated public void setValidateAfterInactivity(final TimeValue validateAfterInactivity) { this.connectionConfig = ConnectionConfig.custom() .setValidateAfterInactivity(validateAfterInactivity) .build(); } class InternalConnectionEndpoint extends ConnectionEndpoint implements ConnectionHolder, Identifiable { private final HttpRoute route; private final AtomicReference connRef; public InternalConnectionEndpoint(final HttpRoute route, final ManagedHttpClientConnection conn) { this.route = route; this.connRef = new AtomicReference<>(conn); } @Override public String getId() { return id; } HttpRoute getRoute() { return route; } ManagedHttpClientConnection getConnection() { final ManagedHttpClientConnection conn = this.connRef.get(); if (conn == null) { throw new ConnectionShutdownException(); } return conn; } ManagedHttpClientConnection getValidatedConnection() { final ManagedHttpClientConnection conn = this.connRef.get(); if (conn == null || !conn.isOpen()) { throw new ConnectionShutdownException(); } return conn; } ManagedHttpClientConnection detach() { return this.connRef.getAndSet(null); } @Override public boolean isConnected() { final ManagedHttpClientConnection conn = this.connRef.get(); return conn != null && conn.isOpen(); } @Override public void close(final CloseMode closeMode) { final ManagedHttpClientConnection conn = this.connRef.get(); if (conn != null) { conn.close(closeMode); } } @Override public void close() throws IOException { final ManagedHttpClientConnection conn = this.connRef.get(); if (conn != null) { conn.close(); } } @Override public void setSocketTimeout(final Timeout timeout) { getValidatedConnection().setSocketTimeout(timeout); } /** * @deprecated Use {@link #execute(String, ClassicHttpRequest, RequestExecutor, HttpContext)} */ @Deprecated @Override public ClassicHttpResponse execute( final String exchangeId, final ClassicHttpRequest request, final HttpRequestExecutor requestExecutor, final HttpContext context) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(requestExecutor, "Request executor"); if (LOG.isDebugEnabled()) { LOG.debug("{} Executing exchange {}", id, exchangeId); } return requestExecutor.execute(request, getValidatedConnection(), context); } /** * @since 5.4 */ @Override public ClassicHttpResponse execute( final String exchangeId, final ClassicHttpRequest request, final RequestExecutor requestExecutor, final HttpContext context) throws IOException, HttpException { Args.notNull(request, "HTTP request"); Args.notNull(requestExecutor, "Request executor"); if (LOG.isDebugEnabled()) { LOG.debug("{} Executing exchange {}", id, exchangeId); } return requestExecutor.execute(request, getValidatedConnection(), context); } /** * @since 5.4 */ @Override public EndpointInfo getInfo() { final ManagedHttpClientConnection connection = this.connRef.get(); if (connection != null && connection.isOpen()) { return new EndpointInfo(connection.getProtocolVersion(), connection.getSSLSession()); } return null; } @Override public HttpConnection get() { return this.connRef.get(); } } /** * Method that can be called to determine whether the connection manager has been shut down and * is closed or not. * * @return {@code true} if the connection manager has been shut down and is closed, otherwise * return {@code false}. * @since 5.4 */ public boolean isClosed() { return this.closed.get(); } } ././@LongLink0100644 0000000 0000000 00000000145 15005672016 011635 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/io/ManagedHttpClientConnectionFactory.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/io/ManagedHttpClientConnectionFactory.java0100664 0000000 0000000 00000025017 15005672016 032557 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.io.IOException; import java.net.Socket; import java.nio.charset.Charset; import java.nio.charset.CharsetDecoder; import java.nio.charset.CharsetEncoder; import java.nio.charset.CodingErrorAction; import java.util.concurrent.atomic.AtomicLong; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ContentLengthStrategy; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.DefaultContentLengthStrategy; import org.apache.hc.core5.http.impl.io.DefaultHttpRequestWriterFactory; import org.apache.hc.core5.http.impl.io.NoResponseOutOfOrderStrategy; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.HttpMessageParserFactory; import org.apache.hc.core5.http.io.HttpMessageWriterFactory; import org.apache.hc.core5.http.io.ResponseOutOfOrderStrategy; /** * Factory for {@link ManagedHttpClientConnection} instances. * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class ManagedHttpClientConnectionFactory implements HttpConnectionFactory { private static final AtomicLong COUNTER = new AtomicLong(); /** * Default instance of {@link ManagedHttpClientConnectionFactory}. */ public static final ManagedHttpClientConnectionFactory INSTANCE = new ManagedHttpClientConnectionFactory(); private final Http1Config h1Config; private final CharCodingConfig charCodingConfig; private final HttpMessageWriterFactory requestWriterFactory; private final HttpMessageParserFactory responseParserFactory; private final ContentLengthStrategy incomingContentStrategy; private final ContentLengthStrategy outgoingContentStrategy; private final ResponseOutOfOrderStrategy responseOutOfOrderStrategy; private ManagedHttpClientConnectionFactory( final Http1Config h1Config, final CharCodingConfig charCodingConfig, final HttpMessageWriterFactory requestWriterFactory, final HttpMessageParserFactory responseParserFactory, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy, final ResponseOutOfOrderStrategy responseOutOfOrderStrategy) { this.h1Config = h1Config != null ? h1Config : Http1Config.DEFAULT; this.charCodingConfig = charCodingConfig != null ? charCodingConfig : CharCodingConfig.DEFAULT; this.requestWriterFactory = requestWriterFactory != null ? requestWriterFactory : new DefaultHttpRequestWriterFactory(this.h1Config); this.responseParserFactory = responseParserFactory != null ? responseParserFactory : new DefaultHttpResponseParserFactory(this.h1Config); this.incomingContentStrategy = incomingContentStrategy != null ? incomingContentStrategy : DefaultContentLengthStrategy.INSTANCE; this.outgoingContentStrategy = outgoingContentStrategy != null ? outgoingContentStrategy : DefaultContentLengthStrategy.INSTANCE; this.responseOutOfOrderStrategy = responseOutOfOrderStrategy != null ? responseOutOfOrderStrategy : NoResponseOutOfOrderStrategy.INSTANCE; } public ManagedHttpClientConnectionFactory( final Http1Config h1Config, final CharCodingConfig charCodingConfig, final HttpMessageWriterFactory requestWriterFactory, final HttpMessageParserFactory responseParserFactory, final ContentLengthStrategy incomingContentStrategy, final ContentLengthStrategy outgoingContentStrategy) { this( h1Config, charCodingConfig, requestWriterFactory, responseParserFactory, incomingContentStrategy, outgoingContentStrategy, null); } public ManagedHttpClientConnectionFactory( final Http1Config h1Config, final CharCodingConfig charCodingConfig, final HttpMessageWriterFactory requestWriterFactory, final HttpMessageParserFactory responseParserFactory) { this(h1Config, charCodingConfig, requestWriterFactory, responseParserFactory, null, null); } public ManagedHttpClientConnectionFactory( final Http1Config h1Config, final CharCodingConfig charCodingConfig, final HttpMessageParserFactory responseParserFactory) { this(h1Config, charCodingConfig, null, responseParserFactory); } public ManagedHttpClientConnectionFactory() { this(null, null, null); } @Override public ManagedHttpClientConnection createConnection(final Socket socket) throws IOException { CharsetDecoder charDecoder = null; CharsetEncoder charEncoder = null; final Charset charset = this.charCodingConfig.getCharset(); final CodingErrorAction malformedInputAction = this.charCodingConfig.getMalformedInputAction() != null ? this.charCodingConfig.getMalformedInputAction() : CodingErrorAction.REPORT; final CodingErrorAction unmappableInputAction = this.charCodingConfig.getUnmappableInputAction() != null ? this.charCodingConfig.getUnmappableInputAction() : CodingErrorAction.REPORT; if (charset != null) { charDecoder = charset.newDecoder(); charDecoder.onMalformedInput(malformedInputAction); charDecoder.onUnmappableCharacter(unmappableInputAction); charEncoder = charset.newEncoder(); charEncoder.onMalformedInput(malformedInputAction); charEncoder.onUnmappableCharacter(unmappableInputAction); } final String id = "http-outgoing-" + COUNTER.getAndIncrement(); final DefaultManagedHttpClientConnection conn = new DefaultManagedHttpClientConnection( id, charDecoder, charEncoder, h1Config, incomingContentStrategy, outgoingContentStrategy, responseOutOfOrderStrategy, requestWriterFactory, responseParserFactory); if (socket != null) { conn.bind(socket); } return conn; } /** * Create a new {@link Builder}. * * @since 5.1 */ public static Builder builder() { return new Builder(); } /** * Builder for {@link ManagedHttpClientConnectionFactory}. * * @since 5.1 */ public static final class Builder { private Http1Config http1Config; private CharCodingConfig charCodingConfig; private ContentLengthStrategy incomingContentLengthStrategy; private ContentLengthStrategy outgoingContentLengthStrategy; private ResponseOutOfOrderStrategy responseOutOfOrderStrategy; private HttpMessageWriterFactory requestWriterFactory; private HttpMessageParserFactory responseParserFactory; private Builder() { } public Builder http1Config(final Http1Config http1Config) { this.http1Config = http1Config; return this; } public Builder charCodingConfig(final CharCodingConfig charCodingConfig) { this.charCodingConfig = charCodingConfig; return this; } public Builder incomingContentLengthStrategy(final ContentLengthStrategy incomingContentLengthStrategy) { this.incomingContentLengthStrategy = incomingContentLengthStrategy; return this; } public Builder outgoingContentLengthStrategy(final ContentLengthStrategy outgoingContentLengthStrategy) { this.outgoingContentLengthStrategy = outgoingContentLengthStrategy; return this; } public Builder responseOutOfOrderStrategy(final ResponseOutOfOrderStrategy responseOutOfOrderStrategy) { this.responseOutOfOrderStrategy = responseOutOfOrderStrategy; return this; } public Builder requestWriterFactory( final HttpMessageWriterFactory requestWriterFactory) { this.requestWriterFactory = requestWriterFactory; return this; } public Builder responseParserFactory( final HttpMessageParserFactory responseParserFactory) { this.responseParserFactory = responseParserFactory; return this; } public ManagedHttpClientConnectionFactory build() { return new ManagedHttpClientConnectionFactory( http1Config, charCodingConfig, requestWriterFactory, responseParserFactory, incomingContentLengthStrategy, outgoingContentLengthStrategy, responseOutOfOrderStrategy); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/0040775 0000000 0000000 00000000000 15005672016 023663 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/AbstractSharedBuffer.java0100664 0000000 0000000 00000006122 15005672016 030550 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.compat; import java.util.concurrent.locks.Condition; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.impl.nio.ExpandableBuffer; import org.apache.hc.core5.util.Args; /** * TODO: to be replaced by core functionality */ @Internal abstract class AbstractSharedBuffer extends ExpandableBuffer { final ReentrantLock lock; final Condition condition; volatile boolean endStream; volatile boolean aborted; public AbstractSharedBuffer(final ReentrantLock lock, final int initialBufferSize) { super(initialBufferSize); this.lock = Args.notNull(lock, "Lock"); this.condition = lock.newCondition(); } @Override public boolean hasData() { lock.lock(); try { return super.hasData(); } finally { lock.unlock(); } } @Override public int capacity() { lock.lock(); try { return super.capacity(); } finally { lock.unlock(); } } @Override public int length() { lock.lock(); try { return super.length(); } finally { lock.unlock(); } } public void abort() { lock.lock(); try { endStream = true; aborted = true; condition.signalAll(); } finally { lock.unlock(); } } public void reset() { if (aborted) { return; } lock.lock(); try { setInputMode(); buffer().clear(); endStream = false; } finally { lock.unlock(); } } public boolean isEndStream() { lock.lock(); try { return endStream && !super.hasData(); } finally { lock.unlock(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/ClassicToAsyncRequestProducer.java0100664 0000000 0000000 00000015106 15005672016 032465 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.compat; import java.io.IOException; import java.io.InterruptedIOException; import java.io.OutputStream; import java.util.concurrent.CountDownLatch; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.nio.AsyncRequestProducer; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.Timeout; /** * TODO: to be replaced by core functionality */ @Experimental @Internal class ClassicToAsyncRequestProducer implements AsyncRequestProducer { private final ClassicHttpRequest request; private final int initialBufferSize; private final Timeout timeout; private final CountDownLatch countDownLatch; private final AtomicReference bufferRef; private final AtomicReference exceptionRef; private volatile boolean repeatable; public interface IORunnable { void execute() throws IOException; } public ClassicToAsyncRequestProducer(final ClassicHttpRequest request, final int initialBufferSize, final Timeout timeout) { this.request = Args.notNull(request, "HTTP request"); this.initialBufferSize = Args.positive(initialBufferSize, "Initial buffer size"); this.timeout = timeout; this.countDownLatch = new CountDownLatch(1); this.bufferRef = new AtomicReference<>(); this.exceptionRef = new AtomicReference<>(); } public ClassicToAsyncRequestProducer(final ClassicHttpRequest request, final Timeout timeout) { this(request, ClassicToAsyncSupport.INITIAL_BUF_SIZE, timeout); } void propagateException() throws IOException { final Exception ex = exceptionRef.getAndSet(null); if (ex != null) { ClassicToAsyncSupport.rethrow(ex); } } public IORunnable blockWaiting() throws IOException, InterruptedException { if (timeout == null) { countDownLatch.await(); } else { if (!countDownLatch.await(timeout.getDuration(), timeout.getTimeUnit())) { throw new InterruptedIOException("Timeout blocked waiting for output (" + timeout + ")"); } } propagateException(); final SharedOutputBuffer outputBuffer = bufferRef.get(); return () -> { final HttpEntity requestEntity = request.getEntity(); if (requestEntity != null) { try (final InternalOutputStream outputStream = new InternalOutputStream(outputBuffer)) { requestEntity.writeTo(outputStream); } } }; } @Override public void sendRequest(final RequestChannel channel, final HttpContext context) throws HttpException, IOException { final HttpEntity requestEntity = request.getEntity(); final SharedOutputBuffer buffer = requestEntity != null ? new SharedOutputBuffer(initialBufferSize) : null; bufferRef.set(buffer); repeatable = requestEntity == null || requestEntity.isRepeatable(); channel.sendRequest(request, requestEntity, null); countDownLatch.countDown(); } @Override public boolean isRepeatable() { return repeatable; } @Override public int available() { final SharedOutputBuffer buffer = bufferRef.get(); if (buffer != null) { return buffer.length(); } return 0; } @Override public void produce(final DataStreamChannel channel) throws IOException { final SharedOutputBuffer buffer = bufferRef.get(); if (buffer != null) { buffer.flush(channel); } } @Override public void failed(final Exception cause) { try { exceptionRef.set(cause); } finally { countDownLatch.countDown(); } } @Override public void releaseResources() { } class InternalOutputStream extends OutputStream { private final SharedOutputBuffer buffer; public InternalOutputStream(final SharedOutputBuffer buffer) { Asserts.notNull(buffer, "Shared buffer"); this.buffer = buffer; } @Override public void close() throws IOException { propagateException(); this.buffer.writeCompleted(timeout); } @Override public void flush() throws IOException { propagateException(); } @Override public void write(final byte[] b, final int off, final int len) throws IOException { propagateException(); this.buffer.write(b, off, len, timeout); } @Override public void write(final byte[] b) throws IOException { propagateException(); if (b == null) { return; } this.buffer.write(b, 0, b.length, timeout); } @Override public void write(final int b) throws IOException { propagateException(); this.buffer.write(b, timeout); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/ClassicToAsyncSupport.java0100664 0000000 0000000 00000003654 15005672016 031012 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.compat; import java.io.IOException; import org.apache.hc.core5.http.HttpException; final class ClassicToAsyncSupport { final static int INITIAL_BUF_SIZE = 2048; static void rethrow(final Throwable ex) throws IOException { if (ex instanceof Error) { throw (Error) ex; } else if (ex instanceof RuntimeException) { throw (RuntimeException) ex; } else if (ex instanceof IOException) { throw new TransportException((IOException) ex); } else if (ex instanceof HttpException) { throw new ProtocolException((HttpException) ex); } else { // Unexpected exception type throw new IllegalStateException(ex); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/SharedOutputBuffer.java0100664 0000000 0000000 00000015630 15005672016 030311 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.compat; import java.io.IOException; import java.io.InterruptedIOException; import java.nio.ByteBuffer; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.support.classic.ContentOutputBuffer; import org.apache.hc.core5.util.Timeout; /** * TODO: to be replaced by core functionality */ @Internal final class SharedOutputBuffer extends AbstractSharedBuffer implements ContentOutputBuffer { private final AtomicBoolean endStreamPropagated; private volatile DataStreamChannel dataStreamChannel; private volatile boolean hasCapacity; public SharedOutputBuffer(final ReentrantLock lock, final int initialBufferSize) { super(lock, initialBufferSize); this.hasCapacity = false; this.endStreamPropagated = new AtomicBoolean(); } public SharedOutputBuffer(final int bufferSize) { this(new ReentrantLock(), bufferSize); } public void flush(final DataStreamChannel channel) throws IOException { lock.lock(); try { dataStreamChannel = channel; hasCapacity = true; setOutputMode(); if (buffer().hasRemaining()) { dataStreamChannel.write(buffer()); } if (!buffer().hasRemaining() && endStream) { propagateEndStream(); } condition.signalAll(); } finally { lock.unlock(); } } private void ensureNotAborted() throws InterruptedIOException { if (aborted) { throw new InterruptedIOException("Operation aborted"); } } /** * @since 5.4 */ public void write(final byte[] b, final int off, final int len, final Timeout timeout) throws IOException { final ByteBuffer src = ByteBuffer.wrap(b, off, len); lock.lock(); try { ensureNotAborted(); setInputMode(); while (src.hasRemaining()) { // always buffer small chunks if (src.remaining() < 1024 && buffer().remaining() > src.remaining()) { buffer().put(src); } else { if (buffer().position() > 0 || dataStreamChannel == null) { waitFlush(timeout); } if (buffer().position() == 0 && dataStreamChannel != null) { final int bytesWritten = dataStreamChannel.write(src); if (bytesWritten == 0) { hasCapacity = false; waitFlush(timeout); } } } } } finally { lock.unlock(); } } @Override public void write(final byte[] b, final int off, final int len) throws IOException { write(b, off, len, null); } /** * @since 5.4 */ public void write(final int b, final Timeout timeout) throws IOException { lock.lock(); try { ensureNotAborted(); setInputMode(); if (!buffer().hasRemaining()) { waitFlush(timeout); } buffer().put((byte)b); } finally { lock.unlock(); } } @Override public void write(final int b) throws IOException { write(b, null); } /** * @since 5.4 */ public void writeCompleted(final Timeout timeout) throws IOException { if (endStream) { return; } lock.lock(); try { if (!endStream) { endStream = true; if (dataStreamChannel != null) { setOutputMode(); if (buffer().hasRemaining()) { dataStreamChannel.requestOutput(); waitEndStream(timeout); } else { propagateEndStream(); } } } } finally { lock.unlock(); } } @Override public void writeCompleted() throws IOException { writeCompleted(null); } private void waitFlush(final Timeout timeout) throws InterruptedIOException { if (dataStreamChannel != null) { dataStreamChannel.requestOutput(); } setOutputMode(); while (buffer().hasRemaining() || !hasCapacity) { ensureNotAborted(); waitForSignal(timeout); } setInputMode(); } private void waitEndStream(final Timeout timeout) throws InterruptedIOException { if (dataStreamChannel != null) { dataStreamChannel.requestOutput(); } while (!endStreamPropagated.get() && !aborted) { waitForSignal(timeout); } } private void waitForSignal(final Timeout timeout) throws InterruptedIOException { try { if (timeout == null) { condition.await(); } else { if (!condition.await(timeout.getDuration(), timeout.getTimeUnit())) { aborted = true; throw new InterruptedIOException("Timeout blocked waiting for output (" + timeout + ")"); } } } catch (final InterruptedException ex) { Thread.currentThread().interrupt(); throw new InterruptedIOException(ex.getMessage()); } } private void propagateEndStream() throws IOException { if (endStreamPropagated.compareAndSet(false, true)) { dataStreamChannel.endStream(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/ProtocolException.java0100664 0000000 0000000 00000003030 15005672016 030177 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.compat; import java.io.IOException; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.HttpException; /** * TODO: to be replaced by core functionality */ @Internal public class ProtocolException extends IOException { public ProtocolException(final HttpException ex) { super(ex); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/TransportException.java0100664 0000000 0000000 00000002751 15005672016 030403 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.compat; import java.io.IOException; import org.apache.hc.core5.annotation.Internal; /** * TODO: to be replaced by core functionality */ @Internal public class TransportException extends IOException { public TransportException(final IOException ex) { super(ex); } } ././@LongLink0100644 0000000 0000000 00000000145 15005672016 011635 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/ClassicToAsyncResponseConsumer.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/ClassicToAsyncResponseConsumer.java0100664 0000000 0000000 00000025071 15005672016 032645 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.compat; import java.io.IOException; import java.io.InputStream; import java.io.InterruptedIOException; import java.io.OutputStream; import java.nio.ByteBuffer; import java.util.Collections; import java.util.List; import java.util.Set; import java.util.concurrent.CountDownLatch; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.io.entity.AbstractHttpEntity; import org.apache.hc.core5.http.io.support.ClassicResponseBuilder; import org.apache.hc.core5.http.nio.AsyncResponseConsumer; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.Closer; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.Asserts; import org.apache.hc.core5.util.Timeout; /** * TODO: to be replaced by core functionality */ @Experimental @Internal class ClassicToAsyncResponseConsumer implements AsyncResponseConsumer { static class ResponseData { final HttpResponse head; final EntityDetails entityDetails; ResponseData(final HttpResponse head, final EntityDetails entityDetails) { this.head = head; this.entityDetails = entityDetails; } } private final int initialBufferSize; private final Timeout timeout; private final CountDownLatch countDownLatch; private final AtomicReference responseRef; private final AtomicReference> callbackRef; private final AtomicReference bufferRef; private final AtomicReference exceptionRef; public ClassicToAsyncResponseConsumer(final int initialBufferSize, final Timeout timeout) { this.initialBufferSize = Args.positive(initialBufferSize, "Initial buffer size"); this.timeout = timeout; this.countDownLatch = new CountDownLatch(1); this.responseRef = new AtomicReference<>(); this.callbackRef = new AtomicReference<>(); this.bufferRef = new AtomicReference<>(); this.exceptionRef = new AtomicReference<>(); } public ClassicToAsyncResponseConsumer(final Timeout timeout) { this(ClassicToAsyncSupport.INITIAL_BUF_SIZE, timeout); } void propagateException() throws IOException { final Exception ex = exceptionRef.getAndSet(null); if (ex != null) { ClassicToAsyncSupport.rethrow(ex); } } void fireComplete() throws IOException { final FutureCallback callback = callbackRef.getAndSet(null); if (callback != null) { callback.completed(null); } } public ClassicHttpResponse blockWaiting() throws IOException, InterruptedException { if (timeout == null) { countDownLatch.await(); } else { if (!countDownLatch.await(timeout.getDuration(), timeout.getTimeUnit())) { throw new InterruptedIOException("Timeout blocked waiting for input (" + timeout + ")"); } } propagateException(); final ResponseData r = responseRef.getAndSet(null); Asserts.notNull(r, "HTTP response is missing"); final SharedInputBuffer inputBuffer = bufferRef.get(); return ClassicResponseBuilder.create(r.head.getCode()) .setHeaders(r.head.getHeaders()) .setVersion(r.head.getVersion()) .setEntity(r.entityDetails != null ? new IncomingHttpEntity(new InternalInputStream(inputBuffer), r.entityDetails) : null) .build(); } @Override public void consumeResponse(final HttpResponse asyncResponse, final EntityDetails entityDetails, final HttpContext context, final FutureCallback resultCallback) throws HttpException, IOException { callbackRef.set(resultCallback); final ResponseData responseData = new ResponseData(asyncResponse, entityDetails); responseRef.set(responseData); if (entityDetails != null) { bufferRef.set(new SharedInputBuffer(initialBufferSize)); } else { fireComplete(); } countDownLatch.countDown(); } @Override public void informationResponse(final HttpResponse response, final HttpContext context) throws HttpException, IOException { } @Override public final void updateCapacity(final CapacityChannel capacityChannel) throws IOException { final SharedInputBuffer buffer = bufferRef.get(); if (buffer != null) { buffer.updateCapacity(capacityChannel); } } @Override public final void consume(final ByteBuffer src) throws IOException { final SharedInputBuffer buffer = bufferRef.get(); if (buffer != null) { buffer.fill(src); } } @Override public final void streamEnd(final List trailers) throws HttpException, IOException { final SharedInputBuffer buffer = bufferRef.get(); if (buffer != null) { buffer.markEndStream(); } } @Override public final void failed(final Exception cause) { try { exceptionRef.set(cause); } finally { countDownLatch.countDown(); } } @Override public void releaseResources() { } class InternalInputStream extends InputStream { private final SharedInputBuffer buffer; InternalInputStream(final SharedInputBuffer buffer) { super(); Args.notNull(buffer, "Input buffer"); this.buffer = buffer; } @Override public int available() throws IOException { propagateException(); return this.buffer.length(); } @Override public int read(final byte[] b, final int off, final int len) throws IOException { propagateException(); if (len == 0) { return 0; } final int bytesRead = this.buffer.read(b, off, len, timeout); if (bytesRead == -1) { fireComplete(); } return bytesRead; } @Override public int read(final byte[] b) throws IOException { propagateException(); if (b == null) { return 0; } final int bytesRead = this.buffer.read(b, 0, b.length, timeout); if (bytesRead == -1) { fireComplete(); } return bytesRead; } @Override public int read() throws IOException { propagateException(); final int b = this.buffer.read(timeout); if (b == -1) { fireComplete(); } return b; } @Override public void close() throws IOException { // read and discard the remainder of the message final byte[] tmp = new byte[1024]; do { /* empty */ } while (read(tmp) >= 0); super.close(); } } static class IncomingHttpEntity implements HttpEntity { private final InputStream content; private final EntityDetails entityDetails; IncomingHttpEntity(final InputStream content, final EntityDetails entityDetails) { this.content = content; this.entityDetails = entityDetails; } @Override public boolean isRepeatable() { return false; } @Override public boolean isChunked() { return entityDetails.isChunked(); } @Override public long getContentLength() { return entityDetails.getContentLength(); } @Override public String getContentType() { return entityDetails.getContentType(); } @Override public String getContentEncoding() { return entityDetails.getContentEncoding(); } @Override public InputStream getContent() throws IOException, IllegalStateException { return content; } @Override public boolean isStreaming() { return content != null; } @Override public void writeTo(final OutputStream outStream) throws IOException { AbstractHttpEntity.writeTo(this, outStream); } @Override public Supplier> getTrailers() { return null; } @Override public Set getTrailerNames() { return Collections.emptySet(); } @Override public void close() throws IOException { Closer.close(content); } @Override public String toString() { return entityDetails.toString(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/IOCallback.java0100664 0000000 0000000 00000002645 15005672016 026456 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.compat; import java.io.IOException; /** * Abstract I/O callback. * * @param the type of the input to the operation. * @since 5.0 */ interface IOCallback { void execute(T object) throws IOException; } httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/ClassicToAsyncAdaptor.java0100664 0000000 0000000 00000010573 15005672016 030726 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.compat; import java.io.IOException; import java.io.InterruptedIOException; import java.util.concurrent.Future; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.CloseableHttpResponse; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.Timeout; /** * {@link CloseableHttpClient} implementation backed by {@link CloseableHttpAsyncClient} * acting as a compatibility bridge with the classic APIs based on the standard * {@link java.io.InputStream} / {@link java.io.OutputStream} model. * * @since 5.5 */ @Experimental @Internal @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) public class ClassicToAsyncAdaptor extends CloseableHttpClient { private final CloseableHttpAsyncClient client; private final Timeout operationTimeout; public ClassicToAsyncAdaptor(final CloseableHttpAsyncClient client, final Timeout operationTimeout) { super(); this.client = client; this.operationTimeout = operationTimeout; } @Override protected CloseableHttpResponse doExecute( final HttpHost target, final ClassicHttpRequest request, final HttpContext context) throws IOException { final ClassicToAsyncRequestProducer requestProducer = new ClassicToAsyncRequestProducer(request, operationTimeout); final ClassicToAsyncResponseConsumer responseConsumer = new ClassicToAsyncResponseConsumer(operationTimeout); final Future resultFuture = client.execute(target, requestProducer, responseConsumer, null, context, null); if (request instanceof CancellableDependency) { ((CancellableDependency) request).setDependency(() -> resultFuture.cancel(true)); } try { requestProducer.blockWaiting().execute(); final ClassicHttpResponse response = responseConsumer.blockWaiting(); return CloseableHttpResponse.create(response, (closeable, closeMode) -> { try { if (closeMode == CloseMode.GRACEFUL) { closeable.close(); } } finally { resultFuture.cancel(true); } }); } catch (final InterruptedException ex) { Thread.currentThread().interrupt(); throw new InterruptedIOException(); } } @Override public void close() throws IOException { client.close(); } @Override public void close(final CloseMode closeMode) { client.close(closeMode); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/compat/SharedInputBuffer.java0100664 0000000 0000000 00000014345 15005672016 030112 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.compat; import java.io.IOException; import java.io.InterruptedIOException; import java.nio.ByteBuffer; import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.support.classic.ContentInputBuffer; import org.apache.hc.core5.util.Timeout; /** * TODO: to be replaced by core functionality */ @Internal final class SharedInputBuffer extends AbstractSharedBuffer implements ContentInputBuffer { private final int initialBufferSize; private final AtomicInteger capacityIncrement; private volatile CapacityChannel capacityChannel; public SharedInputBuffer(final ReentrantLock lock, final int initialBufferSize) { super(lock, initialBufferSize); this.initialBufferSize = initialBufferSize; this.capacityIncrement = new AtomicInteger(0); } public SharedInputBuffer(final int bufferSize) { this(new ReentrantLock(), bufferSize); } public int fill(final ByteBuffer src) { lock.lock(); try { setInputMode(); ensureAdjustedCapacity(buffer().position() + src.remaining()); buffer().put(src); final int remaining = buffer().remaining(); condition.signalAll(); return remaining; } finally { lock.unlock(); } } private void incrementCapacity() throws IOException { if (capacityChannel != null) { final int increment = capacityIncrement.getAndSet(0); if (increment > 0) { capacityChannel.update(increment); } } } public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { lock.lock(); try { this.capacityChannel = capacityChannel; setInputMode(); if (buffer().position() == 0) { capacityChannel.update(initialBufferSize); } } finally { lock.unlock(); } } private void awaitInput(final Timeout timeout) throws InterruptedIOException { if (!buffer().hasRemaining()) { setInputMode(); while (buffer().position() == 0 && !endStream && !aborted) { try { if (timeout == null) { condition.await(); } else { if (!condition.await(timeout.getDuration(), timeout.getTimeUnit())) { throw new InterruptedIOException("Timeout blocked waiting for input (" + timeout + ")"); } } } catch (final InterruptedException ex) { Thread.currentThread().interrupt(); throw new InterruptedIOException(ex.getMessage()); } } setOutputMode(); } } private void ensureNotAborted() throws InterruptedIOException { if (aborted) { throw new InterruptedIOException("Operation aborted"); } } @Override public int read() throws IOException { return read(null); } /** * @since 5.4 */ public int read(final Timeout timeout) throws IOException { lock.lock(); try { setOutputMode(); awaitInput(timeout); ensureNotAborted(); if (!buffer().hasRemaining() && endStream) { return -1; } final int b = buffer().get() & 0xff; capacityIncrement.incrementAndGet(); if (!buffer().hasRemaining()) { incrementCapacity(); } return b; } finally { lock.unlock(); } } @Override public int read(final byte[] b, final int off, final int len) throws IOException { return read(b, off, len, null); } /** * @since 5.4 */ public int read(final byte[] b, final int off, final int len, final Timeout timeout) throws IOException { if (len == 0) { return 0; } lock.lock(); try { setOutputMode(); awaitInput(timeout); ensureNotAborted(); if (!buffer().hasRemaining() && endStream) { return -1; } final int chunk = Math.min(buffer().remaining(), len); buffer().get(b, off, chunk); capacityIncrement.addAndGet(chunk); if (!buffer().hasRemaining()) { incrementCapacity(); } return chunk; } finally { lock.unlock(); } } public void markEndStream() { if (endStream) { return; } lock.lock(); try { if (!endStream) { endStream = true; capacityChannel = null; condition.signalAll(); } } finally { lock.unlock(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ConnectionShutdownException.java0100664 0000000 0000000 00000003201 14666635064 030764 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; /** * Signals that the connection has been shut down or released back to the * the connection pool * * @since 4.1 */ public class ConnectionShutdownException extends IllegalStateException { private static final long serialVersionUID = 5868657401162844497L; /** * Creates a new ConnectionShutdownException with a {@code null} detail message. */ public ConnectionShutdownException() { super(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultConnectionKeepAliveStrategy.java0100664 0000000 0000000 00000006465 15005672016 032170 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.Iterator; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.message.MessageSupport; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TimeValue; /** * Default implementation of a strategy deciding duration * that a connection can remain idle. *

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

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultConnectionKeepAliveStrategy implements ConnectionKeepAliveStrategy { /** * Default instance of {@link DefaultConnectionKeepAliveStrategy}. */ public static final DefaultConnectionKeepAliveStrategy INSTANCE = new DefaultConnectionKeepAliveStrategy(); @Override public TimeValue getKeepAliveDuration(final HttpResponse response, final HttpContext context) { Args.notNull(response, "HTTP response"); final Iterator it = MessageSupport.iterate(response, HeaderElements.KEEP_ALIVE); while (it.hasNext()) { final HeaderElement he = it.next(); final String param = he.getName(); final String value = he.getValue(); if (value != null && param.equalsIgnoreCase("timeout")) { try { return TimeValue.ofSeconds(Long.parseLong(value)); } catch (final NumberFormatException ignore) { } } } final HttpClientContext clientContext = HttpClientContext.cast(context); final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault(); return requestConfig.getConnectionKeepAlive(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultAuthenticationStrategy.java0100664 0000000 0000000 00000012317 15005672016 031253 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.List; import java.util.Locale; import java.util.Map; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Default implementation of {@link AuthenticationStrategy} * * @since 5.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultAuthenticationStrategy implements AuthenticationStrategy { private static final Logger LOG = LoggerFactory.getLogger(DefaultAuthenticationStrategy.class); /** * Default instance of {@link DefaultAuthenticationStrategy}. */ public static final DefaultAuthenticationStrategy INSTANCE = new DefaultAuthenticationStrategy(); private static final List DEFAULT_SCHEME_PRIORITY = Collections.unmodifiableList(Arrays.asList( StandardAuthScheme.BEARER, StandardAuthScheme.DIGEST, StandardAuthScheme.BASIC)); protected List getSchemePriority() { return DEFAULT_SCHEME_PRIORITY; } @Override public List select( final ChallengeType challengeType, final Map challenges, final HttpContext context) { Args.notNull(challengeType, "ChallengeType"); Args.notNull(challenges, "Map of auth challenges"); Args.notNull(context, "HTTP context"); final HttpClientContext clientContext = HttpClientContext.cast(context); final String exchangeId = clientContext.getExchangeId(); final List options = new ArrayList<>(); final Lookup registry = clientContext.getAuthSchemeRegistry(); if (registry == null) { if (LOG.isDebugEnabled()) { LOG.debug("{} Auth scheme registry not set in the context", exchangeId); } return options; } final RequestConfig config = clientContext.getRequestConfigOrDefault(); Collection authPrefs = challengeType == ChallengeType.TARGET ? config.getTargetPreferredAuthSchemes() : config.getProxyPreferredAuthSchemes(); if (authPrefs == null) { authPrefs = getSchemePriority(); } if (LOG.isDebugEnabled()) { LOG.debug("{} Authentication schemes in the order of preference: {}", exchangeId, authPrefs); } for (final String schemeName: authPrefs) { final AuthChallenge challenge = challenges.get(schemeName.toLowerCase(Locale.ROOT)); if (challenge != null) { final AuthSchemeFactory authSchemeFactory = registry.lookup(schemeName); if (authSchemeFactory == null) { if (LOG.isWarnEnabled()) { LOG.warn("{} Authentication scheme {} not supported", exchangeId, schemeName); // Try again } continue; } final AuthScheme authScheme = authSchemeFactory.create(context); options.add(authScheme); } else { if (LOG.isDebugEnabled()) { LOG.debug("{} Challenge for {} authentication scheme not available", exchangeId, schemeName); } } } return options; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultClientConnectionReuseStrategy.java0100664 0000000 0000000 00000004664 14704162040 032540 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.impl.DefaultConnectionReuseStrategy; import org.apache.hc.core5.http.protocol.HttpContext; /** * Extension of core {@link DefaultConnectionReuseStrategy} that treats * CONNECT method exchanges involved in proxy tunnelling as a special case. * * @since 5.2 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultClientConnectionReuseStrategy extends DefaultConnectionReuseStrategy { /** * Default instance of {@link DefaultClientConnectionReuseStrategy}. */ public static final DefaultClientConnectionReuseStrategy INSTANCE = new DefaultClientConnectionReuseStrategy(); @Override public boolean keepAlive(final HttpRequest request, final HttpResponse response, final HttpContext context) { if (Method.CONNECT.isSame(request.getMethod()) && response.getCode() == HttpStatus.SC_OK) { return true; } return super.keepAlive(request, response, context); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultSchemePortResolver.java0100664 0000000 0000000 00000004721 14704162040 030340 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.util.Args; /** * Default {@link SchemePortResolver}. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultSchemePortResolver implements SchemePortResolver { /** * Default instance of {@link DefaultSchemePortResolver}. */ public static final DefaultSchemePortResolver INSTANCE = new DefaultSchemePortResolver(); @Override public int resolve(final HttpHost host) { Args.notNull(host, "HTTP host"); return resolve(host.getSchemeName(), host); } @Override public int resolve(final String scheme, final NamedEndpoint endpoint) { Args.notNull(endpoint, "Endpoint"); final int port = endpoint.getPort(); if (port > 0) { return port; } if (URIScheme.HTTP.same(scheme)) { return 80; } else if (URIScheme.HTTPS.same(scheme)) { return 443; } else { return -1; } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/DefaultRedirectStrategy.java0100664 0000000 0000000 00000014731 15063503632 030040 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.net.URI; import java.net.URISyntaxException; import java.util.Iterator; import java.util.Locale; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.utils.URIUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.util.Args; /** * Default implementation of {@link RedirectStrategy}. * * @since 4.1 */ @Contract(threading = ThreadingBehavior.STATELESS) public class DefaultRedirectStrategy implements RedirectStrategy { private final SchemePortResolver schemePortResolver; /** * Default instance of {@link DefaultRedirectStrategy}. */ public static final DefaultRedirectStrategy INSTANCE = new DefaultRedirectStrategy(); @Internal public DefaultRedirectStrategy(final SchemePortResolver schemePortResolver) { this.schemePortResolver = schemePortResolver != null ? schemePortResolver : DefaultSchemePortResolver.INSTANCE; } public DefaultRedirectStrategy() { this(null); } @Override public boolean isRedirectAllowed( final HttpHost currentTarget, final HttpHost newTarget, final HttpRequest redirect, final HttpContext context) { // If authority (host + effective port) differs, strip sensitive headers if (!isSameAuthority(currentTarget, newTarget)) { for (final Iterator
it = redirect.headerIterator(); it.hasNext(); ) { final Header header = it.next(); if (header.isSensitive() || header.getName().equalsIgnoreCase(HttpHeaders.AUTHORIZATION) || header.getName().equalsIgnoreCase(HttpHeaders.COOKIE)) { return false; } } } return true; } private boolean isSameAuthority(final HttpHost h1, final HttpHost h2) { if (h1 == null || h2 == null) { return false; } final String host1 = h1.getHostName(); final String host2 = h2.getHostName(); if (!host1.equalsIgnoreCase(host2)) { return false; } final int port1 = schemePortResolver.resolve(h1); final int port2 = schemePortResolver.resolve(h2); return port1 == port2; } @Override public boolean isRedirected( final HttpRequest request, final HttpResponse response, final HttpContext context) throws ProtocolException { Args.notNull(request, "HTTP request"); Args.notNull(response, "HTTP response"); if (!response.containsHeader(HttpHeaders.LOCATION)) { return false; } final int statusCode = response.getCode(); switch (statusCode) { case HttpStatus.SC_MOVED_PERMANENTLY: case HttpStatus.SC_MOVED_TEMPORARILY: case HttpStatus.SC_SEE_OTHER: case HttpStatus.SC_TEMPORARY_REDIRECT: case HttpStatus.SC_PERMANENT_REDIRECT: return true; default: return false; } } @Override public URI getLocationURI( final HttpRequest request, final HttpResponse response, final HttpContext context) throws HttpException { Args.notNull(request, "HTTP request"); Args.notNull(response, "HTTP response"); Args.notNull(context, "HTTP context"); //get the location header to find out where to redirect to final Header locationHeader = response.getFirstHeader(HttpHeaders.LOCATION); if (locationHeader == null) { throw new HttpException("Redirect location is missing"); } final String location = locationHeader.getValue(); URI uri = createLocationURI(location); try { if (!uri.isAbsolute()) { // Resolve location URI uri = URIUtils.resolve(request.getUri(), uri); } } catch (final URISyntaxException ex) { throw new ProtocolException(ex.getMessage(), ex); } return uri; } /** * @since 4.1 */ protected URI createLocationURI(final String location) throws ProtocolException { try { final URIBuilder b = new URIBuilder(new URI(location).normalize()); final String host = b.getHost(); if (host != null) { b.setHost(host.toLowerCase(Locale.ROOT)); } if (b.isPathEmpty()) { b.setPathSegments(""); } return b.build(); } catch (final URISyntaxException ex) { throw new ProtocolException("Invalid redirect URI: " + location, ex); } } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/Operations.java0100664 0000000 0000000 00000007135 14704162040 025365 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import org.apache.hc.core5.concurrent.Cancellable; /** * Common cancellable operations. * * @since 5.0 */ public final class Operations { private final static Cancellable NOOP_CANCELLABLE = () -> false; /** * This class represents a {@link Future} in the completed state with a fixed result. * The outcome of the future cannot be altered and it cannot be cancelled. * * @param operation result representation. * * @deprecated Use {@link org.apache.hc.core5.concurrent.CompletedFuture}. */ @Deprecated public static class CompletedFuture implements Future { private final T result; public CompletedFuture(final T result) { this.result = result; } @Override public T get() throws InterruptedException, ExecutionException { return result; } @Override public T get(final long timeout, final TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException { return result; } @Override public boolean cancel(final boolean mayInterruptIfRunning) { return false; } @Override public boolean isCancelled() { return false; } @Override public boolean isDone() { return true; } } /** * Creates a {@link Cancellable} operation handle for an ongoing process * or operation that cannot be cancelled. Attempts to cancel the operation * with this handle will have no effect. * * @return the no-op cancellable operation handle. */ public static Cancellable nonCancellable() { return NOOP_CANCELLABLE; } /** * Creates a {@link Cancellable} operation handle for an ongoing process * or operation represented by a {@link Future}. * * @param future the result future * @return the cancellable operation handle. */ public static Cancellable cancellable(final Future future) { if (future == null) { return NOOP_CANCELLABLE; } if (future instanceof Cancellable) { return (Cancellable) future; } return () -> future.cancel(true); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/NoopUserTokenHandler.java0100664 0000000 0000000 00000003712 14704162040 027310 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * Noop implementation of {@link UserTokenHandler} that always returns {@code null}. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public class NoopUserTokenHandler implements UserTokenHandler { /** * Default instance of {@link NoopUserTokenHandler}. */ public static final NoopUserTokenHandler INSTANCE = new NoopUserTokenHandler(); @Override public Object getUserToken(final HttpRoute route, final HttpContext context) { return null; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/LaxRedirectStrategy.java0100664 0000000 0000000 00000007666 15063503632 027211 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.classic.methods.HttpDelete; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpHead; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.protocol.HttpContext; /** * A lax implementation of the {@link RedirectStrategy} that automatically handles HTTP redirects * for HEAD, GET, POST, and DELETE requests based on the response status code. * *

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

* *

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

* * @since 5.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class LaxRedirectStrategy extends DefaultRedirectStrategy { public static final LaxRedirectStrategy INSTANCE = new LaxRedirectStrategy(); private static final String[] REDIRECT_METHODS = new String[]{HttpGet.METHOD_NAME, HttpPost.METHOD_NAME, HttpHead.METHOD_NAME, HttpDelete.METHOD_NAME}; @Override public boolean isRedirected(final HttpRequest request, final HttpResponse response, final HttpContext context) { if (!response.containsHeader(HttpHeaders.LOCATION)) { return false; } final int statusCode = response.getCode(); final String method = request.getMethod(); final Header locationHeader = response.getFirstHeader("location"); switch (statusCode) { case HttpStatus.SC_MOVED_TEMPORARILY: return isRedirectable(method) && locationHeader != null; case HttpStatus.SC_MOVED_PERMANENTLY: case HttpStatus.SC_TEMPORARY_REDIRECT: return isRedirectable(method); case HttpStatus.SC_SEE_OTHER: return true; default: return false; } } protected boolean isRedirectable(final String method) { for (final String m : REDIRECT_METHODS) { if (m.equalsIgnoreCase(method)) { return true; } } return false; } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/0040775 0000000 0000000 00000000000 15005672035 023652 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/package-info.java0100664 0000000 0000000 00000002421 14666635064 027052 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Standard and common HTTP cookie management policies. */ package org.apache.hc.client5.http.impl.cookie; httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicPathHandler.java0100664 0000000 0000000 00000007102 14704162040 027641 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; /** * Cookie {@code path} attribute handler. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicPathHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link BasicPathHandler}. * * @since 5.2 */ public static final BasicPathHandler INSTANCE = new BasicPathHandler(); public BasicPathHandler() { super(); } @Override public void parse( final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); cookie.setPath(!TextUtils.isBlank(value) ? value : "/"); } @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { } static boolean pathMatch(final String uriPath, final String cookiePath) { String normalizedCookiePath = cookiePath; if (normalizedCookiePath == null) { normalizedCookiePath = "/"; } if (normalizedCookiePath.length() > 1 && normalizedCookiePath.endsWith("/")) { normalizedCookiePath = normalizedCookiePath.substring(0, normalizedCookiePath.length() - 1); } if (uriPath.startsWith(normalizedCookiePath)) { if (normalizedCookiePath.equals("/")) { return true; } if (uriPath.length() == normalizedCookiePath.length()) { return true; } return uriPath.charAt(normalizedCookiePath.length()) == '/'; } return false; } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); return pathMatch(origin.getPath(), cookie.getPath()); } @Override public String getAttributeName() { return Cookie.PATH_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/LaxMaxAgeHandler.java0100664 0000000 0000000 00000006121 14704162040 027612 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.Instant; import java.util.regex.Matcher; import java.util.regex.Pattern; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; /** * Cookie {@code max-age} attribute handler conformant to the more relaxed interpretation * of HTTP state management. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class LaxMaxAgeHandler extends AbstractCookieAttributeHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link LaxMaxAgeHandler}. * * @since 5.2 */ public static final LaxMaxAgeHandler INSTANCE = new LaxMaxAgeHandler(); private final static Pattern MAX_AGE_PATTERN = Pattern.compile("^\\-?[0-9]+$"); public LaxMaxAgeHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); if (TextUtils.isBlank(value)) { return; } final Matcher matcher = MAX_AGE_PATTERN.matcher(value); if (matcher.matches()) { final int age; try { age = Integer.parseInt(value); } catch (final NumberFormatException e) { return; } final Instant expiryDate = age >= 0 ? Instant.now().plusSeconds(age) : Instant.EPOCH; cookie.setExpiryDate(expiryDate); } } @Override public String getAttributeName() { return Cookie.MAX_AGE_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicClientCookie.java0100664 0000000 0000000 00000025040 15005672016 030024 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.io.Serializable; import java.time.Instant; import java.util.Date; import java.util.HashMap; import java.util.Locale; import java.util.Map; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.util.Args; /** * Default implementation of {@link SetCookie}. * * @since 4.0 */ public final class BasicClientCookie implements SetCookie, Cloneable, Serializable { private static final long serialVersionUID = -3869795591041535538L; /** * Default Constructor taking a name and a value. The value may be null. * * @param name The name. * @param value The value. */ public BasicClientCookie(final String name, final String value) { super(); Args.notNull(name, "Name"); this.name = name; this.attribs = new HashMap<>(); this.value = value; } /** * Returns the name. * * @return String name The name */ @Override public String getName() { return this.name; } /** * Returns the value. * * @return String value The current value. */ @Override public String getValue() { return this.value; } /** * Sets the value * * @param value */ @Override public void setValue(final String value) { this.value = value; } /** * Returns the expiration {@link Date} of the cookie, or {@code null} * if none exists. *

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

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

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

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

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

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

* When {@code true} the cookie should only be sent * using a secure protocol (https). This should only be set when * the cookie's originating server used a secure protocol to set the * cookie's value. * * @param secure The value of the secure attribute * * @see #isSecure() */ @Override public void setSecure (final boolean secure) { isSecure = secure; } /** * Sets the http-only attribute of the cookie. * * @param httpOnly true if this cookie is to be marked as * {@code httpOnly}, false otherwise * * @since 5.2 */ @Override public void setHttpOnly(final boolean httpOnly) { this.httpOnly = httpOnly; } /** * Returns true if this cookie has expired. * @param date Current time * * @return {@code true} if the cookie has expired. * * @deprecated Use {@link #isExpired(Instant)} */ @Deprecated @Override public boolean isExpired(final Date date) { Args.notNull(date, "Date"); return cookieExpiryDate != null && cookieExpiryDate.compareTo(DateUtils.toInstant(date)) <= 0; } /** * Returns true if this cookie has expired. * @param instant Current time * * @return {@code true} if the cookie has expired. */ @Override public boolean isExpired(final Instant instant) { Args.notNull(instant, "Instant"); return cookieExpiryDate != null && cookieExpiryDate.compareTo(instant) <= 0; } /** * @since 4.4 * * @deprecated Use {@link #getCreationInstant()}. */ @Deprecated @Override public Date getCreationDate() { return DateUtils.toDate(creationDate); } /** * @since 5.2 */ @Override public Instant getCreationInstant() { return creationDate; } /** * @return true if this Cookie has been marked as {@code httpOnly}, false otherwise * @see #setHttpOnly(boolean) * @since 5.2 */ @Override public boolean isHttpOnly() { return httpOnly; } /** * @since 4.4 * @deprecated Use {@link #setCreationDate(Instant)} */ @Deprecated public void setCreationDate(final Date creationDate) { this.creationDate = DateUtils.toInstant(creationDate); } /** * @since 5.2 */ public void setCreationDate(final Instant creationDate) { this.creationDate = creationDate; } public void setAttribute(final String name, final String value) { this.attribs.put(name, value); } @Override public String getAttribute(final String name) { return this.attribs.get(name); } @Override public boolean containsAttribute(final String name) { return this.attribs.containsKey(name); } /** * @since 4.4 */ public boolean removeAttribute(final String name) { return this.attribs.remove(name) != null; } @Override public Object clone() throws CloneNotSupportedException { final BasicClientCookie clone = (BasicClientCookie) super.clone(); clone.attribs = new HashMap<>(this.attribs); return clone; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append("[name: "); buffer.append(this.name); buffer.append("; "); buffer.append("value: "); buffer.append(this.value); buffer.append("; "); buffer.append("domain: "); buffer.append(this.cookieDomain); buffer.append("; "); buffer.append("path: "); buffer.append(this.cookiePath); buffer.append("; "); buffer.append("expiry: "); buffer.append(this.cookieExpiryDate); buffer.append("]"); return buffer.toString(); } // ----------------------------------------------------- Instance Variables /** Cookie name */ private final String name; /** Cookie attributes as specified by the origin server */ private Map attribs; /** Cookie value */ private String value; /** Domain attribute. */ private String cookieDomain; /** Expiration {@link Instant}. */ private Instant cookieExpiryDate; /** Path attribute. */ private String cookiePath; /** My secure flag. */ private boolean isSecure; private Instant creationDate; /** The {@code httpOnly} flag. */ private boolean httpOnly; } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/IgnoreCookieSpecFactory.java0100664 0000000 0000000 00000004453 14704162040 031233 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link CookieSpecFactory} implementation that ignores all cookies. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE) public class IgnoreCookieSpecFactory implements CookieSpecFactory { private volatile CookieSpec cookieSpec; private final ReentrantLock lock; public IgnoreCookieSpecFactory() { super(); this.lock = new ReentrantLock(); } @Override public CookieSpec create(final HttpContext context) { if (cookieSpec == null) { lock.lock(); try { if (cookieSpec == null) { this.cookieSpec = IgnoreSpecSpec.INSTANCE; } } finally { lock.unlock(); } } return this.cookieSpec; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/RFC6265StrictSpec.java0100664 0000000 0000000 00000004441 14666635064 027473 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Standard {@link org.apache.hc.client5.http.cookie.CookieSpec} implementation * that enforces syntax and semantics of the well-behaved profile of the HTTP * state management specification (RFC 6265, section 4). * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE) public class RFC6265StrictSpec extends RFC6265CookieSpecBase { public RFC6265StrictSpec() { super(BasicPathHandler.INSTANCE, BasicDomainHandler.INSTANCE, BasicMaxAgeHandler.INSTANCE, BasicSecureHandler.INSTANCE, BasicHttpOnlyHandler.INSTANCE, new BasicExpiresHandler(DateUtils.STANDARD_PATTERNS)); } RFC6265StrictSpec(final CommonCookieAttributeHandler... handlers) { super(handlers); } @Override public String toString() { return "rfc6265-strict"; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/RFC6265CookieSpecBase.java0100664 0000000 0000000 00000002701 14666635064 030224 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; class RFC6265CookieSpecBase extends RFC6265CookieSpec { RFC6265CookieSpecBase(final CommonCookieAttributeHandler... handlers) { super(handlers); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/RFC6265LaxSpec.java0100664 0000000 0000000 00000004447 14666635064 026755 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Standard {@link org.apache.hc.client5.http.cookie.CookieSpec} implementation that enforces * a more relaxed interpretation of the HTTP state management specification (RFC 6265, section 5) * for interoperability with existing servers that do not conform to the well behaved profile * (RFC 6265, section 4). * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE) public class RFC6265LaxSpec extends RFC6265CookieSpecBase { public RFC6265LaxSpec() { super(BasicPathHandler.INSTANCE, BasicDomainHandler.INSTANCE, LaxMaxAgeHandler.INSTANCE, BasicSecureHandler.INSTANCE, BasicHttpOnlyHandler.INSTANCE, LaxExpiresHandler.INSTANCE); } RFC6265LaxSpec(final CommonCookieAttributeHandler... handlers) { super(handlers); } @Override public String toString() { return "rfc6265-lax"; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/RFC6265CookieSpec.java0100664 0000000 0000000 00000025101 15005672016 027412 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.Instant; import java.util.ArrayList; import java.util.Collections; import java.util.LinkedHashMap; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieAttributeHandler; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookiePriorityComparator; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.FormattedHeader; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.message.BufferedHeader; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.Tokenizer; /** * Cookie management functions shared by RFC 6265 compliant specification. * * @since 4.5 */ @Contract(threading = ThreadingBehavior.SAFE) public class RFC6265CookieSpec implements CookieSpec { private final static char PARAM_DELIMITER = ';'; private final static char COMMA_CHAR = ','; private final static char EQUAL_CHAR = '='; private final static char DQUOTE_CHAR = '"'; private final static char ESCAPE_CHAR = '\\'; // IMPORTANT! // These private static variables must be treated as immutable and never exposed outside this class private static final Tokenizer.Delimiter TOKEN_DELIMS = Tokenizer.delimiters(EQUAL_CHAR, PARAM_DELIMITER); private static final Tokenizer.Delimiter VALUE_DELIMS = Tokenizer.delimiters(PARAM_DELIMITER); private static final Tokenizer.Delimiter SPECIAL_CHARS = Tokenizer.delimiters(' ', DQUOTE_CHAR, COMMA_CHAR, PARAM_DELIMITER, ESCAPE_CHAR); private final CookieAttributeHandler[] attribHandlers; private final Map attribHandlerMap; private final Tokenizer tokenParser; protected RFC6265CookieSpec(final CommonCookieAttributeHandler... handlers) { super(); this.attribHandlers = handlers.clone(); this.attribHandlerMap = new ConcurrentHashMap<>(handlers.length); for (final CommonCookieAttributeHandler handler: handlers) { this.attribHandlerMap.put(handler.getAttributeName().toLowerCase(Locale.ROOT), handler); } this.tokenParser = Tokenizer.INSTANCE; } static String getDefaultPath(final CookieOrigin origin) { String defaultPath = origin.getPath(); int lastSlashIndex = defaultPath.lastIndexOf('/'); if (lastSlashIndex >= 0) { if (lastSlashIndex == 0) { //Do not remove the very first slash lastSlashIndex = 1; } defaultPath = defaultPath.substring(0, lastSlashIndex); } return defaultPath; } static String getDefaultDomain(final CookieOrigin origin) { return origin.getHost(); } @Override public final List parse(final Header header, final CookieOrigin origin) throws MalformedCookieException { Args.notNull(header, "Header"); Args.notNull(origin, "Cookie origin"); if (!header.getName().equalsIgnoreCase("Set-Cookie")) { throw new MalformedCookieException("Unrecognized cookie header: '" + header + "'"); } final CharArrayBuffer buffer; final Tokenizer.Cursor cursor; if (header instanceof FormattedHeader) { buffer = ((FormattedHeader) header).getBuffer(); cursor = new Tokenizer.Cursor(((FormattedHeader) header).getValuePos(), buffer.length()); } else { final String s = header.getValue(); if (s == null) { throw new MalformedCookieException("Header value is null"); } buffer = new CharArrayBuffer(s.length()); buffer.append(s); cursor = new Tokenizer.Cursor(0, buffer.length()); } final String name = tokenParser.parseToken(buffer, cursor, TOKEN_DELIMS); if (name.isEmpty()) { return Collections.emptyList(); } if (cursor.atEnd()) { return Collections.emptyList(); } final int valueDelim = buffer.charAt(cursor.getPos()); cursor.updatePos(cursor.getPos() + 1); if (valueDelim != '=') { throw new MalformedCookieException("Cookie value is invalid: '" + header + "'"); } final String value = tokenParser.parseValue(buffer, cursor, VALUE_DELIMS); if (!cursor.atEnd()) { cursor.updatePos(cursor.getPos() + 1); } final BasicClientCookie cookie = new BasicClientCookie(name, value); cookie.setPath(getDefaultPath(origin)); cookie.setDomain(getDefaultDomain(origin)); cookie.setCreationDate(Instant.now()); final Map attribMap = new LinkedHashMap<>(); while (!cursor.atEnd()) { final String paramName = tokenParser.parseToken(buffer, cursor, TOKEN_DELIMS) .toLowerCase(Locale.ROOT); String paramValue = null; if (!cursor.atEnd()) { final int paramDelim = buffer.charAt(cursor.getPos()); cursor.updatePos(cursor.getPos() + 1); if (paramDelim == EQUAL_CHAR) { paramValue = tokenParser.parseToken(buffer, cursor, VALUE_DELIMS); if (!cursor.atEnd()) { cursor.updatePos(cursor.getPos() + 1); } } } cookie.setAttribute(paramName, paramValue); attribMap.put(paramName, paramValue); } // Ignore 'Expires' if 'Max-Age' is present if (attribMap.containsKey(Cookie.MAX_AGE_ATTR)) { attribMap.remove(Cookie.EXPIRES_ATTR); } for (final Map.Entry entry: attribMap.entrySet()) { final String paramName = entry.getKey(); final String paramValue = entry.getValue(); final CookieAttributeHandler handler = this.attribHandlerMap.get(paramName); if (handler != null) { handler.parse(cookie, paramValue); } } return Collections.singletonList(cookie); } @Override public final void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); for (final CookieAttributeHandler handler: this.attribHandlers) { handler.validate(cookie, origin); } } @Override public final boolean match(final Cookie cookie, final CookieOrigin origin) { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); for (final CookieAttributeHandler handler: this.attribHandlers) { if (!handler.match(cookie, origin)) { return false; } } return true; } @Override public List

formatCookies(final List cookies) { Args.notEmpty(cookies, "List of cookies"); final List sortedCookies; if (cookies.size() > 1) { // Create a mutable copy and sort the copy. sortedCookies = new ArrayList<>(cookies); sortedCookies.sort(CookiePriorityComparator.INSTANCE); } else { sortedCookies = cookies; } final CharArrayBuffer buffer = new CharArrayBuffer(20 * sortedCookies.size()); buffer.append("Cookie"); buffer.append(": "); for (int n = 0; n < sortedCookies.size(); n++) { final Cookie cookie = sortedCookies.get(n); if (n > 0) { buffer.append(PARAM_DELIMITER); buffer.append(' '); } buffer.append(cookie.getName()); final String s = cookie.getValue(); if (s != null) { buffer.append(EQUAL_CHAR); if (containsSpecialChar(s)) { buffer.append(DQUOTE_CHAR); for (int i = 0; i < s.length(); i++) { final char ch = s.charAt(i); if (ch == DQUOTE_CHAR || ch == ESCAPE_CHAR) { buffer.append(ESCAPE_CHAR); } buffer.append(ch); } buffer.append(DQUOTE_CHAR); } else { buffer.append(s); } } } final List
headers = new ArrayList<>(1); try { headers.add(new BufferedHeader(buffer)); } catch (final ParseException ignore) { // should never happen } return headers; } boolean containsSpecialChar(final CharSequence s) { return containsChars(s, SPECIAL_CHARS); } boolean containsChars(final CharSequence s, final Tokenizer.Delimiter chars) { for (int i = 0; i < s.length(); i++) { final char ch = s.charAt(i); if (chars.test(ch)) { return true; } } return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicHttpOnlyHandler.java0100664 0000000 0000000 00000005150 14704162040 030527 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Cookie {@code HttpOnly} attribute handler. * * @since 5.2 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicHttpOnlyHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link BasicHttpOnlyHandler}. * * @since 5.2 */ public static final BasicHttpOnlyHandler INSTANCE = new BasicHttpOnlyHandler(); public BasicHttpOnlyHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); cookie.setHttpOnly(true); } @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { return true; } @Override public String getAttributeName() { return Cookie.HTTP_ONLY_ATTR; } }httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/AbstractCookieSpec.java0100664 0000000 0000000 00000007776 14666635064 030260 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.Collection; import java.util.HashMap; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.CookieAttributeHandler; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Asserts; /** * Abstract cookie specification which can delegate the job of parsing, * validation or matching cookie attributes to a number of arbitrary * {@link CookieAttributeHandler}s. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.SAFE) public abstract class AbstractCookieSpec implements CookieSpec { /** * Stores attribute name -> attribute handler mappings */ private final Map attribHandlerMap; /** * Default constructor * */ public AbstractCookieSpec() { super(); this.attribHandlerMap = new ConcurrentHashMap<>(10); } /** * @since 4.4 */ protected AbstractCookieSpec(final HashMap map) { super(); Asserts.notNull(map, "Attribute handler map"); this.attribHandlerMap = new ConcurrentHashMap<>(map); } /** * @since 4.4 */ protected AbstractCookieSpec(final CommonCookieAttributeHandler... handlers) { super(); this.attribHandlerMap = new ConcurrentHashMap<>(handlers.length); for (final CommonCookieAttributeHandler handler: handlers) { this.attribHandlerMap.put(handler.getAttributeName(), handler); } } /** * Finds an attribute handler {@link CookieAttributeHandler} for the * given attribute. Returns {@code null} if no attribute handler is * found for the specified attribute. * * @param name attribute name. e.g. Domain, Path, etc. * @return an attribute handler or {@code null} */ protected CookieAttributeHandler findAttribHandler(final String name) { return this.attribHandlerMap.get(name); } /** * Gets attribute handler {@link CookieAttributeHandler} for the * given attribute. * * @param name attribute name. e.g. Domain, Path, etc. * @throws IllegalStateException if handler not found for the * specified attribute. */ protected CookieAttributeHandler getAttribHandler(final String name) { final CookieAttributeHandler handler = findAttribHandler(name); Asserts.check(handler != null, "Handler not registered for " + name + " attribute"); return handler; } protected Collection getAttribHandlers() { return this.attribHandlerMap.values(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicExpiresHandler.java0100664 0000000 0000000 00000006722 14666635064 030415 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.Instant; import java.time.format.DateTimeFormatter; import java.time.format.DateTimeFormatterBuilder; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Cookie {@code expires} attribute handler. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicExpiresHandler extends AbstractCookieAttributeHandler implements CommonCookieAttributeHandler { /** Valid date patterns */ private final DateTimeFormatter[] datePatterns; /** * @since 5.2 */ public BasicExpiresHandler(final DateTimeFormatter... datePatterns) { this.datePatterns = datePatterns; } /** * @deprecated Use {@link #BasicExpiresHandler(DateTimeFormatter...)} */ @Deprecated public BasicExpiresHandler(final String[] datePatterns) { Args.notNull(datePatterns, "Array of date patterns"); this.datePatterns = new DateTimeFormatter[datePatterns.length]; for (int i = 0; i < datePatterns.length; i++) { this.datePatterns[i] = new DateTimeFormatterBuilder() .parseLenient() .parseCaseInsensitive() .appendPattern(datePatterns[i]) .toFormatter(); } } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); if (value == null) { throw new MalformedCookieException("Missing value for 'expires' attribute"); } final Instant expiry = DateUtils.parseDate(value, this.datePatterns); if (expiry == null) { throw new MalformedCookieException("Invalid 'expires' attribute: " + value); } cookie.setExpiryDate(expiry); } @Override public String getAttributeName() { return Cookie.EXPIRES_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicDomainHandler.java0100664 0000000 0000000 00000012456 15005672016 030170 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.Locale; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieRestrictionViolationException; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.net.InetAddressUtils; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; /** * Cookie {@code domain} attribute handler. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicDomainHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link BasicDomainHandler}. * * @since 5.2 */ public static final BasicDomainHandler INSTANCE = new BasicDomainHandler(); public BasicDomainHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); if (TextUtils.isBlank(value)) { throw new MalformedCookieException("Blank or null value for domain attribute"); } // Ignore domain attributes ending with '.' per RFC 6265, 4.1.2.3 if (value.endsWith(".")) { return; } String domain = value; if (domain.startsWith(".")) { domain = domain.substring(1); } domain = domain.toLowerCase(Locale.ROOT); cookie.setDomain(domain); } @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); // Validate the cookies domain attribute. NOTE: Domains without // any dots are allowed to support hosts on private LANs that don't // have DNS names. Since they have no dots, to domain-match the // request-host and domain must be identical for the cookie to sent // back to the origin-server. final String host = origin.getHost(); final String domain = cookie.getDomain(); if (domain == null) { throw new CookieRestrictionViolationException("Cookie 'domain' may not be null"); } if (!host.equals(domain) && !domainMatch(domain, host)) { throw new CookieRestrictionViolationException( "Illegal 'domain' attribute \"" + domain + "\". Domain of origin: \"" + host + "\""); } } static boolean domainMatch(final String domain, final String host) { if (InetAddressUtils.isIPv4(host) || InetAddressUtils.isIPv6(host)) { return false; } final String normalizedDomain = domain.startsWith(".") ? domain.substring(1) : domain; if (host.endsWith(normalizedDomain)) { final int prefix = host.length() - normalizedDomain.length(); // Either a full match or a prefix ending with a '.' if (prefix == 0) { return true; } return prefix > 1 && host.charAt(prefix - 1) == '.'; } return false; } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); final String host = origin.getHost(); String domain = cookie.getDomain(); if (domain == null) { return false; } if (domain.startsWith(".")) { domain = domain.substring(1); } domain = domain.toLowerCase(Locale.ROOT); if (host.equals(domain)) { return true; } if (cookie.containsAttribute(Cookie.DOMAIN_ATTR)) { return domainMatch(domain, host); } return false; } @Override public String getAttributeName() { return Cookie.DOMAIN_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/CookieSpecBase.java0100664 0000000 0000000 00000012002 14666635064 027341 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Locale; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieAttributeHandler; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.util.Args; /** * Cookie management functions shared by all specification. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.SAFE) public abstract class CookieSpecBase extends AbstractCookieSpec { public CookieSpecBase() { super(); } /** * @since 4.4 */ protected CookieSpecBase(final HashMap map) { super(map); } /** * @since 4.4 */ protected CookieSpecBase(final CommonCookieAttributeHandler... handlers) { super(handlers); } protected static String getDefaultPath(final CookieOrigin origin) { String defaultPath = origin.getPath(); int lastSlashIndex = defaultPath.lastIndexOf('/'); if (lastSlashIndex >= 0) { if (lastSlashIndex == 0) { //Do not remove the very first slash lastSlashIndex = 1; } defaultPath = defaultPath.substring(0, lastSlashIndex); } return defaultPath; } protected static String getDefaultDomain(final CookieOrigin origin) { return origin.getHost(); } protected List parse(final HeaderElement[] elems, final CookieOrigin origin) throws MalformedCookieException { final List cookies = new ArrayList<>(elems.length); for (final HeaderElement headerelement : elems) { final String name = headerelement.getName(); final String value = headerelement.getValue(); if (name == null || name.isEmpty()) { throw new MalformedCookieException("Cookie name may not be empty"); } final BasicClientCookie cookie = new BasicClientCookie(name, value); cookie.setPath(getDefaultPath(origin)); cookie.setDomain(getDefaultDomain(origin)); // cycle through the parameters final NameValuePair[] attribs = headerelement.getParameters(); for (int j = attribs.length - 1; j >= 0; j--) { final NameValuePair attrib = attribs[j]; final String s = attrib.getName().toLowerCase(Locale.ROOT); cookie.setAttribute(s, attrib.getValue()); final CookieAttributeHandler handler = findAttribHandler(s); if (handler != null) { handler.parse(cookie, attrib.getValue()); } } cookies.add(cookie); } return cookies; } @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); for (final CookieAttributeHandler handler: getAttribHandlers()) { handler.validate(cookie, origin); } } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); for (final CookieAttributeHandler handler: getAttribHandlers()) { if (!handler.match(cookie, origin)) { return false; } } return true; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/RFC6265CookieSpecFactory.java0100664 0000000 0000000 00000013256 14704162040 030746 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.concurrent.locks.ReentrantLock; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * {@link CookieSpecFactory} implementation that provides an instance of * RFC 6265 conformant cookie policy. The instance returned by this factory * can be shared by multiple threads. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.SAFE) public class RFC6265CookieSpecFactory implements CookieSpecFactory { private final ReentrantLock lock; public enum CompatibilityLevel { STRICT, RELAXED, IE_MEDIUM_SECURITY } private final CompatibilityLevel compatibilityLevel; private final PublicSuffixMatcher publicSuffixMatcher; private volatile CookieSpec cookieSpec; public RFC6265CookieSpecFactory( final CompatibilityLevel compatibilityLevel, final PublicSuffixMatcher publicSuffixMatcher) { super(); this.compatibilityLevel = compatibilityLevel != null ? compatibilityLevel : CompatibilityLevel.RELAXED; this.publicSuffixMatcher = publicSuffixMatcher; this.lock = new ReentrantLock(); } public RFC6265CookieSpecFactory(final PublicSuffixMatcher publicSuffixMatcher) { this(CompatibilityLevel.RELAXED, publicSuffixMatcher); } public RFC6265CookieSpecFactory() { this(CompatibilityLevel.RELAXED, null); } @Override public CookieSpec create(final HttpContext context) { if (cookieSpec == null) { lock.lock(); try { if (cookieSpec == null) { switch (this.compatibilityLevel) { case STRICT: this.cookieSpec = new RFC6265StrictSpec( BasicPathHandler.INSTANCE, PublicSuffixDomainFilter.decorate( BasicDomainHandler.INSTANCE, this.publicSuffixMatcher), BasicMaxAgeHandler.INSTANCE, BasicSecureHandler.INSTANCE, BasicHttpOnlyHandler.INSTANCE, new BasicExpiresHandler(DateUtils.STANDARD_PATTERNS)); break; case IE_MEDIUM_SECURITY: this.cookieSpec = new RFC6265LaxSpec( new BasicPathHandler() { @Override public void validate( final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { // No validation } }, PublicSuffixDomainFilter.decorate( BasicDomainHandler.INSTANCE, this.publicSuffixMatcher), BasicMaxAgeHandler.INSTANCE, BasicSecureHandler.INSTANCE, BasicHttpOnlyHandler.INSTANCE, new BasicExpiresHandler(DateUtils.STANDARD_PATTERNS)); break; default: this.cookieSpec = new RFC6265LaxSpec( BasicPathHandler.INSTANCE, PublicSuffixDomainFilter.decorate( BasicDomainHandler.INSTANCE, this.publicSuffixMatcher), LaxMaxAgeHandler.INSTANCE, BasicSecureHandler.INSTANCE, LaxExpiresHandler.INSTANCE); } } } finally { lock.unlock(); } } return this.cookieSpec; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/LaxExpiresHandler.java0100664 0000000 0000000 00000020541 15005672016 030075 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.Instant; import java.time.Month; import java.time.ZoneId; import java.time.ZonedDateTime; import java.util.BitSet; import java.util.Locale; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import java.util.regex.Matcher; import java.util.regex.Pattern; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; import org.apache.hc.core5.util.Tokenizer; /** * Cookie {@code expires} attribute handler conformant to the more relaxed interpretation * of HTTP state management. * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class LaxExpiresHandler extends AbstractCookieAttributeHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link LaxExpiresHandler}. * * @since 5.2 */ public static final LaxExpiresHandler INSTANCE = new LaxExpiresHandler(); private static final BitSet DELIMS; static { final BitSet bitSet = new BitSet(); bitSet.set(0x9); for (int b = 0x20; b <= 0x2f; b++) { bitSet.set(b); } for (int b = 0x3b; b <= 0x40; b++) { bitSet.set(b); } for (int b = 0x5b; b <= 0x60; b++) { bitSet.set(b); } for (int b = 0x7b; b <= 0x7e; b++) { bitSet.set(b); } DELIMS = bitSet; } private static final Map MONTHS; static { final ConcurrentHashMap map = new ConcurrentHashMap<>(12); map.put("jan", Month.JANUARY); map.put("feb", Month.FEBRUARY); map.put("mar", Month.MARCH); map.put("apr", Month.APRIL); map.put("may", Month.MAY); map.put("jun", Month.JUNE); map.put("jul", Month.JULY); map.put("aug", Month.AUGUST); map.put("sep", Month.SEPTEMBER); map.put("oct", Month.OCTOBER); map.put("nov", Month.NOVEMBER); map.put("dec", Month.DECEMBER); MONTHS = map; } private final static Pattern TIME_PATTERN = Pattern.compile( "^([0-9]{1,2}):([0-9]{1,2}):([0-9]{1,2})([^0-9].*)?$"); private final static Pattern DAY_OF_MONTH_PATTERN = Pattern.compile( "^([0-9]{1,2})([^0-9].*)?$"); private final static Pattern MONTH_PATTERN = Pattern.compile( "^(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)(.*)?$", Pattern.CASE_INSENSITIVE); private final static Pattern YEAR_PATTERN = Pattern.compile( "^([0-9]{2,4})([^0-9].*)?$"); public LaxExpiresHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); if (TextUtils.isBlank(value)) { return; } final Tokenizer.Cursor cursor = new Tokenizer.Cursor(0, value.length()); final StringBuilder content = new StringBuilder(); int second = 0, minute = 0, hour = 0, day = 0, year = 0; Month month = Month.JANUARY; boolean foundTime = false, foundDayOfMonth = false, foundMonth = false, foundYear = false; try { while (!cursor.atEnd()) { skipDelims(value, cursor); content.setLength(0); copyContent(value, cursor, content); if (content.length() == 0) { break; } if (!foundTime) { final Matcher matcher = TIME_PATTERN.matcher(content); if (matcher.matches()) { foundTime = true; hour = Integer.parseInt(matcher.group(1)); minute = Integer.parseInt(matcher.group(2)); second = Integer.parseInt(matcher.group(3)); continue; } } if (!foundDayOfMonth) { final Matcher matcher = DAY_OF_MONTH_PATTERN.matcher(content); if (matcher.matches()) { foundDayOfMonth = true; day = Integer.parseInt(matcher.group(1)); continue; } } if (!foundMonth) { final Matcher matcher = MONTH_PATTERN.matcher(content); if (matcher.matches()) { foundMonth = true; month = MONTHS.get(matcher.group(1).toLowerCase(Locale.ROOT)); continue; } } if (!foundYear) { final Matcher matcher = YEAR_PATTERN.matcher(content); if (matcher.matches()) { foundYear = true; year = Integer.parseInt(matcher.group(1)); continue; } } } } catch (final NumberFormatException ignore) { throw new MalformedCookieException("Invalid 'expires' attribute: " + value); } if (!foundTime || !foundDayOfMonth || !foundMonth || !foundYear) { throw new MalformedCookieException("Invalid 'expires' attribute: " + value); } if (year >= 70 && year <= 99) { year = 1900 + year; } if (year >= 0 && year <= 69) { year = 2000 + year; } if (day < 1 || day > 31 || year < 1601 || hour > 23 || minute > 59 || second > 59) { throw new MalformedCookieException("Invalid 'expires' attribute: " + value); } final Instant expiryDate = ZonedDateTime.of(year, month.getValue(), day, hour, minute, second, 0, ZoneId.of("UTC")).toInstant(); cookie.setExpiryDate(expiryDate); } private void skipDelims(final CharSequence buf, final Tokenizer.Cursor cursor) { int pos = cursor.getPos(); final int indexFrom = cursor.getPos(); final int indexTo = cursor.getUpperBound(); for (int i = indexFrom; i < indexTo; i++) { final char current = buf.charAt(i); if (DELIMS.get(current)) { pos++; } else { break; } } cursor.updatePos(pos); } private void copyContent(final CharSequence buf, final Tokenizer.Cursor cursor, final StringBuilder dst) { int pos = cursor.getPos(); final int indexFrom = cursor.getPos(); final int indexTo = cursor.getUpperBound(); for (int i = indexFrom; i < indexTo; i++) { final char current = buf.charAt(i); if (DELIMS.get(current)) { break; } pos++; dst.append(current); } cursor.updatePos(pos); } @Override public String getAttributeName() { return Cookie.EXPIRES_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/IgnoreSpecSpec.java0100664 0000000 0000000 00000004505 14704162040 027362 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.Collections; import java.util.List; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.Header; /** * CookieSpec that ignores all cookies * * @since 4.1 */ @Contract(threading = ThreadingBehavior.STATELESS) public class IgnoreSpecSpec extends CookieSpecBase { /** * Default instance of {@link IgnoreSpecSpec}. * * @since 5.2 */ public static final IgnoreSpecSpec INSTANCE = new IgnoreSpecSpec(); @Override public List parse(final Header header, final CookieOrigin origin) throws MalformedCookieException { return Collections.emptyList(); } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { return false; } @Override public List
formatCookies(final List cookies) { return Collections.emptyList(); } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicSecureHandler.java0100664 0000000 0000000 00000005156 14704162040 030202 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Cookie {@code secure} attribute handler. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicSecureHandler extends AbstractCookieAttributeHandler implements CommonCookieAttributeHandler { /** * Default instance BasicSecureHandler. * * @since 5.2 */ public static final BasicSecureHandler INSTANCE = new BasicSecureHandler(); public BasicSecureHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); cookie.setSecure(true); } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { Args.notNull(cookie, "Cookie"); Args.notNull(origin, "Cookie origin"); return !cookie.isSecure() || origin.isSecure(); } @Override public String getAttributeName() { return Cookie.SECURE_ATTR; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/BasicMaxAgeHandler.java0100664 0000000 0000000 00000005630 14704162040 030113 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.Instant; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; /** * Cookie {@code max-age} attribute handler. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class BasicMaxAgeHandler extends AbstractCookieAttributeHandler implements CommonCookieAttributeHandler { /** * Default instance of {@link BasicMaxAgeHandler}. * * @since 5.2 */ public static final BasicMaxAgeHandler INSTANCE = new BasicMaxAgeHandler(); public BasicMaxAgeHandler() { super(); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { Args.notNull(cookie, "Cookie"); if (value == null) { throw new MalformedCookieException("Missing value for 'max-age' attribute"); } final int age; try { age = Integer.parseInt(value); } catch (final NumberFormatException e) { throw new MalformedCookieException ("Invalid 'max-age' attribute: " + value); } if (age < 0) { throw new MalformedCookieException ("Negative 'max-age' attribute: " + value); } cookie.setExpiryDate(Instant.now().plusSeconds(age)); } @Override public String getAttributeName() { return Cookie.MAX_AGE_ATTR; } } ././@LongLink0100644 0000000 0000000 00000000145 14666635064 011653 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/AbstractCookieAttributeHandler.javahttpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/AbstractCookieAttributeHandler.java0100664 0000000 0000000 00000003776 14666635064 032623 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieAttributeHandler; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public abstract class AbstractCookieAttributeHandler implements CookieAttributeHandler { @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { // Do nothing } @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { // Always match return true; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/cookie/PublicSuffixDomainFilter.java0100664 0000000 0000000 00000013352 15005672035 031417 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.cookie.SetCookie; import org.apache.hc.client5.http.psl.PublicSuffixList; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Wraps a {@link org.apache.hc.client5.http.cookie.CookieAttributeHandler} and leverages * its match method to never match a suffix from a black list. May be used to provide * additional security for cross-site attack types by preventing cookies from apparent * domains that are not publicly available. * * @see PublicSuffixList * @see PublicSuffixMatcher * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class PublicSuffixDomainFilter implements CommonCookieAttributeHandler { private static final Logger LOG = LoggerFactory.getLogger(PublicSuffixDomainFilter.class); private final CommonCookieAttributeHandler handler; private final PublicSuffixMatcher publicSuffixMatcher; private final Map localDomainMap; private static Map createLocalDomainMap() { final ConcurrentHashMap map = new ConcurrentHashMap<>(); map.put(".localhost.", Boolean.TRUE); // RFC 6761 map.put(".test.", Boolean.TRUE); // RFC 6761 map.put(".local.", Boolean.TRUE); // RFC 6762 map.put(".local", Boolean.TRUE); map.put(".localdomain", Boolean.TRUE); return map; } public PublicSuffixDomainFilter( final CommonCookieAttributeHandler handler, final PublicSuffixMatcher publicSuffixMatcher) { this.handler = Args.notNull(handler, "Cookie handler"); this.publicSuffixMatcher = Args.notNull(publicSuffixMatcher, "Public suffix matcher"); this.localDomainMap = createLocalDomainMap(); } public PublicSuffixDomainFilter( final CommonCookieAttributeHandler handler, final PublicSuffixList suffixList) { Args.notNull(handler, "Cookie handler"); Args.notNull(suffixList, "Public suffix list"); this.handler = handler; this.publicSuffixMatcher = new PublicSuffixMatcher(suffixList.getRules(), suffixList.getExceptions()); this.localDomainMap = createLocalDomainMap(); } private boolean verifyHost(final String host) { if (this.publicSuffixMatcher.verify(host)) { return true; } else { if (LOG.isDebugEnabled()) { LOG.debug("Public Suffix List verification failed for host '{}'", host); } return false; } } /** * Never matches if the cookie's domain is from the blacklist. */ @Override public boolean match(final Cookie cookie, final CookieOrigin origin) { final String host = cookie.getDomain(); if (host == null) { return false; } final int i = host.indexOf('.'); if (i >= 0) { final String domain = host.substring(i); if (!this.localDomainMap.containsKey(domain)) { if (!verifyHost(host)) { return false; } } } else { if (!host.equalsIgnoreCase(origin.getHost())) { if (!verifyHost(host)) { return false; } } } return handler.match(cookie, origin); } @Override public void parse(final SetCookie cookie, final String value) throws MalformedCookieException { handler.parse(cookie, value); } @Override public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException { handler.validate(cookie, origin); } @Override public String getAttributeName() { return handler.getAttributeName(); } public static CommonCookieAttributeHandler decorate( final CommonCookieAttributeHandler handler, final PublicSuffixMatcher publicSuffixMatcher) { Args.notNull(handler, "Cookie attribute handler"); return publicSuffixMatcher != null ? new PublicSuffixDomainFilter(handler, publicSuffixMatcher) : handler; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/ChainElement.java0100664 0000000 0000000 00000002614 14666635064 025615 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; /** * Supported elements of request execution pipeline. * * @since 5.0 */ public enum ChainElement { REDIRECT, COMPRESS, BACK_OFF, RETRY, CACHING, PROTOCOL, CONNECT, MAIN_TRANSPORT } httpclient5/src/main/java/org/apache/hc/client5/http/impl/StateHolder.java0100664 0000000 0000000 00000002643 14704162040 025457 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.annotation.Internal; /** * @param The type of object to store and restore. * @since 5.4 */ @Internal public interface StateHolder { T store(); void restore(T state); } httpclient5/src/main/java/org/apache/hc/client5/http/impl/TunnelRefusedException.java0100664 0000000 0000000 00000004712 14704162040 027702 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.message.StatusLine; import org.conscrypt.Internal; /** * Signals that the tunnel request was rejected by the proxy host. * * @since 4.0 * * @deprecated Do not use/ */ @Deprecated public class TunnelRefusedException extends HttpException { private static final long serialVersionUID = -8646722842745617323L; private final HttpResponse response; /** * @deprecated Do not use. */ @Deprecated public TunnelRefusedException(final String message, final String responseMessage) { super(message); this.response = new BasicHttpResponse(500); } @Internal public TunnelRefusedException(final HttpResponse response) { super("CONNECT refused by proxy: " + new StatusLine(response)); this.response = response; } /** * @deprecated Use {@link #getResponse()}. */ @Deprecated public String getResponseMessage() { return "CONNECT refused by proxy: " + new StatusLine(response); } /** * @since 5.4 */ public HttpResponse getResponse() { return response; } } httpclient5/src/main/java/org/apache/hc/client5/http/impl/PrefixedIncrementingId.java0100664 0000000 0000000 00000007110 14666635064 027643 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.concurrent.atomic.AtomicLong; import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.util.Args; /** * A thread safe incrementing identifier. * * @since 5.1.4 */ @Internal public final class PrefixedIncrementingId { private final AtomicLong count = new AtomicLong(0); private final String prefix0; private final String prefix1; private final String prefix2; private final String prefix3; private final String prefix4; private final String prefix5; private final String prefix6; private final String prefix7; private final String prefix8; private final String prefix9; /** * Creates an incrementing identifier. * @param prefix string prefix for generated IDs */ public PrefixedIncrementingId(final String prefix) { this.prefix0 = Args.notNull(prefix, "prefix"); this.prefix1 = prefix0 + '0'; this.prefix2 = prefix1 + '0'; this.prefix3 = prefix2 + '0'; this.prefix4 = prefix3 + '0'; this.prefix5 = prefix4 + '0'; this.prefix6 = prefix5 + '0'; this.prefix7 = prefix6 + '0'; this.prefix8 = prefix7 + '0'; this.prefix9 = prefix8 + '0'; } public long getNextNumber() { return count.incrementAndGet(); } public String getNextId() { return createId(count.incrementAndGet()); } /** * Create an ID from this instance's prefix and zero padded specified value. * * Hand rolled equivalent to `String.format("ex-%010d", value)` optimized to reduce * allocation and CPU overhead. */ String createId(final long value) { final String longString = Long.toString(value); switch (longString.length()) { case 1: return prefix9 + longString; case 2: return prefix8 + longString; case 3: return prefix7 + longString; case 4: return prefix6 + longString; case 5: return prefix5 + longString; case 6: return prefix4 + longString; case 7: return prefix3 + longString; case 8: return prefix2 + longString; case 9: return prefix1 + longString; default: return prefix0 + longString; } } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/0040775 0000000 0000000 00000000000 15005672035 022711 5ustar000000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/cookie/package-info.java0100664 0000000 0000000 00000002372 14666635064 026116 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ /** * Client HTTP state management APIs. */ package org.apache.hc.client5.http.cookie; httpclient5/src/main/java/org/apache/hc/client5/http/cookie/BasicCookieStore.java0100664 0000000 0000000 00000014372 14704162040 026743 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.io.IOException; import java.io.ObjectInputStream; import java.io.Serializable; import java.time.Instant; import java.util.ArrayList; import java.util.Date; import java.util.Iterator; import java.util.List; import java.util.TreeSet; import java.util.concurrent.locks.ReadWriteLock; import java.util.concurrent.locks.ReentrantReadWriteLock; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * Default implementation of {@link CookieStore} * * @since 4.0 */ @Contract(threading = ThreadingBehavior.SAFE) public class BasicCookieStore implements CookieStore, Serializable { private static final long serialVersionUID = -7581093305228232025L; private final TreeSet cookies; private transient ReadWriteLock lock; public BasicCookieStore() { super(); this.cookies = new TreeSet<>(CookieIdentityComparator.INSTANCE); this.lock = new ReentrantReadWriteLock(); } private void readObject(final ObjectInputStream stream) throws IOException, ClassNotFoundException { stream.defaultReadObject(); /* Reinstantiate transient fields. */ this.lock = new ReentrantReadWriteLock(); } /** * Adds an {@link Cookie HTTP cookie}, replacing any existing equivalent cookies. * If the given cookie has already expired it will not be added, but existing * values will still be removed. * * @param cookie the {@link Cookie cookie} to be added * * @see #addCookies(Cookie[]) * */ @Override public void addCookie(final Cookie cookie) { if (cookie != null) { lock.writeLock().lock(); try { // first remove any old cookie that is equivalent cookies.remove(cookie); if (!cookie.isExpired(Instant.now())) { cookies.add(cookie); } } finally { lock.writeLock().unlock(); } } } /** * Adds an array of {@link Cookie HTTP cookies}. Cookies are added individually and * in the given array order. If any of the given cookies has already expired it will * not be added, but existing values will still be removed. * * @param cookies the {@link Cookie cookies} to be added * * @see #addCookie(Cookie) * */ public void addCookies(final Cookie[] cookies) { if (cookies != null) { for (final Cookie cookie : cookies) { this.addCookie(cookie); } } } /** * Returns an immutable array of {@link Cookie cookies} that this HTTP * state currently contains. * * @return an array of {@link Cookie cookies}. */ @Override public List getCookies() { lock.readLock().lock(); try { //create defensive copy so it won't be concurrently modified return new ArrayList<>(cookies); } finally { lock.readLock().unlock(); } } /** * Removes all of {@link Cookie cookies} in this HTTP state * that have expired by the specified {@link Date date}. * * @return true if any cookies were purged. * * @see Cookie#isExpired(Date) */ @Override @SuppressWarnings("deprecation") public boolean clearExpired(final Date date) { if (date == null) { return false; } lock.writeLock().lock(); try { boolean removed = false; for (final Iterator it = cookies.iterator(); it.hasNext(); ) { if (it.next().isExpired(date)) { it.remove(); removed = true; } } return removed; } finally { lock.writeLock().unlock(); } } /** * Removes all of {@link Cookie cookies} in this HTTP state that have expired by the specified * {@link Instant date}. * * @return true if any cookies were purged. * @see Cookie#isExpired(Instant) * @since 5.2 */ @Override public boolean clearExpired(final Instant instant) { if (instant == null) { return false; } lock.writeLock().lock(); try { boolean removed = false; for (final Iterator it = cookies.iterator(); it.hasNext(); ) { if (it.next().isExpired(instant)) { it.remove(); removed = true; } } return removed; } finally { lock.writeLock().unlock(); } } /** * Clears all cookies. */ @Override public void clear() { lock.writeLock().lock(); try { cookies.clear(); } finally { lock.writeLock().unlock(); } } @Override public String toString() { lock.readLock().lock(); try { return cookies.toString(); } finally { lock.readLock().unlock(); } } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieOrigin.java0100664 0000000 0000000 00000005601 14666635064 026151 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.util.Locale; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.TextUtils; /** * CookieOrigin class encapsulates details of an origin server that * are relevant when parsing, validating or matching HTTP cookies. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.IMMUTABLE) public final class CookieOrigin { private final String host; private final int port; private final String path; private final boolean secure; public CookieOrigin(final String host, final int port, final String path, final boolean secure) { super(); Args.notBlank(host, "Host"); Args.notNegative(port, "Port"); Args.notNull(path, "Path"); this.host = host.toLowerCase(Locale.ROOT); this.port = port; if (!TextUtils.isBlank(path)) { this.path = path; } else { this.path = "/"; } this.secure = secure; } public String getHost() { return this.host; } public String getPath() { return this.path; } public int getPort() { return this.port; } public boolean isSecure() { return this.secure; } @Override public String toString() { final StringBuilder buffer = new StringBuilder(); buffer.append('['); if (this.secure) { buffer.append("(secure)"); } buffer.append(this.host); buffer.append(':'); buffer.append(this.port); buffer.append(this.path); buffer.append(']'); return buffer.toString(); } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CommonCookieAttributeHandler.java0100664 0000000 0000000 00000003037 14666635064 031335 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; /** * Extension of {@link org.apache.hc.client5.http.cookie.CookieAttributeHandler} intended * to handle one specific common attribute whose name is returned with * {@link #getAttributeName()} method. * * @since 4.4 */ public interface CommonCookieAttributeHandler extends CookieAttributeHandler { String getAttributeName(); } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieSpecFactory.java0100664 0000000 0000000 00000003246 14666635064 027147 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.protocol.HttpContext; /** * Factory for {@link CookieSpec} implementations. * * @since 4.3 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface CookieSpecFactory { /** * Creates an instance of {@link CookieSpec}. * * @return auth scheme. */ CookieSpec create(HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieSpec.java0100664 0000000 0000000 00000006367 14666635064 025626 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.util.List; import org.apache.hc.core5.http.Header; /** * Defines the cookie management specification. *

Cookie management specification must define *

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

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

* * @see #validate * * @param header the {@code Set-Cookie} received from the server * @param origin details of the cookie origin * @return an array of {@code Cookie}s parsed from the header * @throws MalformedCookieException if an exception occurs during parsing */ List parse(Header header, CookieOrigin origin) throws MalformedCookieException; /** * Validate the cookie according to validation rules defined by the * cookie specification. * * @param cookie the Cookie to validate * @param origin details of the cookie origin * @throws MalformedCookieException if the cookie is invalid */ void validate(Cookie cookie, CookieOrigin origin) throws MalformedCookieException; /** * Determines if a Cookie matches the target location. * * @param cookie the Cookie to be matched * @param origin the target to test against * * @return {@code true} if the cookie should be submitted with a request * with given attributes, {@code false} otherwise. */ boolean match(Cookie cookie, CookieOrigin origin); /** * Create {@code "Cookie"} headers for an array of Cookies. * * @param cookies the Cookies format into a Cookie header * @return a Header for the given Cookies. * @throws IllegalArgumentException if an input parameter is illegal */ List
formatCookies(List cookies); } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieStore.java0100664 0000000 0000000 00000005036 14704162040 025776 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.time.Instant; import java.util.Date; import java.util.List; /** * This interface represents an abstract store for {@link Cookie} * objects. * * @since 4.0 */ public interface CookieStore { /** * Adds an {@link Cookie}, replacing any existing equivalent cookies. * If the given cookie has already expired it will not be added, but existing * values will still be removed. * * @param cookie the {@link Cookie cookie} to be added */ void addCookie(Cookie cookie); /** * Returns all cookies contained in this store. * * @return all cookies */ List getCookies(); /** * Removes all of {@link Cookie}s in this store that have expired by * the specified {@link Date}. * * @return true if any cookies were purged. * @deprecated Use {@link #clearExpired(Instant)} */ @Deprecated boolean clearExpired(Date date); /** * Removes all of {@link Cookie}s in this store that have expired by * the specified {@link Instant}. * * @return true if any cookies were purged. */ @SuppressWarnings("deprecation") default boolean clearExpired(Instant date) { return clearExpired(date != null ? new Date(date.toEpochMilli()) : null); } /** * Clears all cookies. */ void clear(); } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/MalformedCookieException.java0100664 0000000 0000000 00000004512 14666635064 030507 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import org.apache.hc.core5.http.ProtocolException; /** * Signals that a cookie is in some way invalid or illegal in a given * context * * @since 4.0 */ public class MalformedCookieException extends ProtocolException { private static final long serialVersionUID = -6695462944287282185L; /** * Creates a new MalformedCookieException with a {@code null} detail message. */ public MalformedCookieException() { super(); } /** * Creates a new MalformedCookieException with a specified message string. * * @param message The exception detail message */ public MalformedCookieException(final String message) { super(message); } /** * Creates a new MalformedCookieException with the specified detail message and cause. * * @param message the exception detail message * @param cause the {@code Throwable} that caused this exception, or {@code null} * if the cause is unavailable, unknown, or not a {@code Throwable} */ public MalformedCookieException(final String message, final Throwable cause) { super(message, cause); } } ././@LongLink0100644 0000000 0000000 00000000145 14666635064 011653 Lustar 0000000 0000000 httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieRestrictionViolationException.javahttpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieRestrictionViolationException.java0100664 0000000 0000000 00000003646 14666635064 033002 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; /** * Signals that a cookie violates a restriction imposed by the cookie * specification. * * @since 4.1 */ public class CookieRestrictionViolationException extends MalformedCookieException { private static final long serialVersionUID = 7371235577078589013L; /** * Creates a new CookeFormatViolationException with a {@code null} detail * message. */ public CookieRestrictionViolationException() { super(); } /** * Creates a new CookeRestrictionViolationException with a specified * message string. * * @param message The exception detail message */ public CookieRestrictionViolationException(final String message) { super(message); } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookiePriorityComparator.java0100664 0000000 0000000 00000005025 14704162040 030551 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.time.Instant; import java.util.Comparator; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * This cookie comparator ensures that cookies with longer paths take precedence over * cookies with shorter path. Among cookies with equal path length cookies with earlier * creation time take precedence over cookies with later creation time * * @since 4.4 */ @Contract(threading = ThreadingBehavior.STATELESS) public class CookiePriorityComparator implements Comparator { /** * Default instance of {@link CookiePriorityComparator}. */ public static final CookiePriorityComparator INSTANCE = new CookiePriorityComparator(); private int getPathLength(final Cookie cookie) { final String path = cookie.getPath(); return path != null ? path.length() : 1; } @Override public int compare(final Cookie c1, final Cookie c2) { final int l1 = getPathLength(c1); final int l2 = getPathLength(c2); final int result = l2 - l1; if (result == 0) { final Instant d1 = c1.getCreationInstant(); final Instant d2 = c2.getCreationInstant(); if (d1 != null && d2 != null) { return d1.compareTo(d2); } } return result; } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieAttributeHandler.java0100664 0000000 0000000 00000006015 14666635064 030163 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * This interface represents a cookie attribute handler responsible * for parsing, validating, and matching a specific cookie attribute, * such as path, domain, port, etc. *

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

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

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

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

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

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

* When {@code true} the cookie should only be sent * using a secure protocol (https). This should only be set when * the cookie's originating server used a secure protocol to set the * cookie's value. * * @param secure The value of the secure attribute * * @see #isSecure() */ void setSecure (boolean secure); /** * Marks or unmarks this Cookie as {@code httpOnly}. * * @param httpOnly true if this cookie is to be marked as * {@code httpOnly}, false otherwise * * @since 5.2 */ default void setHttpOnly(final boolean httpOnly) { } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/Cookie.java0100664 0000000 0000000 00000012702 15005672035 024764 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.time.Instant; import java.util.Date; /** * Cookie interface represents a token or short packet of state information * (also referred to as "magic-cookie") that the HTTP agent and the target * server can exchange to maintain a session. In its simples form an HTTP * cookie is merely a name / value pair. * * @since 4.0 */ public interface Cookie { String PATH_ATTR = "path"; String DOMAIN_ATTR = "domain"; String MAX_AGE_ATTR = "max-age"; String SECURE_ATTR = "secure"; String EXPIRES_ATTR = "expires"; String HTTP_ONLY_ATTR = "httponly"; /** * @since 5.0 */ String getAttribute(String name); /** * @since 5.0 */ boolean containsAttribute(String name); /** * Returns the name. * * @return String name The name */ String getName(); /** * Returns the value. * * @return String value The current value. */ String getValue(); /** * Returns the expiration {@link Date} of the cookie, or {@code null} * if none exists. *

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

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

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

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

The default implementation returns {@code false}. * * @return true if this Cookie has been marked as {@code httpOnly}, * false otherwise * * @since 5.2 */ default boolean isHttpOnly() { return false; } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookiePathComparator.java0100664 0000000 0000000 00000005523 14704162040 027627 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.io.Serializable; import java.util.Comparator; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * This cookie comparator ensures that multiple cookies satisfying * a common criteria are ordered in the {@link Cookie} header such * that those with more specific Path attributes precede those with * less specific. * *

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

* * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class CookiePathComparator implements Serializable, Comparator { /** * Default instance of {@link CookiePathComparator}. */ public static final CookiePathComparator INSTANCE = new CookiePathComparator(); private static final long serialVersionUID = 7523645369616405818L; private String normalizePath(final Cookie cookie) { String path = cookie.getPath(); if (path == null) { path = "/"; } if (!path.endsWith("/")) { path = path + '/'; } return path; } @Override public int compare(final Cookie c1, final Cookie c2) { final String path1 = normalizePath(c1); final String path2 = normalizePath(c2); if (path1.equals(path2)) { return 0; } else if (path1.startsWith(path2)) { return -1; } else if (path2.startsWith(path1)) { return 1; } else { // Does not really matter return 0; } } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/CookieIdentityComparator.java0100664 0000000 0000000 00000005405 14704162040 030523 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.io.Serializable; import java.util.Comparator; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; /** * This cookie comparator can be used to compare identity of cookies. *

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

* * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public class CookieIdentityComparator implements Serializable, Comparator { /** * Default instance of {@link CookieIdentityComparator}. * * @since 5.2 */ public static final CookieIdentityComparator INSTANCE = new CookieIdentityComparator(); private static final long serialVersionUID = 4466565437490631532L; @Override public int compare(final Cookie c1, final Cookie c2) { int res = c1.getName().compareTo(c2.getName()); if (res == 0) { // do not differentiate empty and null domains String d1 = c1.getDomain(); if (d1 == null) { d1 = ""; } String d2 = c2.getDomain(); if (d2 == null) { d2 = ""; } res = d1.compareToIgnoreCase(d2); } if (res == 0) { String p1 = c1.getPath(); if (p1 == null) { p1 = "/"; } String p2 = c2.getPath(); if (p2 == null) { p2 = "/"; } res = p1.compareTo(p2); } return res; } } httpclient5/src/main/java/org/apache/hc/client5/http/cookie/StandardCookieSpec.java0100664 0000000 0000000 00000003434 14666635064 027277 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; /** * Cookie specifications by their names supported by the HttpClient. * * @since 4.3 */ public final class StandardCookieSpec { private StandardCookieSpec() { // no instances } /** * The RFC 6265 compliant policy (interoperability profile). */ public static final String RELAXED = "relaxed"; /** * The RFC 6265 compliant policy (strict profile). * * @since 4.4 */ public static final String STRICT = "strict"; /** * The policy that ignores cookies. */ public static final String IGNORE = "ignore"; } httpclient5/src/main/java/org/apache/hc/client5/http/ConnectionKeepAliveStrategy.java0100664 0000000 0000000 00000005624 14666635064 027734 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.core5.annotation.Contract; import org.apache.hc.core5.annotation.ThreadingBehavior; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.util.TimeValue; /** * Interface for deciding how long a connection can remain * idle before being reused. *

* Implementations of this interface must be thread-safe. Access to shared * data must be synchronized as methods of this interface may be executed * from multiple threads. * * @since 4.0 */ @Contract(threading = ThreadingBehavior.STATELESS) public interface ConnectionKeepAliveStrategy { /** * Returns the duration of time which this connection can be safely kept * idle. If the connection is left idle for longer than this period of time, * it MUST not reused. A value of 0 or less may be returned to indicate that * there is no suitable suggestion. * * When coupled with a {@link org.apache.hc.core5.http.ConnectionReuseStrategy}, if * {@link org.apache.hc.core5.http.ConnectionReuseStrategy#keepAlive( * org.apache.hc.core5.http.HttpRequest, HttpResponse, HttpContext)} returns true, * this allows you to control how long the reuse will last. If keepAlive returns * false, this should have no meaningful impact * * @param response * The last response received over the connection. * @param context * the context in which the connection is being used. * * @return the duration in ms for which it is safe to keep the connection * idle, or <=0 if no suggested duration. */ TimeValue getKeepAliveDuration(HttpResponse response, HttpContext context); } httpclient5/src/main/java/org/apache/hc/client5/http/HttpHostConnectException.java0100664 0000000 0000000 00000004107 14666635064 027265 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.ConnectException; import org.apache.hc.core5.net.NamedEndpoint; /** * A {@link ConnectException} that specifies the {@link NamedEndpoint} that was being connected to. * * @since 4.0 */ public class HttpHostConnectException extends ConnectException { private static final long serialVersionUID = -3194482710275220224L; private final NamedEndpoint namedEndpoint; /** * Creates a HttpHostConnectException with the specified detail message. */ public HttpHostConnectException(final String message) { super(message); this.namedEndpoint = null; } public HttpHostConnectException(final String message, final NamedEndpoint namedEndpoint) { super(message); this.namedEndpoint = namedEndpoint; } /** * @since 5.0 */ public NamedEndpoint getHost() { return this.namedEndpoint; } } httpclient5/src/main/java/org/apache/hc/client5/http/RouteInfo.java0100664 0000000 0000000 00000012325 15063503632 024215 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.InetAddress; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.net.NamedEndpoint; /** * Connection route information. * * @since 4.0 */ public interface RouteInfo { /** * The tunnelling type of a route. * Plain routes are established by connecting to the target or * the first proxy. * Tunnelled routes are established by connecting to the first proxy * and tunnelling through all proxies to the target. * Routes without a proxy cannot be tunnelled. */ enum TunnelType { PLAIN, TUNNELLED } /** * The layering type of a route. * Plain routes are established by connecting or tunnelling. * Layered routes are established by layering a protocol such as TLS/SSL * over an existing connection. * Protocols can only be layered over a tunnel to the target, or * or over a direct connection without proxies. *

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

*/ enum LayerType { PLAIN, LAYERED } /** * Obtains the target host. * * @return the target host */ HttpHost getTargetHost(); /** * Obtains the target name, if different from the target host, {@code null} otherwise. * * @since 5.4 */ default NamedEndpoint getTargetName() { return null; } /** * Obtains the local address to connect from. * * @return the local address, * or {@code null} */ InetAddress getLocalAddress(); /** * Obtains the number of hops in this route. * A direct route has one hop. A route through a proxy has two hops. * A route through a chain of n proxies has n+1 hops. * * @return the number of hops in this route */ int getHopCount(); /** * Obtains the target of a hop in this route. * The target of the last hop is the {@link #getTargetHost target host}, * the target of previous hops is the respective proxy in the chain. * For a route through exactly one proxy, target of hop 0 is the proxy * and target of hop 1 is the target host. * * @param hop index of the hop for which to get the target, * 0 for first * * @return the target of the given hop * * @throws IllegalArgumentException * if the argument is negative or not less than * {@link #getHopCount getHopCount()} */ HttpHost getHopTarget(int hop); /** * Obtains the first proxy host. * * @return the first proxy in the proxy chain, or * {@code null} if this route is direct */ HttpHost getProxyHost(); /** * Obtains the tunnel type of this route. * If there is a proxy chain, only end-to-end tunnels are considered. * * @return the tunnelling type */ TunnelType getTunnelType(); /** * Checks whether this route is tunnelled through a proxy. * If there is a proxy chain, only end-to-end tunnels are considered. * * @return {@code true} if tunnelled end-to-end through at least * one proxy, * {@code false} otherwise */ boolean isTunnelled(); /** * Obtains the layering type of this route. * In the presence of proxies, only layering over an end-to-end tunnel * is considered. * * @return the layering type */ LayerType getLayerType(); /** * Checks whether this route includes a layered protocol. * In the presence of proxies, only layering over an end-to-end tunnel * is considered. * * @return {@code true} if layered, * {@code false} otherwise */ boolean isLayered(); /** * Checks whether this route is secure. * * @return {@code true} if secure, * {@code false} otherwise */ boolean isSecure(); } httpclient5/src/main/java/org/apache/hc/client5/http/ContextBuilder.java0100664 0000000 0000000 00000007330 14704162040 025231 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.client5.http.auth.AuthCache; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.config.Lookup; /** * {@link HttpClientContext} builder. * * @since 5.2 */ public class ContextBuilder extends AbstractClientContextBuilder { protected ContextBuilder(final SchemePortResolver schemePortResolver) { super(schemePortResolver); } public static ContextBuilder create(final SchemePortResolver schemePortResolver) { return new ContextBuilder(schemePortResolver); } public static ContextBuilder create() { return new ContextBuilder(DefaultSchemePortResolver.INSTANCE); } @Override public ContextBuilder useCookieSpecRegistry(final Lookup cookieSpecRegistry) { super.useCookieSpecRegistry(cookieSpecRegistry); return this; } @Override public ContextBuilder useAuthSchemeRegistry(final Lookup authSchemeRegistry) { super.useAuthSchemeRegistry(authSchemeRegistry); return this; } @Override public ContextBuilder useCookieStore(final CookieStore cookieStore) { super.useCookieStore(cookieStore); return this; } @Override public ContextBuilder useCredentialsProvider(final CredentialsProvider credentialsProvider) { super.useCredentialsProvider(credentialsProvider); return this; } @Override public ContextBuilder useAuthCache(final AuthCache authCache) { super.useAuthCache(authCache); return this; } @Override public ContextBuilder preemptiveAuth(final HttpHost host, final AuthScheme authScheme) { super.preemptiveAuth(host, authScheme); return this; } @Override public ContextBuilder preemptiveBasicAuth(final HttpHost host, final UsernamePasswordCredentials credentials) { super.preemptiveBasicAuth(host, credentials); return this; } @Override protected HttpClientContext createContext() { return HttpClientContext.create(); } } httpclient5/src/test/0040775 0000000 0000000 00000000000 14666635064 013643 5ustar000000000 0000000 httpclient5/src/test/resources/0040775 0000000 0000000 00000000000 15005672035 015640 5ustar000000000 0000000 httpclient5/src/test/resources/log4j2-debug.xml.template0100664 0000000 0000000 00000002567 14666635064 022405 0ustar000000000 0000000 httpclient5/src/test/resources/log4j2.xml0100664 0000000 0000000 00000002210 14666635064 017470 0ustar000000000 0000000 httpclient5/src/test/resources/suffixlistmatcher.txt0100664 0000000 0000000 00000003315 15005672035 022144 0ustar000000000 0000000 // ==================================================================== // Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. // ==================================================================== // // This software consists of voluntary contributions made by many // individuals on behalf of the Apache Software Foundation. For more // information on the Apache Software Foundation, please see // . // // ===BEGIN PRIVATE DOMAINS=== xx lan appspot.com s3.amazonaws.com *.s3.amazonaws.com s3.eu-central-1.amazonaws.com *.compute.amazonaws.com *.compute-1.amazonaws.com *.compute.amazonaws.com.cn us-east-1.amazonaws.com *.xxx.uk // ===END PRIVATE DOMAINS=== // ===BEGIN ICANN DOMAINS=== com *.foo.com *.jp *.hokkaido.jp *.tokyo.jp !pref.hokkaido.jp !metro.tokyo.jp // Hosts in .hokkaido.jp can't set cookies below level 4... // ...except hosts in pref.hokkaido.jp, which can set cookies at level 3. co.jp gov.uk // unicode no hå.no // ===END ICANN DOMAINS=== httpclient5/src/test/resources/suffixlist.txt0100664 0000000 0000000 00000002327 14666635064 020617 0ustar000000000 0000000 // ==================================================================== // Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. // ==================================================================== // // This software consists of voluntary contributions made by many // individuals on behalf of the Apache Software Foundation. For more // information on the Apache Software Foundation, please see // . // xx jp ac.jp *.tokyo.jp !metro.tokyo.jp // unicode no hå.no httpclient5/src/test/resources/suffixlist2.txt0100664 0000000 0000000 00000002524 14666635064 020700 0ustar000000000 0000000 // ==================================================================== // Licensed to the Apache Software Foundation (ASF) under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you under the Apache License, Version 2.0 (the // "License"); you may not use this file except in compliance // with the License. You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, // software distributed under the License is distributed on an // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. // ==================================================================== // // This software consists of voluntary contributions made by many // individuals on behalf of the Apache Software Foundation. For more // information on the Apache Software Foundation, please see // . // // ===BEGIN ICANN DOMAINS=== jp ac.jp *.tokyo.jp !metro.tokyo.jp // ===END ICANN DOMAINS=== // ===BEGIN PRIVATE DOMAINS=== googleapis.com googlecode.com // ===END PRIVATE DOMAINS=== httpclient5/src/test/resources/commons-logging.properties0100664 0000000 0000000 00000002350 14666635064 023067 0ustar000000000 0000000 # ==================================================================== # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # ==================================================================== # # This software consists of voluntary contributions made by many # individuals on behalf of the Apache Software Foundation. For more # information on the Apache Software Foundation, please see # . # Disable logging for unit tests org.apache.commons.logging.Log=org.apache.commons.logging.impl.NoOpLog httpclient5/src/test/java/0040775 0000000 0000000 00000000000 14666635064 014564 5ustar000000000 0000000 httpclient5/src/test/java/org/0040775 0000000 0000000 00000000000 14666635064 015353 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/0040775 0000000 0000000 00000000000 14666635064 016574 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/0040775 0000000 0000000 00000000000 14666635064 017166 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/0040775 0000000 0000000 00000000000 14666635064 020531 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/0040775 0000000 0000000 00000000000 15063503632 021473 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/SystemDefaultDnsResolverTest.java0100664 0000000 0000000 00000004502 14704162040 030147 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import static org.junit.jupiter.api.Assertions.assertArrayEquals; import static org.junit.jupiter.api.Assertions.assertEquals; import java.net.InetAddress; import java.net.UnknownHostException; import org.junit.jupiter.api.Test; class SystemDefaultDnsResolverTest { @Test void resolve() throws UnknownHostException { final SystemDefaultDnsResolver resolver = SystemDefaultDnsResolver.INSTANCE; final InetAddress[] result1 = resolver.resolve("127.0.0.1"); assertEquals(1, result1.length); assertArrayEquals(new byte[]{127, 0, 0, 1}, result1[0].getAddress()); } @Test void resolveIPv6ZoneId() throws UnknownHostException { final SystemDefaultDnsResolver resolver = SystemDefaultDnsResolver.INSTANCE; // This is an IPv6 address literal with zone ID final InetAddress[] result = resolver.resolve("[fe80::221:b7ff:fe8a:57d5%en4]"); assertEquals(1, result.length); assertArrayEquals(new byte[]{(byte) 0xfe, (byte) 0x80, 0, 0, 0, 0, 0, 0, 0x02, 0x21, (byte) 0xb7, (byte) 0xff, (byte) 0xfe, (byte) 0x8a, 0x57, (byte) 0xd5}, result[0].getAddress()); } } httpclient5/src/test/java/org/apache/hc/client5/http/config/0040775 0000000 0000000 00000000000 14704162040 022733 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/config/TestRequestConfig.java0100664 0000000 0000000 00000010127 14704162040 027212 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.config; import java.util.Collections; import java.util.concurrent.TimeUnit; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.cookie.StandardCookieSpec; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestRequestConfig { @Test void testBasics() { final RequestConfig config = RequestConfig.custom().build(); config.toString(); } @Test void testDefaults() { final RequestConfig config = RequestConfig.DEFAULT; Assertions.assertEquals(Timeout.ofMinutes(3), config.getConnectionRequestTimeout()); Assertions.assertFalse(config.isExpectContinueEnabled()); Assertions.assertTrue(config.isAuthenticationEnabled()); Assertions.assertTrue(config.isRedirectsEnabled()); Assertions.assertFalse(config.isCircularRedirectsAllowed()); Assertions.assertEquals(50, config.getMaxRedirects()); Assertions.assertNull(config.getCookieSpec()); Assertions.assertNull(config.getTargetPreferredAuthSchemes()); Assertions.assertNull(config.getProxyPreferredAuthSchemes()); Assertions.assertTrue(config.isContentCompressionEnabled()); } @Test void testBuildAndCopy() { final RequestConfig config0 = RequestConfig.custom() .setConnectionRequestTimeout(44, TimeUnit.MILLISECONDS) .setExpectContinueEnabled(true) .setAuthenticationEnabled(false) .setRedirectsEnabled(false) .setCircularRedirectsAllowed(true) .setMaxRedirects(100) .setCookieSpec(StandardCookieSpec.STRICT) .setTargetPreferredAuthSchemes(Collections.singletonList(StandardAuthScheme.BEARER)) .setProxyPreferredAuthSchemes(Collections.singletonList(StandardAuthScheme.DIGEST)) .setContentCompressionEnabled(false) .build(); final RequestConfig config = RequestConfig.copy(config0).build(); Assertions.assertEquals(TimeValue.ofMilliseconds(44), config.getConnectionRequestTimeout()); Assertions.assertTrue(config.isExpectContinueEnabled()); Assertions.assertFalse(config.isAuthenticationEnabled()); Assertions.assertFalse(config.isRedirectsEnabled()); Assertions.assertTrue(config.isCircularRedirectsAllowed()); Assertions.assertEquals(100, config.getMaxRedirects()); Assertions.assertEquals(StandardCookieSpec.STRICT, config.getCookieSpec()); Assertions.assertEquals(Collections.singletonList(StandardAuthScheme.BEARER), config.getTargetPreferredAuthSchemes()); Assertions.assertEquals(Collections.singletonList(StandardAuthScheme.DIGEST), config.getProxyPreferredAuthSchemes()); Assertions.assertFalse(config.isContentCompressionEnabled()); } } httpclient5/src/test/java/org/apache/hc/client5/http/auth/0040775 0000000 0000000 00000000000 15005672016 022433 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/auth/TestCredentials.java0100664 0000000 0000000 00000025160 15005672016 026374 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; @SuppressWarnings("deprecation") class TestCredentials { @Test void testUsernamePasswordCredentialsBasics() { final UsernamePasswordCredentials creds1 = new UsernamePasswordCredentials( "name","pwd".toCharArray()); Assertions.assertEquals("name", creds1.getUserName()); Assertions.assertEquals(new BasicUserPrincipal("name"), creds1.getUserPrincipal()); Assertions.assertArrayEquals("pwd".toCharArray(), creds1.getUserPassword()); Assertions.assertEquals("[principal: name]", creds1.toString()); final UsernamePasswordCredentials creds2 = new UsernamePasswordCredentials( "name", null); Assertions.assertEquals("name", creds2.getUserName()); Assertions.assertEquals(new BasicUserPrincipal("name"), creds2.getUserPrincipal()); Assertions.assertNull(creds2.getUserPassword()); Assertions.assertEquals("[principal: name]", creds2.toString()); } @Test void testNTCredentialsBasics() { final NTCredentials creds1 = new NTCredentials( "name","pwd".toCharArray(), "localhost", "domain"); Assertions.assertEquals("name", creds1.getUserName()); Assertions.assertEquals(new NTUserPrincipal("DOMAIN", "name"), creds1.getUserPrincipal()); Assertions.assertArrayEquals("pwd".toCharArray(), creds1.getPassword()); Assertions.assertEquals("[principal: DOMAIN\\name][workstation: " + creds1.getWorkstation() + "][netbiosDomain: DOMAIN]", creds1.toString()); final NTCredentials creds2 = new NTCredentials( "name", null, null, null); Assertions.assertEquals("name", creds2.getUserName()); Assertions.assertEquals(new NTUserPrincipal(null, "name"), creds2.getUserPrincipal()); Assertions.assertNull(creds2.getPassword()); Assertions.assertEquals("[principal: name][workstation: " + creds1.getWorkstation() + "][netbiosDomain: null]", creds2.toString()); } @Test void testUsernamePasswordCredentialsHashCode() { final UsernamePasswordCredentials creds1 = new UsernamePasswordCredentials( "name","pwd".toCharArray()); final UsernamePasswordCredentials creds2 = new UsernamePasswordCredentials( "othername","pwd".toCharArray()); final UsernamePasswordCredentials creds3 = new UsernamePasswordCredentials( "name", "otherpwd".toCharArray()); Assertions.assertTrue(creds1.hashCode() == creds1.hashCode()); Assertions.assertTrue(creds1.hashCode() != creds2.hashCode()); Assertions.assertTrue(creds1.hashCode() == creds3.hashCode()); } @Test void testUsernamePasswordCredentialsEquals() { final UsernamePasswordCredentials creds1 = new UsernamePasswordCredentials( "name","pwd".toCharArray()); final UsernamePasswordCredentials creds2 = new UsernamePasswordCredentials( "othername","pwd".toCharArray()); final UsernamePasswordCredentials creds3 = new UsernamePasswordCredentials( "name", "otherpwd".toCharArray()); Assertions.assertEquals(creds1, creds1); Assertions.assertNotEquals(creds1, creds2); Assertions.assertEquals(creds1, creds3); } @Test void tesBearerTokenBasics() { final BearerToken creds1 = new BearerToken("token of some sort"); Assertions.assertEquals("token of some sort", creds1.getToken()); } @Test void testBearerTokenHashCode() { final BearerToken creds1 = new BearerToken("token of some sort"); final BearerToken creds2 = new BearerToken("another token of some sort"); final BearerToken creds3 = new BearerToken("token of some sort"); Assertions.assertTrue(creds1.hashCode() == creds1.hashCode()); Assertions.assertTrue(creds1.hashCode() != creds2.hashCode()); Assertions.assertTrue(creds1.hashCode() == creds3.hashCode()); } @Test void testBearerTokenEquals() { final BearerToken creds1 = new BearerToken("token of some sort"); final BearerToken creds2 = new BearerToken("another token of some sort"); final BearerToken creds3 = new BearerToken("token of some sort"); Assertions.assertEquals(creds1, creds1); Assertions.assertNotEquals(creds1, creds2); Assertions.assertEquals(creds1, creds3); } @Test void testNTCredentialsHashCode() { final NTCredentials creds1 = new NTCredentials( "name","pwd".toCharArray(), "somehost", "domain"); final NTCredentials creds2 = new NTCredentials( "othername","pwd".toCharArray(), "somehost", "domain"); final NTCredentials creds3 = new NTCredentials( "name", "otherpwd".toCharArray(), "SomeHost", "Domain"); final NTCredentials creds4 = new NTCredentials( "name","pwd".toCharArray(), "otherhost", "domain"); final NTCredentials creds5 = new NTCredentials( "name","pwd".toCharArray(), null, "domain"); final NTCredentials creds6 = new NTCredentials( "name","pwd".toCharArray(), "somehost", "ms"); final NTCredentials creds7 = new NTCredentials( "name","pwd".toCharArray(), "somehost", null); final NTCredentials creds8 = new NTCredentials( "name","pwd".toCharArray(), null, "domain"); final NTCredentials creds9 = new NTCredentials( "name","pwd".toCharArray(), "somehost", null); Assertions.assertTrue(creds1.hashCode() == creds1.hashCode()); Assertions.assertTrue(creds1.hashCode() != creds2.hashCode()); Assertions.assertEquals(creds1.hashCode(), creds3.hashCode()); Assertions.assertEquals(creds1.hashCode(), creds4.hashCode()); Assertions.assertEquals(creds1.hashCode(), creds5.hashCode()); Assertions.assertNotEquals(creds1.hashCode(), creds6.hashCode()); Assertions.assertNotEquals(creds1.hashCode(), creds7.hashCode()); Assertions.assertEquals(creds8.hashCode(), creds5.hashCode()); Assertions.assertEquals(creds9.hashCode(), creds7.hashCode()); } @Test void testNTCredentialsEquals() { final NTCredentials creds1 = new NTCredentials( "name","pwd".toCharArray(), "somehost", "domain"); final NTCredentials creds2 = new NTCredentials( "othername","pwd".toCharArray(), "somehost", "domain"); final NTCredentials creds3 = new NTCredentials( "name", "otherpwd".toCharArray(), "SomeHost", "Domain"); final NTCredentials creds4 = new NTCredentials( "name","pwd".toCharArray(), "otherhost", "domain"); final NTCredentials creds5 = new NTCredentials( "name","pwd".toCharArray(), null, "domain"); final NTCredentials creds6 = new NTCredentials( "name","pwd".toCharArray(), "somehost", "ms"); final NTCredentials creds7 = new NTCredentials( "name","pwd".toCharArray(), "somehost", null); final NTCredentials creds8 = new NTCredentials( "name","pwd".toCharArray(), null, "domain"); final NTCredentials creds9 = new NTCredentials( "name","pwd".toCharArray(), "somehost", null); Assertions.assertEquals(creds1, creds1); Assertions.assertNotEquals(creds1, creds2); Assertions.assertEquals(creds1, creds3); Assertions.assertEquals(creds1, creds4); Assertions.assertEquals(creds1, creds5); Assertions.assertNotEquals(creds1, creds6); Assertions.assertNotEquals(creds1, creds7); Assertions.assertEquals(creds8, creds5); Assertions.assertEquals(creds9, creds7); } @Test void testUsernamePasswordCredentialsSerialization() throws Exception { final UsernamePasswordCredentials orig = new UsernamePasswordCredentials("name","pwd".toCharArray()); final ByteArrayOutputStream outbuffer = new ByteArrayOutputStream(); final ObjectOutputStream outStream = new ObjectOutputStream(outbuffer); outStream.writeObject(orig); outStream.close(); final byte[] raw = outbuffer.toByteArray(); final ByteArrayInputStream inBuffer = new ByteArrayInputStream(raw); final ObjectInputStream inStream = new ObjectInputStream(inBuffer); final UsernamePasswordCredentials clone = (UsernamePasswordCredentials) inStream.readObject(); Assertions.assertEquals(orig, clone); } @Test void testNTCredentialsSerialization() throws Exception { final NTCredentials orig = new NTCredentials("name","pwd".toCharArray(), "somehost", "domain"); final ByteArrayOutputStream outbuffer = new ByteArrayOutputStream(); final ObjectOutputStream outStream = new ObjectOutputStream(outbuffer); outStream.writeObject(orig); outStream.close(); final byte[] raw = outbuffer.toByteArray(); final ByteArrayInputStream inBuffer = new ByteArrayInputStream(raw); final ObjectInputStream inStream = new ObjectInputStream(inBuffer); final NTCredentials clone = (NTCredentials) inStream.readObject(); Assertions.assertEquals(orig, clone); } } httpclient5/src/test/java/org/apache/hc/client5/http/auth/TestAuthScope.java0100664 0000000 0000000 00000020067 14704162040 026027 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import org.apache.hc.core5.http.HttpHost; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Tests for {@link org.apache.hc.client5.http.auth.AuthScope}. */ class TestAuthScope { @Test void testBasics() { final AuthScope authscope = new AuthScope("http", "somehost", 80, "somerealm", "SomeScheme"); Assertions.assertEquals("SOMESCHEME", authscope.getSchemeName()); Assertions.assertEquals("http", authscope.getProtocol()); Assertions.assertEquals("somehost", authscope.getHost()); Assertions.assertEquals(80, authscope.getPort()); Assertions.assertEquals("somerealm", authscope.getRealm()); Assertions.assertEquals("SOMESCHEME 'somerealm' http://somehost:80", authscope.toString()); } @Test void testByOrigin() { final HttpHost host = new HttpHost("http", "somehost", 8080); final AuthScope authscope = new AuthScope(host); Assertions.assertNull(authscope.getSchemeName()); Assertions.assertEquals("somehost", authscope.getHost()); Assertions.assertEquals(8080, authscope.getPort()); Assertions.assertNull(authscope.getRealm()); Assertions.assertEquals("http", authscope.getProtocol()); Assertions.assertEquals(" http://somehost:8080", authscope.toString()); } @Test void testMixedCaseHostname() { final AuthScope authscope = new AuthScope("SomeHost", 80); Assertions.assertNull(authscope.getSchemeName()); Assertions.assertEquals("somehost", authscope.getHost()); Assertions.assertEquals(80, authscope.getPort()); Assertions.assertNull(authscope.getRealm()); Assertions.assertEquals(" ://somehost:80", authscope.toString()); } @Test void testByOriginMixedCaseHostname() { final HttpHost host = new HttpHost("http", "SomeHost", 8080); final AuthScope authscope = new AuthScope(host); Assertions.assertEquals("somehost", authscope.getHost()); } @Test void testBasicsAllOptional() { final AuthScope authscope = new AuthScope(null, null, -1, null, null); Assertions.assertNull(authscope.getSchemeName()); Assertions.assertNull(authscope.getHost()); Assertions.assertEquals(-1, authscope.getPort()); Assertions.assertNull(authscope.getRealm()); Assertions.assertEquals(" ://:", authscope.toString()); } @Test void testScopeMatching() { final AuthScope authscope1 = new AuthScope("http", "somehost", 80, "somerealm", "somescheme"); final AuthScope authscope2 = new AuthScope("http", "someotherhost", 80, "somerealm", "somescheme"); Assertions.assertTrue(authscope1.match(authscope2) < 0); int m1 = authscope1.match(new AuthScope(null, null, -1, null, "somescheme")); int m2 = authscope1.match(new AuthScope(null, null, -1, "somerealm", null)); Assertions.assertTrue(m2 > m1); m1 = authscope1.match(new AuthScope(null, null, -1, null, "somescheme")); m2 = authscope1.match(new AuthScope(null, null, -1, "somerealm", null)); Assertions.assertTrue(m2 > m1); m1 = authscope1.match(new AuthScope(null, null, -1, "somerealm", "somescheme")); m2 = authscope1.match(new AuthScope(null, null, 80, null, null)); Assertions.assertTrue(m2 > m1); m1 = authscope1.match(new AuthScope(null, null, 80, "somerealm", "somescheme")); m2 = authscope1.match(new AuthScope(null, "somehost", -1, null, null)); Assertions.assertTrue(m2 > m1); m1 = authscope1.match(new AuthScope(null, null, 80, "somerealm", "somescheme")); m2 = authscope1.match(new AuthScope(null, "somehost", -1, null, null)); Assertions.assertTrue(m2 > m1); m1 = authscope1.match(new AuthScope(null, null, -1, null, null)); m2 = authscope1.match(new AuthScope(null, null, -1, null, "somescheme")); Assertions.assertTrue(m2 > m1); } @Test void testEquals() { final AuthScope authscope1 = new AuthScope("http", "somehost", 80, "somerealm", "somescheme"); final AuthScope authscope2 = new AuthScope("http", "someotherhost", 80, "somerealm", "somescheme"); final AuthScope authscope3 = new AuthScope("http", "somehost", 80, "somerealm", "somescheme"); final AuthScope authscope4 = new AuthScope("http", "somehost", 8080, "somerealm", "somescheme"); final AuthScope authscope5 = new AuthScope("http", "somehost", 80, "someotherrealm", "somescheme"); final AuthScope authscope6 = new AuthScope("http", "somehost", 80, "somerealm", "someotherscheme"); final AuthScope authscope7 = new AuthScope("https", "somehost", 80, "somerealm", "somescheme"); final AuthScope authscope8 = new AuthScope("https", "somehost", 80, "somerealm", "SomeScheme"); Assertions.assertEquals(authscope1, authscope1); Assertions.assertNotEquals(authscope1, authscope2); Assertions.assertEquals(authscope1, authscope3); Assertions.assertNotEquals(authscope1, authscope4); Assertions.assertNotEquals(authscope1, authscope5); Assertions.assertNotEquals(authscope1, authscope6); Assertions.assertNotEquals(authscope1, authscope7); Assertions.assertEquals(authscope7, authscope8); } @Test void testHash() { final AuthScope authscope1 = new AuthScope("http", "somehost", 80, "somerealm", "somescheme"); final AuthScope authscope2 = new AuthScope("http", "someotherhost", 80, "somerealm", "somescheme"); final AuthScope authscope3 = new AuthScope("http", "somehost", 80, "somerealm", "somescheme"); final AuthScope authscope4 = new AuthScope("http", "somehost", 8080, "somerealm", "somescheme"); final AuthScope authscope5 = new AuthScope("http", "somehost", 80, "someotherrealm", "somescheme"); final AuthScope authscope6 = new AuthScope("http", "somehost", 80, "somerealm", "someotherscheme"); final AuthScope authscope7 = new AuthScope("https", "somehost", 80, "somerealm", "somescheme"); final AuthScope authscope8 = new AuthScope("https", "somehost", 80, "somerealm", "SomeScheme"); Assertions.assertEquals(authscope1.hashCode(), authscope1.hashCode()); Assertions.assertNotEquals(authscope1.hashCode(), authscope2.hashCode()); Assertions.assertEquals(authscope1.hashCode(), authscope3.hashCode()); Assertions.assertNotEquals(authscope1.hashCode(), authscope4.hashCode()); Assertions.assertNotEquals(authscope1.hashCode(), authscope5.hashCode()); Assertions.assertNotEquals(authscope1.hashCode(), authscope6.hashCode()); Assertions.assertNotEquals(authscope1.hashCode(), authscope7.hashCode()); Assertions.assertEquals(authscope7.hashCode(), authscope8.hashCode()); } } httpclient5/src/test/java/org/apache/hc/client5/http/auth/TestAuthChallenge.java0100664 0000000 0000000 00000004726 14704162040 026644 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.auth; import java.util.Arrays; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestAuthChallenge { @Test void testAuthChallengeWithValue() { final AuthChallenge authChallenge = new AuthChallenge(ChallengeType.TARGET, StandardAuthScheme.BASIC, "blah", null); Assertions.assertEquals(StandardAuthScheme.BASIC, authChallenge.getSchemeName()); Assertions.assertEquals("blah", authChallenge.getValue()); Assertions.assertNull(authChallenge.getParams()); Assertions.assertEquals(StandardAuthScheme.BASIC + " blah", authChallenge.toString()); } @Test void testAuthChallengeWithParams() { final AuthChallenge authChallenge = new AuthChallenge(ChallengeType.TARGET, StandardAuthScheme.BASIC, null, Arrays.asList(new BasicNameValuePair("blah", "this"), new BasicNameValuePair("blah", "that"))); Assertions.assertEquals(StandardAuthScheme.BASIC, authChallenge.getSchemeName()); Assertions.assertNull(authChallenge.getValue()); Assertions.assertNotNull(authChallenge.getParams()); Assertions.assertEquals(StandardAuthScheme.BASIC + " [blah=this, blah=that]", authChallenge.toString()); } } httpclient5/src/test/java/org/apache/hc/client5/http/ContentTypeMatcher.java0100664 0000000 0000000 00000004216 14666635064 026133 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import org.apache.hc.core5.http.ContentType; import org.hamcrest.BaseMatcher; import org.hamcrest.Description; import org.hamcrest.Matcher; public class ContentTypeMatcher extends BaseMatcher { private final ContentType expectedContentType; public ContentTypeMatcher(final ContentType contentType) { this.expectedContentType = contentType; } @Override public boolean matches(final Object item) { if (item instanceof ContentType) { final ContentType contentType = (ContentType) item; return contentType.isSameMimeType(expectedContentType); } return false; } @Override public void describeTo(final Description description) { description.appendText("same MIME type as ").appendValue(expectedContentType); } public static Matcher sameMimeType(final ContentType contentType) { return new ContentTypeMatcher(contentType); } } httpclient5/src/test/java/org/apache/hc/client5/http/classic/0040775 0000000 0000000 00000000000 14666635064 023131 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/classic/methods/0040775 0000000 0000000 00000000000 14704162040 024552 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/classic/methods/TestHttpRequestBase.java0100664 0000000 0000000 00000015313 14704162040 031340 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import static org.junit.jupiter.api.Assertions.assertAll; 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 java.net.URI; import java.util.HashSet; import java.util.Set; import java.util.stream.Collectors; import java.util.stream.Stream; import org.apache.hc.client5.http.entity.EntityBuilder; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestHttpRequestBase { private static final String HOT_URL = "http://host/path"; @Test void testBasicGetMethodProperties() throws Exception { final HttpGet httpget = new HttpGet(HOT_URL); Assertions.assertEquals("GET", httpget.getMethod()); Assertions.assertEquals(new URI(HOT_URL), httpget.getUri()); } @Test void testBasicHttpPostMethodProperties() throws Exception { final HttpPost HttpPost = new HttpPost(HOT_URL); Assertions.assertEquals("POST", HttpPost.getMethod()); Assertions.assertEquals(new URI(HOT_URL), HttpPost.getUri()); } @Test void testBasicHttpHeadMethodProperties() throws Exception { final HttpHead httpHead = new HttpHead(HOT_URL); Assertions.assertEquals("HEAD", httpHead.getMethod()); Assertions.assertEquals(new URI(HOT_URL), httpHead.getUri()); } @Test void testBasicHttpOptionMethodProperties() throws Exception { final HttpOptions httpOption = new HttpOptions(HOT_URL); Assertions.assertEquals("OPTIONS", httpOption.getMethod()); Assertions.assertEquals(new URI(HOT_URL), httpOption.getUri()); } @Test void testBasicHttpPatchMethodProperties() throws Exception { final HttpPatch httpPatch = new HttpPatch(HOT_URL); Assertions.assertEquals("PATCH", httpPatch.getMethod()); Assertions.assertEquals(new URI(HOT_URL), httpPatch.getUri()); } @Test void testBasicHttpPutMethodProperties() throws Exception { final HttpPut httpPut = new HttpPut(HOT_URL); Assertions.assertEquals("PUT", httpPut.getMethod()); Assertions.assertEquals(new URI(HOT_URL), httpPut.getUri()); } @Test void testBasicHttpTraceMethodProperties() throws Exception { final HttpTrace httpTrace = new HttpTrace(HOT_URL); Assertions.assertEquals("TRACE", httpTrace.getMethod()); Assertions.assertEquals(new URI(HOT_URL), httpTrace.getUri()); } @Test void testBasicHttpDeleteMethodProperties() throws Exception { final HttpDelete httpDelete = new HttpDelete(HOT_URL); Assertions.assertEquals("DELETE", httpDelete.getMethod()); Assertions.assertEquals(new URI(HOT_URL), httpDelete.getUri()); } @Test void testGetMethodEmptyURI() throws Exception { final HttpGet httpget = new HttpGet(""); Assertions.assertEquals(new URI("/"), httpget.getUri()); } @Test void testPostMethodEmptyURI() throws Exception { final HttpPost HttpPost = new HttpPost(""); Assertions.assertEquals(new URI("/"), HttpPost.getUri()); } @Test void testHeadMethodEmptyURI() throws Exception { final HttpHead httpHead = new HttpHead(""); Assertions.assertEquals(new URI("/"), httpHead.getUri()); } @Test void testOptionMethodEmptyURI() throws Exception { final HttpOptions httpOption = new HttpOptions(""); Assertions.assertEquals(new URI("/"), httpOption.getUri()); } @Test void testPatchMethodEmptyURI() throws Exception { final HttpPatch httpPatch = new HttpPatch(""); Assertions.assertEquals(new URI("/"), httpPatch.getUri()); } @Test void testPutMethodEmptyURI() throws Exception { final HttpPut httpPut = new HttpPut(""); Assertions.assertEquals(new URI("/"), httpPut.getUri()); } @Test void testTraceMethodEmptyURI() throws Exception { final HttpTrace httpTrace = new HttpTrace(""); Assertions.assertEquals(new URI("/"), httpTrace.getUri()); } @Test void testDeleteMethodEmptyURI() throws Exception { final HttpDelete httpDelete = new HttpDelete(""); Assertions.assertEquals(new URI("/"), httpDelete.getUri()); } @Test void testTraceMethodSetEntity() { final HttpTrace httpTrace = new HttpTrace(HOT_URL); final HttpEntity entity = EntityBuilder.create().setText("stuff").build(); assertThrows(IllegalStateException.class, () -> httpTrace.setEntity(entity)); } @Test void testOptionMethodGetAllowedMethods() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); response.addHeader("Allow", "GET, HEAD"); response.addHeader("Allow", "DELETE"); response.addHeader("Content-Length", "128"); final HttpOptions httpOptions = new HttpOptions(""); final Set methods = httpOptions.getAllowedMethods(response); assertAll("Must all pass", () -> assertFalse(methods.isEmpty()), () -> assertEquals(3, methods.size()), () -> assertTrue(methods.containsAll(Stream.of("HEAD", "DELETE", "GET") .collect(Collectors.toCollection(HashSet::new)))) ); } } httpclient5/src/test/java/org/apache/hc/client5/http/classic/methods/TestHttpTrace.java0100664 0000000 0000000 00000003030 14704162040 030144 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestHttpTrace { @Test void testHttpTraceSetEntity() { final HttpTrace httpTrace = new HttpTrace("/path"); Assertions.assertThrows(IllegalStateException.class, () -> httpTrace.setEntity(null)); } } httpclient5/src/test/java/org/apache/hc/client5/http/classic/methods/TestHttpOptions.java0100664 0000000 0000000 00000003532 14704162040 030550 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.classic.methods; import java.util.Set; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestHttpOptions { @Test void testMultipleAllows() { final BasicHttpResponse resp = new BasicHttpResponse(200, "test reason"); resp.addHeader("Allow", "POST"); resp.addHeader("Allow", "GET"); final HttpOptions opt = new HttpOptions("*"); final Set methodsName = opt.getAllowedMethods(resp); Assertions.assertTrue(methodsName.contains("POST")); Assertions.assertTrue(methodsName.contains("GET")); } } httpclient5/src/test/java/org/apache/hc/client5/http/async/0040775 0000000 0000000 00000000000 14666635064 022625 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/async/methods/0040775 0000000 0000000 00000000000 15063503632 024253 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/async/methods/TestSimpleMessageBuilders.java0100664 0000000 0000000 00000034232 14704162040 032202 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.async.methods; import static org.hamcrest.MatcherAssert.assertThat; import java.net.URI; import java.nio.charset.StandardCharsets; import java.util.Arrays; import org.apache.hc.client5.http.ContentTypeMatcher; import org.apache.hc.client5.http.HeaderMatcher; import org.apache.hc.client5.http.HeadersMatcher; import org.apache.hc.client5.http.NameValuePairsMatcher; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.net.URIAuthority; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Simple tests for {@link SimpleResponseBuilder} and {@link SimpleRequestBuilder}. */ class TestSimpleMessageBuilders { @Test void testResponseBasics() { final SimpleResponseBuilder builder = SimpleResponseBuilder.create(200); Assertions.assertEquals(200, builder.getStatus()); Assertions.assertNull(builder.getHeaders()); Assertions.assertNull(builder.getVersion()); final SimpleHttpResponse r1 = builder.build(); Assertions.assertNotNull(r1); Assertions.assertEquals(200, r1.getCode()); Assertions.assertNull(r1.getVersion()); builder.setStatus(500); builder.setVersion(HttpVersion.HTTP_1_0); Assertions.assertEquals(500, builder.getStatus()); Assertions.assertEquals(HttpVersion.HTTP_1_0, builder.getVersion()); final SimpleHttpResponse r2 = builder.build(); Assertions.assertEquals(500, r2.getCode()); Assertions.assertEquals(HttpVersion.HTTP_1_0, r2.getVersion()); builder.addHeader("h1", "v1"); builder.addHeader("h1", "v2"); builder.addHeader("h2", "v2"); assertThat(builder.getHeaders(), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h1", "v2"), new BasicHeader("h2", "v2"))); assertThat(builder.getHeaders("h1"), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h1", "v2"))); assertThat(builder.getFirstHeader("h1"), HeaderMatcher.same("h1", "v1")); assertThat(builder.getLastHeader("h1"), HeaderMatcher.same("h1", "v2")); final SimpleHttpResponse r3 = builder.build(); assertThat(r3.getHeaders(), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h1", "v2"), new BasicHeader("h2", "v2"))); assertThat(r3.getHeaders("h1"), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h1", "v2"))); assertThat(r3.getFirstHeader("h1"), HeaderMatcher.same("h1", "v1")); assertThat(r3.getLastHeader("h1"), HeaderMatcher.same("h1", "v2")); builder.removeHeader(new BasicHeader("h1", "v2")); assertThat(builder.getHeaders("h1"), HeadersMatcher.same(new BasicHeader("h1", "v1"))); assertThat(builder.getHeaders(), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h2", "v2"))); final SimpleHttpResponse r4 = builder.build(); assertThat(r4.getHeaders("h1"), HeadersMatcher.same(new BasicHeader("h1", "v1"))); assertThat(r4.getHeaders(), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h2", "v2"))); builder.removeHeaders("h1"); assertThat(builder.getHeaders("h1"), HeadersMatcher.same()); assertThat(builder.getHeaders(), HeadersMatcher.same(new BasicHeader("h2", "v2"))); final SimpleHttpResponse r5 = builder.build(); assertThat(r5.getHeaders("h1"), HeadersMatcher.same()); assertThat(r5.getHeaders(), HeadersMatcher.same(new BasicHeader("h2", "v2"))); } @Test void testRequestBasics() throws Exception { final SimpleRequestBuilder builder = SimpleRequestBuilder.get(); Assertions.assertEquals(URI.create("/"), builder.getUri()); Assertions.assertEquals("GET", builder.getMethod()); Assertions.assertNull(builder.getScheme()); Assertions.assertNull(builder.getAuthority()); Assertions.assertNull(builder.getPath()); Assertions.assertNull(builder.getHeaders()); Assertions.assertNull(builder.getVersion()); Assertions.assertNull(builder.getCharset()); Assertions.assertNull(builder.getParameters()); final SimpleHttpRequest r1 = builder.build(); Assertions.assertNotNull(r1); Assertions.assertEquals("GET", r1.getMethod()); Assertions.assertNull(r1.getScheme()); Assertions.assertNull(r1.getAuthority()); Assertions.assertNull(r1.getPath()); Assertions.assertEquals(URI.create("/"), r1.getUri()); Assertions.assertNull(r1.getVersion()); builder.setUri(URI.create("http://host:1234/blah?param=value")); builder.setVersion(HttpVersion.HTTP_1_1); Assertions.assertEquals("http", builder.getScheme()); Assertions.assertEquals(new URIAuthority("host", 1234), builder.getAuthority()); Assertions.assertEquals("/blah?param=value", builder.getPath()); Assertions.assertEquals(URI.create("http://host:1234/blah?param=value"), builder.getUri()); Assertions.assertEquals(HttpVersion.HTTP_1_1, builder.getVersion()); final SimpleHttpRequest r2 = builder.build(); Assertions.assertEquals("GET", r2.getMethod()); Assertions.assertEquals("http", r2.getScheme()); Assertions.assertEquals(new URIAuthority("host", 1234), r2.getAuthority()); Assertions.assertEquals("/blah?param=value", r2.getPath()); Assertions.assertEquals(URI.create("http://host:1234/blah?param=value"), r2.getUri()); Assertions.assertEquals(HttpVersion.HTTP_1_1, builder.getVersion()); builder.setCharset(StandardCharsets.US_ASCII); builder.addParameter("param1", "value1"); builder.addParameter("param2", null); builder.addParameters(new BasicNameValuePair("param3", "value3"), new BasicNameValuePair("param4", null)); Assertions.assertEquals(builder.getParameters(), Arrays.asList( new BasicNameValuePair("param1", "value1"), new BasicNameValuePair("param2", null), new BasicNameValuePair("param3", "value3"), new BasicNameValuePair("param4", null) )); Assertions.assertEquals(URI.create("http://host:1234/blah?param=value"), builder.getUri()); final SimpleHttpRequest r3 = builder.build(); Assertions.assertEquals("GET", r3.getMethod()); Assertions.assertEquals("http", r3.getScheme()); Assertions.assertEquals(new URIAuthority("host", 1234), r3.getAuthority()); Assertions.assertEquals("/blah?param=value¶m1=value1¶m2¶m3=value3¶m4", r3.getPath()); Assertions.assertEquals(URI.create("http://host:1234/blah?param=value¶m1=value1¶m2¶m3=value3¶m4"), r3.getUri()); builder.addHeader("h1", "v1"); builder.addHeader("h1", "v2"); builder.addHeader("h2", "v2"); assertThat(builder.getHeaders(), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h1", "v2"), new BasicHeader("h2", "v2"))); assertThat(builder.getHeaders("h1"), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h1", "v2"))); assertThat(builder.getFirstHeader("h1"), HeaderMatcher.same("h1", "v1")); assertThat(builder.getLastHeader("h1"), HeaderMatcher.same("h1", "v2")); final SimpleHttpRequest r4 = builder.build(); assertThat(r4.getHeaders(), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h1", "v2"), new BasicHeader("h2", "v2"))); assertThat(r4.getHeaders("h1"), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h1", "v2"))); assertThat(r4.getFirstHeader("h1"), HeaderMatcher.same("h1", "v1")); assertThat(r4.getLastHeader("h1"), HeaderMatcher.same("h1", "v2")); builder.removeHeader(new BasicHeader("h1", "v2")); assertThat(builder.getHeaders("h1"), HeadersMatcher.same(new BasicHeader("h1", "v1"))); assertThat(builder.getHeaders(), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h2", "v2"))); final SimpleHttpRequest r5 = builder.build(); assertThat(r5.getHeaders("h1"), HeadersMatcher.same(new BasicHeader("h1", "v1"))); assertThat(r5.getHeaders(), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h2", "v2"))); builder.removeHeaders("h1"); assertThat(builder.getHeaders("h1"), HeadersMatcher.same()); assertThat(builder.getHeaders(), HeadersMatcher.same(new BasicHeader("h2", "v2"))); final SimpleHttpRequest r6 = builder.build(); assertThat(r6.getHeaders("h1"), HeadersMatcher.same()); assertThat(r6.getHeaders(), HeadersMatcher.same(new BasicHeader("h2", "v2"))); } @Test void testResponseCopy() { final SimpleHttpResponse response = SimpleHttpResponse.create(400); response.addHeader("h1", "v1"); response.addHeader("h1", "v2"); response.addHeader("h2", "v2"); response.setVersion(HttpVersion.HTTP_2); final SimpleResponseBuilder builder = SimpleResponseBuilder.copy(response); Assertions.assertEquals(400, builder.getStatus()); Assertions.assertEquals(HttpVersion.HTTP_2, builder.getVersion()); assertThat(builder.getHeaders(), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h1", "v2"), new BasicHeader("h2", "v2"))); } @Test void testRequestCopy() { final SimpleHttpRequest request = SimpleHttpRequest.create(Method.GET, URI.create("https://host:3456/stuff?blah")) ; request.addHeader("h1", "v1"); request.addHeader("h1", "v2"); request.addHeader("h2", "v2"); request.setVersion(HttpVersion.HTTP_2); final SimpleRequestBuilder builder = SimpleRequestBuilder.copy(request); Assertions.assertEquals("GET", builder.getMethod()); Assertions.assertEquals("https", builder.getScheme()); Assertions.assertEquals(new URIAuthority("host", 3456), builder.getAuthority()); Assertions.assertEquals("/stuff?blah", builder.getPath()); Assertions.assertEquals(HttpVersion.HTTP_2, builder.getVersion()); assertThat(builder.getHeaders(), HeadersMatcher.same( new BasicHeader("h1", "v1"), new BasicHeader("h1", "v2"), new BasicHeader("h2", "v2"))); } @Test void testGetParameters() { final SimpleRequestBuilder builder = SimpleRequestBuilder.get(URI.create("https://host:3456/stuff?p0=p0")); builder.addParameter("p1", "v1"); builder.addParameters(new BasicNameValuePair("p2", "v2"), new BasicNameValuePair("p3", "v3")); builder.addParameter(new BasicNameValuePair("p3", "v3.1")); Assertions.assertEquals("GET", builder.getMethod()); Assertions.assertEquals("https", builder.getScheme()); Assertions.assertEquals(new URIAuthority("host", 3456), builder.getAuthority()); Assertions.assertEquals("/stuff?p0=p0", builder.getPath()); assertThat(builder.getParameters(), NameValuePairsMatcher.same( new BasicNameValuePair("p1", "v1"), new BasicNameValuePair("p2", "v2"), new BasicNameValuePair("p3", "v3"), new BasicNameValuePair("p3", "v3.1"))); final SimpleHttpRequest request = builder.build(); assertThat(request.getPath(), CoreMatchers.equalTo("/stuff?p0=p0&p1=v1&p2=v2&p3=v3&p3=v3.1")); Assertions.assertNull(request.getBody()); } @Test void testPostParameters() { final SimpleRequestBuilder builder = SimpleRequestBuilder.post(URI.create("https://host:3456/stuff?p0=p0")); builder.addParameter("p1", "v1"); builder.addParameters(new BasicNameValuePair("p2", "v2"), new BasicNameValuePair("p3", "v3")); builder.addParameter(new BasicNameValuePair("p3", "v3.1")); Assertions.assertEquals("POST", builder.getMethod()); Assertions.assertEquals("https", builder.getScheme()); Assertions.assertEquals(new URIAuthority("host", 3456), builder.getAuthority()); Assertions.assertEquals("/stuff?p0=p0", builder.getPath()); assertThat(builder.getParameters(), NameValuePairsMatcher.same( new BasicNameValuePair("p1", "v1"), new BasicNameValuePair("p2", "v2"), new BasicNameValuePair("p3", "v3"), new BasicNameValuePair("p3", "v3.1"))); final SimpleHttpRequest request = builder.build(); assertThat(request.getPath(), CoreMatchers.equalTo("/stuff?p0=p0")); Assertions.assertNotNull(request.getBody()); assertThat(request.getBody().getContentType(), ContentTypeMatcher.sameMimeType(ContentType.APPLICATION_FORM_URLENCODED)); assertThat(request.getBody().getBodyText(), CoreMatchers.equalTo("p1=v1&p2=v2&p3=v3&p3=v3.1")); } } httpclient5/src/test/java/org/apache/hc/client5/http/utils/0040775 0000000 0000000 00000000000 14704162040 022626 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/utils/TestDnsUtils.java0100664 0000000 0000000 00000004044 14704162040 026075 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.utils; import static org.hamcrest.MatcherAssert.assertThat; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Test; /** * Unit tests for DnsUtils. */ class TestDnsUtils { @Test void testNormalize() { assertThat(DnsUtils.normalize(null), CoreMatchers.equalTo(null)); assertThat(DnsUtils.normalize(""), CoreMatchers.equalTo("")); assertThat(DnsUtils.normalize("blah"), CoreMatchers.equalTo("blah")); assertThat(DnsUtils.normalize("BLAH"), CoreMatchers.equalTo("blah")); assertThat(DnsUtils.normalize("blAh"), CoreMatchers.equalTo("blah")); assertThat(DnsUtils.normalize("blaH"), CoreMatchers.equalTo("blah")); assertThat(DnsUtils.normalize("blaH"), CoreMatchers.equalTo("blah")); assertThat(DnsUtils.normalize("hac\u212A!!!"), CoreMatchers.equalTo("hac\u212A!!!")); } } httpclient5/src/test/java/org/apache/hc/client5/http/utils/TestByteArrayBuilder.java0100664 0000000 0000000 00000014432 14704162040 027543 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.utils; import java.nio.ByteBuffer; import java.nio.charset.StandardCharsets; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * {@link ByteArrayBuilder} test cases. */ class TestByteArrayBuilder { @Test void testEmptyBuffer() { final ByteArrayBuilder buffer = new ByteArrayBuilder(); final ByteBuffer byteBuffer = buffer.toByteBuffer(); Assertions.assertNotNull(byteBuffer); Assertions.assertEquals(0, byteBuffer.capacity()); final byte[] bytes = buffer.toByteArray(); Assertions.assertNotNull(bytes); Assertions.assertEquals(0, bytes.length); } @Test void testAppendBytes() { final ByteArrayBuilder buffer = new ByteArrayBuilder(); buffer.append(new byte[]{1, 2, 3, 4, 5}); buffer.append(new byte[]{3, 4, 5, 6, 7, 8, 9, 10, 11}, 3, 5); buffer.append((byte[]) null); final byte[] bytes = buffer.toByteArray(); Assertions.assertNotNull(bytes); Assertions.assertArrayEquals(new byte[]{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}, bytes); } @Test void testInvalidAppendBytes() { final ByteArrayBuilder buffer = new ByteArrayBuilder(); buffer.append((byte[])null, 0, 0); final byte[] tmp = new byte[] { 1, 2, 3, 4}; Assertions.assertThrows(IndexOutOfBoundsException.class, () -> buffer.append(tmp, -1, 0)); Assertions.assertThrows(IndexOutOfBoundsException.class, () -> buffer.append(tmp, 0, -1)); Assertions.assertThrows(IndexOutOfBoundsException.class, () -> buffer.append(tmp, 0, 8)); Assertions.assertThrows(IndexOutOfBoundsException.class, () -> buffer.append(tmp, 10, Integer.MAX_VALUE)); Assertions.assertThrows(IndexOutOfBoundsException.class, () -> buffer.append(tmp, 2, 4)); } @Test void testEnsureCapacity() { final ByteArrayBuilder buffer = new ByteArrayBuilder(); buffer.ensureFreeCapacity(10); Assertions.assertEquals(10, buffer.capacity()); buffer.ensureFreeCapacity(5); Assertions.assertEquals(10, buffer.capacity()); buffer.append(new byte[]{1, 2, 3, 4, 5, 6, 7, 8}); buffer.ensureFreeCapacity(5); Assertions.assertEquals(13, buffer.capacity()); buffer.ensureFreeCapacity(15); Assertions.assertEquals(23, buffer.capacity()); } @Test void testAppendText() { final ByteArrayBuilder buffer = new ByteArrayBuilder(); buffer.append(new char[]{'1', '2', '3', '4', '5'}); buffer.append(new char[]{'3', '4', '5', '6', '7', '8', '9', 'a', 'b'}, 3, 5); buffer.append("bcd"); buffer.append("e"); buffer.append("f"); buffer.append(""); buffer.append((String) null); buffer.append((char[]) null); final byte[] bytes = buffer.toByteArray(); Assertions.assertNotNull(bytes); Assertions.assertEquals("123456789abcdef", new String(bytes, StandardCharsets.US_ASCII)); } @Test void testInvalidAppendChars() { final ByteArrayBuilder buffer = new ByteArrayBuilder(); buffer.append((char[])null, 0, 0); final char[] tmp = new char[] { 1, 2, 3, 4}; Assertions.assertThrows(IndexOutOfBoundsException.class, () -> buffer.append(tmp, -1, 0)); Assertions.assertThrows(IndexOutOfBoundsException.class, () -> buffer.append(tmp, 0, -1)); Assertions.assertThrows(IndexOutOfBoundsException.class, () -> buffer.append(tmp, 0, 8)); Assertions.assertThrows(IndexOutOfBoundsException.class, () -> buffer.append(tmp, 10, Integer.MAX_VALUE)); Assertions.assertThrows(IndexOutOfBoundsException.class, () -> buffer.append(tmp, 2, 4)); } @Test void testReset() { final ByteArrayBuilder buffer = new ByteArrayBuilder(); buffer.append("abcd"); buffer.append("e"); buffer.append("f"); final byte[] bytes1 = buffer.toByteArray(); Assertions.assertNotNull(bytes1); Assertions.assertEquals("abcdef", new String(bytes1, StandardCharsets.US_ASCII)); buffer.reset(); final byte[] bytes2 = buffer.toByteArray(); Assertions.assertNotNull(bytes2); Assertions.assertEquals("", new String(bytes2, StandardCharsets.US_ASCII)); } @Test void testNonAsciiCharset() { final int[] germanChars = { 0xE4, 0x2D, 0xF6, 0x2D, 0xFc }; final StringBuilder tmp = new StringBuilder(); for (final int germanChar : germanChars) { tmp.append((char) germanChar); } final String umlauts = tmp.toString(); final ByteArrayBuilder buffer = new ByteArrayBuilder(); buffer.append(umlauts); final byte[] bytes1 = buffer.toByteArray(); Assertions.assertNotNull(bytes1); Assertions.assertEquals("?-?-?", new String(bytes1, StandardCharsets.US_ASCII)); buffer.reset(); buffer.charset(StandardCharsets.UTF_8); buffer.append(umlauts); final byte[] bytes2 = buffer.toByteArray(); Assertions.assertNotNull(bytes2); Assertions.assertEquals(umlauts, new String(bytes2, StandardCharsets.UTF_8)); } } httpclient5/src/test/java/org/apache/hc/client5/http/utils/TestURIUtils.java0100664 0000000 0000000 00000031661 14704162040 026015 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.utils; import java.net.URI; import java.util.Arrays; import java.util.Collections; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.net.URIBuilder; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * This TestCase contains test methods for URI resolving according to RFC 3986. * The examples are listed in section "5.4 Reference Resolution Examples" */ class TestURIUtils { private final URI baseURI = URI.create("http://a/b/c/d;p?q"); @Test void testResolve() { Assertions.assertEquals("g:h", URIUtils.resolve(this.baseURI, "g:h").toString()); Assertions.assertEquals("http://a/b/c/g", URIUtils.resolve(this.baseURI, "g").toString()); Assertions.assertEquals("http://a/b/c/g", URIUtils.resolve(this.baseURI, "./g").toString()); Assertions.assertEquals("http://a/b/c/g/", URIUtils.resolve(this.baseURI, "g/").toString()); Assertions.assertEquals("http://a/g", URIUtils.resolve(this.baseURI, "/g").toString()); Assertions.assertEquals("http://g/", URIUtils.resolve(this.baseURI, "//g").toString()); Assertions.assertEquals("http://a/b/c/d;p?y", URIUtils.resolve(this.baseURI, "?y").toString()); Assertions.assertEquals("http://a/b/c/d;p?y#f", URIUtils.resolve(this.baseURI, "?y#f") .toString()); Assertions.assertEquals("http://a/b/c/g?y", URIUtils.resolve(this.baseURI, "g?y").toString()); Assertions.assertEquals("http://a/b/c/d;p?q#s", URIUtils.resolve(this.baseURI, "#s") .toString()); Assertions.assertEquals("http://a/b/c/g#s", URIUtils.resolve(this.baseURI, "g#s").toString()); Assertions.assertEquals("http://a/b/c/g?y#s", URIUtils.resolve(this.baseURI, "g?y#s") .toString()); Assertions.assertEquals("http://a/b/c/;x", URIUtils.resolve(this.baseURI, ";x").toString()); Assertions.assertEquals("http://a/b/c/g;x", URIUtils.resolve(this.baseURI, "g;x").toString()); Assertions.assertEquals("http://a/b/c/g;x?y#s", URIUtils.resolve(this.baseURI, "g;x?y#s") .toString()); Assertions.assertEquals("http://a/b/c/d;p?q", URIUtils.resolve(this.baseURI, "").toString()); Assertions.assertEquals("http://a/b/c/", URIUtils.resolve(this.baseURI, ".").toString()); Assertions.assertEquals("http://a/b/c/", URIUtils.resolve(this.baseURI, "./").toString()); Assertions.assertEquals("http://a/b/", URIUtils.resolve(this.baseURI, "..").toString()); Assertions.assertEquals("http://a/b/", URIUtils.resolve(this.baseURI, "../").toString()); Assertions.assertEquals("http://a/b/g", URIUtils.resolve(this.baseURI, "../g").toString()); Assertions.assertEquals("http://a/", URIUtils.resolve(this.baseURI, "../..").toString()); Assertions.assertEquals("http://a/", URIUtils.resolve(this.baseURI, "../../").toString()); Assertions.assertEquals("http://a/g", URIUtils.resolve(this.baseURI, "../../g").toString()); Assertions.assertEquals("http://a/../g", URIUtils.resolve(this.baseURI, "../../../g").toString()); Assertions.assertEquals("http://a/../../g", URIUtils.resolve(this.baseURI, "../../../../g") .toString()); Assertions.assertEquals("http://a/./g", URIUtils.resolve(this.baseURI, "/./g").toString()); Assertions.assertEquals("http://a/../g", URIUtils.resolve(this.baseURI, "/../g").toString()); Assertions.assertEquals("http://a/b/c/g.", URIUtils.resolve(this.baseURI, "g.").toString()); Assertions.assertEquals("http://a/b/c/.g", URIUtils.resolve(this.baseURI, ".g").toString()); Assertions.assertEquals("http://a/b/c/g..", URIUtils.resolve(this.baseURI, "g..").toString()); Assertions.assertEquals("http://a/b/c/..g", URIUtils.resolve(this.baseURI, "..g").toString()); Assertions.assertEquals("http://a/b/g", URIUtils.resolve(this.baseURI, "./../g").toString()); Assertions.assertEquals("http://a/b/c/g/", URIUtils.resolve(this.baseURI, "./g/.").toString()); Assertions.assertEquals("http://a/b/c/g/h", URIUtils.resolve(this.baseURI, "g/./h").toString()); Assertions.assertEquals("http://a/b/c/h", URIUtils.resolve(this.baseURI, "g/../h").toString()); Assertions.assertEquals("http://a/b/c/g;x=1/y", URIUtils.resolve(this.baseURI, "g;x=1/./y") .toString()); Assertions.assertEquals("http://a/b/c/y", URIUtils.resolve(this.baseURI, "g;x=1/../y") .toString()); Assertions.assertEquals("http://a/b/c/g?y/./x", URIUtils.resolve(this.baseURI, "g?y/./x") .toString()); Assertions.assertEquals("http://a/b/c/g?y/../x", URIUtils.resolve(this.baseURI, "g?y/../x") .toString()); Assertions.assertEquals("http://a/b/c/g#s/./x", URIUtils.resolve(this.baseURI, "g#s/./x") .toString()); Assertions.assertEquals("http://a/b/c/g#s/../x", URIUtils.resolve(this.baseURI, "g#s/../x") .toString()); Assertions.assertEquals("http:g", URIUtils.resolve(this.baseURI, "http:g").toString()); // examples from section 5.2.4 Assertions.assertEquals("http://s/a/b/c/./../../g", URIUtils.resolve(this.baseURI, "http://s/a/b/c/./../../g").toString()); Assertions.assertEquals("http://s/mid/content=5/../6", URIUtils.resolve(this.baseURI, "http://s/mid/content=5/../6").toString()); } @Test void testResolveOpaque() { Assertions.assertEquals("example://a/./b/../b/%63/%7bfoo%7d", URIUtils.resolve(this.baseURI, "eXAMPLE://a/./b/../b/%63/%7bfoo%7d").toString()); Assertions.assertEquals("file://localhost/etc/fstab", URIUtils.resolve(this.baseURI, "file://localhost/etc/fstab").toString()); Assertions.assertEquals("file:///etc/fstab", URIUtils.resolve(this.baseURI, "file:///etc/fstab").toString()); Assertions.assertEquals("file://localhost/c:/WINDOWS/clock.avi", URIUtils.resolve(this.baseURI, "file://localhost/c:/WINDOWS/clock.avi").toString()); Assertions.assertEquals("file:///c:/WINDOWS/clock.avi", URIUtils.resolve(this.baseURI, "file:///c:/WINDOWS/clock.avi").toString()); Assertions.assertEquals("file://hostname/path/to/the%20file.txt", URIUtils.resolve(this.baseURI, "file://hostname/path/to/the%20file.txt").toString()); Assertions.assertEquals("file:///c:/path/to/the%20file.txt", URIUtils.resolve(this.baseURI, "file:///c:/path/to/the%20file.txt").toString()); Assertions.assertEquals("urn:issn:1535-3613", URIUtils.resolve(this.baseURI, "urn:issn:1535-3613").toString()); Assertions.assertEquals("mailto:user@example.com", URIUtils.resolve(this.baseURI, "mailto:user@example.com").toString()); Assertions.assertEquals("ftp://example.org/resource.txt", URIUtils.resolve(this.baseURI, "ftp://example.org/resource.txt").toString()); } @Test void testExtractHost() throws Exception { Assertions.assertEquals(new HttpHost("localhost"), URIUtils.extractHost(new URI("http://localhost/abcd"))); Assertions.assertEquals(new HttpHost("localhost"), URIUtils.extractHost(new URI("http://localhost/abcd%3A"))); Assertions.assertEquals(new HttpHost("local_host"), URIUtils.extractHost(new URI("http://local_host/abcd"))); Assertions.assertEquals(new HttpHost("local_host"), URIUtils.extractHost(new URI("http://local_host/abcd%3A"))); Assertions.assertEquals(new HttpHost("localhost",8), URIUtils.extractHost(new URI("http://localhost:8/abcd"))); Assertions.assertEquals(new HttpHost("local_host",8), URIUtils.extractHost(new URI("http://local_host:8/abcd"))); // URI seems to OK with missing port number Assertions.assertEquals(new HttpHost("localhost",-1),URIUtils.extractHost( new URI("http://localhost:/abcd"))); Assertions.assertEquals(new HttpHost("local_host",-1),URIUtils.extractHost( new URI("http://local_host:/abcd"))); Assertions.assertEquals(new HttpHost("localhost",8080), URIUtils.extractHost(new URI("http://user:pass@localhost:8080/abcd"))); Assertions.assertEquals(new HttpHost("local_host",8080), URIUtils.extractHost(new URI("http://user:pass@local_host:8080/abcd"))); Assertions.assertEquals(new HttpHost("localhost",8080),URIUtils.extractHost( new URI("http://@localhost:8080/abcd"))); Assertions.assertEquals(new HttpHost("local_host",8080),URIUtils.extractHost( new URI("http://@local_host:8080/abcd"))); Assertions.assertEquals(new HttpHost("2a00:1450:400c:c01::69",8080), URIUtils.extractHost(new URI("http://[2a00:1450:400c:c01::69]:8080/"))); Assertions.assertEquals(new HttpHost("localhost",8080), URIUtils.extractHost(new URI("http://localhost:8080/;sessionid=stuff/abcd"))); Assertions.assertNull(URIUtils.extractHost(new URI("http://localhost:8080;sessionid=stuff/abcd"))); Assertions.assertNull(URIUtils.extractHost(new URI("http://localhost:;sessionid=stuff/abcd"))); Assertions.assertNull(URIUtils.extractHost(new URI("http://:80/robots.txt"))); Assertions.assertNull(URIUtils.extractHost(new URI("http://some%20domain:80/robots.txt"))); } @Test void testHttpLocationWithRelativeFragment() throws Exception { final HttpHost target = new HttpHost("http", "localhost", -1); final URI requestURI = new URI("/stuff#blahblah"); final URI location = URIUtils.resolve(requestURI, target, null); final URI expectedURI = new URIBuilder(requestURI) .setHost(target.getHostName()) .setScheme(target.getSchemeName()) .build(); Assertions.assertEquals(expectedURI, location); } @Test void testHttpLocationWithAbsoluteFragment() throws Exception { final HttpHost target = new HttpHost("http", "localhost", 80); final URI requestURI = new URIBuilder() .setHost(target.getHostName()) .setScheme(target.getSchemeName()) .setPath("/stuff") .setFragment("blahblah") .build(); final URI location = URIUtils.resolve(requestURI, target, null); final URI expectedURI = requestURI; Assertions.assertEquals(expectedURI, location); } @Test void testHttpLocationRedirect() throws Exception { final HttpHost target = new HttpHost("http", "localhost", -1); final URI requestURI = new URI("/People.htm#tim"); final URI redirect = new URI("http://localhost/people.html"); final URI location = URIUtils.resolve(requestURI, target, Collections.singletonList(redirect)); final URI expectedURI = new URIBuilder() .setHost(target.getHostName()) .setScheme(target.getSchemeName()) .setPath("/people.html") .setFragment("tim") .build(); Assertions.assertEquals(expectedURI, location); } @Test void testHttpLocationWithRedirectFragment() throws Exception { final HttpHost target = new HttpHost("http", "localhost", -1); final URI requestURI = new URI("/~tim"); final URI redirect1 = new URI("http://localhost/People.htm#tim"); final URI redirect2 = new URI("http://localhost/people.html"); final URI location = URIUtils.resolve(requestURI, target, Arrays.asList(redirect1, redirect2)); final URI expectedURI = new URIBuilder() .setHost(target.getHostName()) .setScheme(target.getSchemeName()) .setPath("/people.html") .setFragment("tim") .build(); Assertions.assertEquals(expectedURI, location); } } httpclient5/src/test/java/org/apache/hc/client5/http/utils/TestDateUtils.java0100664 0000000 0000000 00000012202 14704162040 026221 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.utils; import java.time.Instant; import java.time.LocalDate; import java.time.Month; import java.time.ZoneId; import java.time.format.DateTimeFormatter; import java.time.temporal.ChronoUnit; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.HeaderGroup; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Unit tests for {@link DateUtils}. */ class TestDateUtils { private static Instant createInstant(final int year, final Month month, final int day) { return LocalDate.of(year, month, day).atStartOfDay(ZoneId.of("GMT")).toInstant(); } @Test void testBasicDateParse() { final Instant instant = createInstant(2005, Month.OCTOBER, 14); Assertions.assertEquals(instant, DateUtils.parseDate("Fri, 14 Oct 2005 00:00:00 GMT", DateUtils.FORMATTER_RFC1123)); Assertions.assertEquals(instant, DateUtils.parseDate("Friday, 14 Oct 2005 00:00:00 GMT", DateUtils.FORMATTER_RFC1123)); Assertions.assertEquals(instant, DateUtils.parseDate("Fri, 14-Oct-2005 00:00:00 GMT", DateUtils.FORMATTER_RFC1036)); Assertions.assertEquals(instant, DateUtils.parseDate("Friday, 14-Oct-2005 00:00:00 GMT", DateUtils.FORMATTER_RFC1036)); Assertions.assertEquals(instant.minus(2, ChronoUnit.HOURS), DateUtils.parseDate("Fri, 14 Oct 2005 00:00:00 CET", DateUtils.FORMATTER_RFC1123)); Assertions.assertEquals(instant.minus(2, ChronoUnit.HOURS), DateUtils.parseDate("Fri, 14-Oct-05 00:00:00 CET", DateUtils.FORMATTER_RFC1036)); Assertions.assertEquals(instant, DateUtils.parseStandardDate("Fri, 14 Oct 2005 00:00:00 GMT")); } @Test void testDateParseMessage() { final HeaderGroup message1 = new HeaderGroup(); message1.setHeader(new BasicHeader(HttpHeaders.DATE, "Fri, 14 Oct 2005 00:00:00 GMT")); Assertions.assertEquals(createInstant(2005, Month.OCTOBER, 14), DateUtils.parseStandardDate(message1, HttpHeaders.DATE)); final HeaderGroup message2 = new HeaderGroup(); message2.addHeader(new BasicHeader(HttpHeaders.DATE, "Fri, 14 Oct 2005 00:00:00 GMT")); message2.addHeader(new BasicHeader(HttpHeaders.DATE, "Fri, 21 Oct 2005 00:00:00 GMT")); Assertions.assertEquals(createInstant(2005, Month.OCTOBER, 14), DateUtils.parseStandardDate(message2, HttpHeaders.DATE)); } @Test void testMalformedDate() { Assertions.assertNull(DateUtils.parseDate("Fri, 14 Oct 2005 00:00:00 GMT", new DateTimeFormatter[] {})); Assertions.assertNull(DateUtils.parseDate("Thu Feb 22 17:20:18 2024", new DateTimeFormatter[] {})); } @Test void testInvalidInput() { Assertions.assertThrows(NullPointerException.class, () -> DateUtils.parseStandardDate(null)); Assertions.assertThrows(NullPointerException.class, () -> DateUtils.formatStandardDate(null)); } @Test void testTwoDigitYearDateParse() { Assertions.assertEquals(createInstant(2005, Month.OCTOBER, 14), DateUtils.parseDate("Friday, 14-Oct-05 00:00:00 GMT", DateUtils.FORMATTER_RFC1036)); } @Test void testParseQuotedDate() { Assertions.assertEquals(createInstant(2005, Month.OCTOBER, 14), DateUtils.parseDate("'Fri, 14 Oct 2005 00:00:00 GMT'", DateUtils.FORMATTER_RFC1123)); } @Test void testBasicDateFormat() { final Instant instant = createInstant(2005, Month.OCTOBER, 14); Assertions.assertEquals("Fri, 14 Oct 2005 00:00:00 GMT", DateUtils.formatStandardDate(instant)); Assertions.assertEquals("Fri, 14 Oct 2005 00:00:00 GMT", DateUtils.formatDate(instant, DateUtils.FORMATTER_RFC1123)); Assertions.assertEquals("Fri, 14-Oct-05 00:00:00 GMT", DateUtils.formatDate(instant, DateUtils.FORMATTER_RFC1036)); Assertions.assertEquals("Fri Oct 14 00:00:00 2005", DateUtils.formatDate(instant, DateUtils.FORMATTER_ASCTIME)); } } httpclient5/src/test/java/org/apache/hc/client5/http/utils/TestBase64.java0100664 0000000 0000000 00000011204 14704162040 025350 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.utils; import org.junit.jupiter.api.Test; import static java.nio.charset.StandardCharsets.US_ASCII; import static org.junit.jupiter.api.Assertions.assertArrayEquals; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNull; class TestBase64 { public static final char CHAR_ZERO = 0; public static final String EMPTY_STR = ""; public static final byte[] EMPTY_BYTES = new byte[0]; public static final String NULL_STR = null; public static final byte[] NULL_BYTE_ARRAY = null; public static final String EMOJI = "\uD83D\uDE15"; public static final char SPACE = ' '; private final Base64 target = new Base64(); @Test void nullHandling() { assertNull(target.decode(NULL_STR)); assertNull(target.decode(NULL_BYTE_ARRAY)); assertNull(Base64.decodeBase64(NULL_STR)); assertNull(Base64.decodeBase64(NULL_BYTE_ARRAY)); assertNull(target.encode(NULL_BYTE_ARRAY)); assertNull(Base64.encodeBase64(NULL_BYTE_ARRAY)); assertNull(Base64.encodeBase64String(NULL_BYTE_ARRAY)); } @Test void zeroLength() { assertArrayEquals(EMPTY_BYTES, target.decode(EMPTY_STR)); assertArrayEquals(EMPTY_BYTES, target.decode(EMPTY_BYTES)); assertArrayEquals(EMPTY_BYTES, Base64.decodeBase64(EMPTY_STR)); assertArrayEquals(EMPTY_BYTES, Base64.decodeBase64(EMPTY_BYTES)); assertArrayEquals(EMPTY_BYTES, target.encode(EMPTY_BYTES)); assertArrayEquals(EMPTY_BYTES, Base64.encodeBase64(EMPTY_BYTES)); assertEquals(EMPTY_STR, Base64.encodeBase64String(EMPTY_BYTES)); } @Test void validValues() { final byte[] unencodedBytes = "Hello World!".getBytes(US_ASCII); checkDecode(unencodedBytes, "SGVsbG8gV29ybGQh"); checkEncode("SGVsbG8gV29ybGQh", unencodedBytes); } @Test void decodeIgnoresEmbeddedInvalidChars() { checkEquivalentDecode(fourOf("A"), " A A A A "); checkEquivalentDecode(fourOf("A"), "AA" + EMOJI + "AA"); } @Test void decodeInvalid() { checkDecode(EMPTY_BYTES, fourOf(EMOJI)); checkDecode(EMPTY_BYTES, "A"); checkDecode(EMPTY_BYTES, "A==="); checkDecode(EMPTY_BYTES, fourOf(SPACE)); checkDecode(EMPTY_BYTES, fourOf('=')); checkDecode(EMPTY_BYTES, fourOf('@')); checkDecode(EMPTY_BYTES, fourOf(CHAR_ZERO)); } @Test void decodeUnpadded() { checkEquivalentDecode("AA==", "AA"); } private void checkDecode(final byte[] expectedDecoded, final String testInput) { final byte[] decoded = target.decode(testInput); assertArrayEquals(expectedDecoded, decoded); } private void checkEncode(final String expectedEncoded, final byte[] testInput) { final byte[] encoded = target.encode(testInput); assertEquals(expectedEncoded, new String(encoded, US_ASCII)); } private void checkEquivalentDecode(final String expectedEquivalentTo, final String testInput) { final byte[] decoded = target.decode(testInput); final byte[] expectedDecoded = java.util.Base64.getDecoder().decode(expectedEquivalentTo); assertArrayEquals(expectedDecoded, decoded); } private static String fourOf(final char c) { final String charStr = String.valueOf(c); return fourOf(charStr); } private static String fourOf(final String str) { return str + str + str + str; } }httpclient5/src/test/java/org/apache/hc/client5/http/protocol/0040775 0000000 0000000 00000000000 15063503632 023334 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestNextNonceInterceptor.java0100664 0000000 0000000 00000010736 15005672016 031162 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestNextNonceInterceptor { private static final String AUTHENTICATION_INFO_HEADER = "Authentication-Info"; private NextNonceInterceptor interceptor; private HttpClientContext context; @BeforeEach void setUp() { interceptor = new NextNonceInterceptor(); context = HttpClientContext.create(); } @Test void testNoAuthenticationInfoHeader() { final HttpResponse response = new BasicHttpResponse(200); interceptor.process(response, null, context); Assertions.assertNull(context.getNextNonce(), "Context should not contain nextnonce when the header is missing"); } @Test void testAuthenticationInfoHeaderWithoutNextNonce() { final HttpResponse response = new BasicHttpResponse(200); response.addHeader(new BasicHeader(AUTHENTICATION_INFO_HEADER, "auth-param=value")); interceptor.process(response, null, context); Assertions.assertNull(context.getNextNonce(), "Context should not contain nextnonce when it is missing in the header value"); } @Test void testAuthenticationInfoHeaderWithNextNonce() { final HttpResponse response = new BasicHttpResponse(200); response.addHeader(new BasicHeader(AUTHENTICATION_INFO_HEADER, "nextnonce=\"10024b2308596a55d02699c0a0400fb4\",qop=auth,rspauth=\"0386df3cb9effdf08c9e00ab955827f3\",cnonce=\"21558090\",nc=00000001")); interceptor.process(response, null, context); Assertions.assertEquals("10024b2308596a55d02699c0a0400fb4", context.getNextNonce(), "Context should contain the correct nextnonce value when it is present in the header"); } @Test void testMultipleAuthenticationInfoHeaders() { final HttpResponse response = new BasicHttpResponse(200); response.addHeader(new BasicHeader(AUTHENTICATION_INFO_HEADER, "auth-param=value")); // First header without nextnonce response.addHeader(new BasicHeader(AUTHENTICATION_INFO_HEADER, "nextnonce=\"10024b2308596a55d02699c0a0400fb4\",qop=auth,rspauth=\"0386df3cb9effdf08c9e00ab955827f3\",cnonce=\"21558090\",nc=00000001")); // Second header with nextnonce interceptor.process(response, null, context); // Since only the first header is processed, `auth-nextnonce` should not be set in the context Assertions.assertNull(context.getNextNonce(), "Context should not contain nextnonce if it's not in the first Authentication-Info header"); } @Test void testAuthenticationInfoHeaderWithEmptyNextNonce() { final HttpResponse response = new BasicHttpResponse(200); response.addHeader(new BasicHeader(AUTHENTICATION_INFO_HEADER, "nextnonce=\"\",qop=auth,rspauth=\"0386df3cb9effdf08c9e00ab955827f3\",cnonce=\"21558090\",nc=00000001")); interceptor.process(response, null, context); Assertions.assertNull(context.getNextNonce(), "Context should not contain nextnonce if it is empty in the Authentication-Info header"); } } httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestExpectContinue.java0100664 0000000 0000000 00000013216 15063503632 031345 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.nio.charset.StandardCharsets; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestRequestExpectContinue { @Test void testRequestExpectContinueGenerated() throws Exception { final HttpClientContext context = HttpClientContext.create(); final RequestConfig config = RequestConfig.custom().setExpectContinueEnabled(true).build(); context.setRequestConfig(config); final ClassicHttpRequest request = new BasicClassicHttpRequest("POST", "/"); final String s = "whatever"; final StringEntity entity = new StringEntity(s, StandardCharsets.US_ASCII); request.setEntity(entity); final RequestExpectContinue interceptor = new RequestExpectContinue(); interceptor.process(request, request.getEntity(), context); final Header header = request.getFirstHeader(HttpHeaders.EXPECT); Assertions.assertNotNull(header); Assertions.assertEquals(HeaderElements.CONTINUE, header.getValue()); } @Test void testRequestExpectContinueNotGenerated() throws Exception { final HttpClientContext context = HttpClientContext.create(); final RequestConfig config = RequestConfig.custom().setExpectContinueEnabled(false).build(); context.setRequestConfig(config); final ClassicHttpRequest request = new BasicClassicHttpRequest("POST", "/"); final String s = "whatever"; final StringEntity entity = new StringEntity(s, StandardCharsets.US_ASCII); request.setEntity(entity); final RequestExpectContinue interceptor = new RequestExpectContinue(); interceptor.process(request, null, context); final Header header = request.getFirstHeader(HeaderElements.CONTINUE); Assertions.assertNull(header); } @Test void testRequestExpectContinueHTTP10() throws Exception { final HttpClientContext context = HttpClientContext.create(); final RequestConfig config = RequestConfig.custom().setExpectContinueEnabled(true).build(); context.setRequestConfig(config); final ClassicHttpRequest request = new BasicClassicHttpRequest("POST", "/"); request.setVersion(HttpVersion.HTTP_1_0); final String s = "whatever"; final StringEntity entity = new StringEntity(s, StandardCharsets.US_ASCII); request.setEntity(entity); final RequestExpectContinue interceptor = new RequestExpectContinue(); interceptor.process(request, null, context); final Header header = request.getFirstHeader(HeaderElements.CONTINUE); Assertions.assertNull(header); } @Test void testRequestExpectContinueZeroContent() throws Exception { final HttpClientContext context = HttpClientContext.create(); final RequestConfig config = RequestConfig.custom().setExpectContinueEnabled(true).build(); context.setRequestConfig(config); final ClassicHttpRequest request = new BasicClassicHttpRequest("POST", "/"); final String s = ""; final StringEntity entity = new StringEntity(s, StandardCharsets.US_ASCII); request.setEntity(entity); final RequestExpectContinue interceptor = new RequestExpectContinue(); interceptor.process(request, null, context); final Header header = request.getFirstHeader(HeaderElements.CONTINUE); Assertions.assertNull(header); } @Test void testRequestExpectContinueInvalidInput() { final RequestExpectContinue interceptor = new RequestExpectContinue(); Assertions.assertThrows(NullPointerException.class, () -> interceptor.process(null, null, null)); } @Test void testRequestExpectContinueIgnoreNonenclosingRequests() throws Exception { final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new BasicClassicHttpRequest("POST", "/"); final RequestExpectContinue interceptor = new RequestExpectContinue(); interceptor.process(request, null, context); Assertions.assertEquals(0, request.getHeaders().length); } } httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestResponseProcessCookies.java0100664 0000000 0000000 00000013631 14704162040 031505 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.util.List; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.cookie.RFC6265LaxSpec; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpResponseInterceptor; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestResponseProcessCookies { private CookieOrigin cookieOrigin; private CookieSpec cookieSpec; private CookieStore cookieStore; @BeforeEach void setUp() { this.cookieOrigin = new CookieOrigin("localhost", 80, "/", false); this.cookieSpec = new RFC6265LaxSpec(); this.cookieStore = new BasicCookieStore(); } @Test void testResponseParameterCheck() { final HttpClientContext context = HttpClientContext.create(); final HttpResponseInterceptor interceptor = ResponseProcessCookies.INSTANCE; Assertions.assertThrows(NullPointerException.class, () -> interceptor.process(null, null, context)); } @Test void testContextParameterCheck() { final HttpResponse response = new BasicHttpResponse(200, "OK"); final HttpResponseInterceptor interceptor = ResponseProcessCookies.INSTANCE; Assertions.assertThrows(NullPointerException.class, () -> interceptor.process(response, null, null)); } @Test void testParseCookies() throws Exception { final HttpResponse response = new BasicHttpResponse(200, "OK"); response.addHeader("Set-Cookie", "name1=value1"); final HttpClientContext context = HttpClientContext.create(); context.setCookieOrigin(this.cookieOrigin); context.setCookieSpec(this.cookieSpec); context.setCookieStore(this.cookieStore); final HttpResponseInterceptor interceptor = ResponseProcessCookies.INSTANCE; interceptor.process(response, null, context); final List cookies = this.cookieStore.getCookies(); Assertions.assertNotNull(cookies); Assertions.assertEquals(1, cookies.size()); final Cookie cookie = cookies.get(0); Assertions.assertEquals("name1", cookie.getName()); Assertions.assertEquals("value1", cookie.getValue()); Assertions.assertEquals("localhost", cookie.getDomain()); Assertions.assertEquals("/", cookie.getPath()); } @Test void testNoCookieOrigin() throws Exception { final HttpResponse response = new BasicHttpResponse(200, "OK"); response.addHeader("Set-Cookie", "name1=value1"); final HttpClientContext context = HttpClientContext.create(); context.setCookieOrigin(null); context.setCookieSpec(this.cookieSpec); context.setCookieStore(this.cookieStore); final HttpResponseInterceptor interceptor = ResponseProcessCookies.INSTANCE; interceptor.process(response, null, context); final List cookies = this.cookieStore.getCookies(); Assertions.assertNotNull(cookies); Assertions.assertEquals(0, cookies.size()); } @Test void testNoCookieSpec() throws Exception { final HttpResponse response = new BasicHttpResponse(200, "OK"); response.addHeader("Set-Cookie", "name1=value1"); final HttpClientContext context = HttpClientContext.create(); context.setCookieOrigin(this.cookieOrigin); context.setCookieSpec(null); context.setCookieStore(this.cookieStore); final HttpResponseInterceptor interceptor = ResponseProcessCookies.INSTANCE; interceptor.process(response, null, context); final List cookies = this.cookieStore.getCookies(); Assertions.assertNotNull(cookies); Assertions.assertEquals(0, cookies.size()); } @Test void testNoCookieStore() throws Exception { final HttpResponse response = new BasicHttpResponse(200, "OK"); response.addHeader("Set-Cookie", "name1=value1"); final HttpClientContext context = HttpClientContext.create(); context.setCookieOrigin(this.cookieOrigin); context.setCookieSpec(this.cookieSpec); context.setCookieStore(null); final HttpResponseInterceptor interceptor = ResponseProcessCookies.INSTANCE; interceptor.process(response, null, context); final List cookies = this.cookieStore.getCookies(); Assertions.assertNotNull(cookies); Assertions.assertEquals(0, cookies.size()); } } httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRedirectLocation.java0100664 0000000 0000000 00000004673 14704162040 030273 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.net.URI; import java.util.List; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Simple tests for {@link RedirectLocations}. */ class TestRedirectLocation { @Test void testBasics() throws Exception { final RedirectLocations locations = new RedirectLocations(); final URI uri1 = new URI("/this"); final URI uri2 = new URI("/that"); final URI uri3 = new URI("/this-and-that"); locations.add(uri1); locations.add(uri2); locations.add(uri2); locations.add(uri3); locations.add(uri3); Assertions.assertTrue(locations.contains(uri1)); Assertions.assertTrue(locations.contains(uri2)); Assertions.assertTrue(locations.contains(uri3)); Assertions.assertFalse(locations.contains(new URI("/"))); final List list = locations.getAll(); Assertions.assertNotNull(list); Assertions.assertEquals(5, list.size()); Assertions.assertEquals(uri1, list.get(0)); Assertions.assertEquals(uri2, list.get(1)); Assertions.assertEquals(uri2, list.get(2)); Assertions.assertEquals(uri3, list.get(3)); Assertions.assertEquals(uri3, list.get(4)); } } httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestUpgrade.java0100664 0000000 0000000 00000013160 14740035240 027771 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.HeadersMatcher; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.hamcrest.MatcherAssert; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mockito; class TestRequestUpgrade { private RequestUpgrade interceptor; private HttpClientContext context; @BeforeEach void setUp() { interceptor = new RequestUpgrade(); context = HttpClientContext.create(); } @Test void testUpgrade() throws Exception { final HttpRequest get = new BasicHttpRequest("GET", "/"); interceptor.process(get, null, context); MatcherAssert.assertThat(get.getHeaders(), HeadersMatcher.same( new BasicHeader(HttpHeaders.UPGRADE, "TLS/1.2"), new BasicHeader(HttpHeaders.CONNECTION, HttpHeaders.UPGRADE))); final HttpRequest options = new BasicHttpRequest("OPTIONS", "/"); interceptor.process(options, null, context); MatcherAssert.assertThat(options.getHeaders(), HeadersMatcher.same( new BasicHeader(HttpHeaders.UPGRADE, "TLS/1.2"), new BasicHeader(HttpHeaders.CONNECTION, HttpHeaders.UPGRADE))); final HttpRequest head = new BasicHttpRequest("HEAD", "/"); interceptor.process(head, null, context); MatcherAssert.assertThat(head.getHeaders(), HeadersMatcher.same( new BasicHeader(HttpHeaders.UPGRADE, "TLS/1.2"), new BasicHeader(HttpHeaders.CONNECTION, HttpHeaders.UPGRADE))); } @Test void testUpgradeDisabled() throws Exception { context.setRequestConfig(RequestConfig.custom() .setProtocolUpgradeEnabled(false) .build()); final HttpRequest get = new BasicHttpRequest("GET", "/"); interceptor.process(get, null, context); Assertions.assertFalse(get.containsHeader(HttpHeaders.UPGRADE)); } @Test void testDoNotUpgradeHTTP2() throws Exception { context.setProtocolVersion(HttpVersion.HTTP_2); final HttpRequest get = new BasicHttpRequest("GET", "/"); interceptor.process(get, null, context); Assertions.assertFalse(get.containsHeader(HttpHeaders.UPGRADE)); } @Test void testDoNotUpgradeHTTP10() throws Exception { context.setProtocolVersion(HttpVersion.HTTP_1_0); final HttpRequest get = new BasicHttpRequest("GET", "/"); interceptor.process(get, null, context); Assertions.assertFalse(get.containsHeader(HttpHeaders.UPGRADE)); } @Test void testDoUpgradeIfAlreadyTLS() throws Exception { context.setSSLSession(Mockito.mock(SSLSession.class)); final HttpRequest get = new BasicHttpRequest("GET", "/"); interceptor.process(get, null, context); Assertions.assertFalse(get.containsHeader(HttpHeaders.UPGRADE)); } @Test void testDoUpgradeIfConnectionHeaderPresent() throws Exception { final HttpRequest get = new BasicHttpRequest("GET", "/"); get.addHeader(HttpHeaders.CONNECTION, "keep-alive"); interceptor.process(get, null, context); Assertions.assertFalse(get.containsHeader(HttpHeaders.UPGRADE)); } @Test void testDoUpgradeNonSafeMethodsOrTrace() throws Exception { final HttpRequest post = new BasicHttpRequest("POST", "/"); interceptor.process(post, null, context); Assertions.assertFalse(post.containsHeader(HttpHeaders.UPGRADE)); final HttpRequest put = new BasicHttpRequest("PUT", "/"); interceptor.process(put, null, context); Assertions.assertFalse(put.containsHeader(HttpHeaders.UPGRADE)); final HttpRequest patch = new BasicHttpRequest("PATCH", "/"); interceptor.process(patch, null, context); Assertions.assertFalse(patch.containsHeader(HttpHeaders.UPGRADE)); final HttpRequest trace = new BasicHttpRequest("TRACE", "/"); interceptor.process(trace, null, context); Assertions.assertFalse(trace.containsHeader(HttpHeaders.UPGRADE)); } } httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestValidateTrace.java0100664 0000000 0000000 00000007126 14704162040 031116 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertThrows; import java.io.IOException; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.impl.BasicEntityDetails; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestRequestValidateTrace { private RequestValidateTrace interceptor; private HttpRequest request; private HttpContext context; @BeforeEach void setUp() { interceptor = new RequestValidateTrace(); context = HttpClientContext.create(); } @Test void testTraceRequestWithoutSensitiveHeaders() throws HttpException, IOException { request = new BasicHttpRequest("TRACE", "/"); interceptor.process(request, null, context); assertNull(request.getHeader(HttpHeaders.AUTHORIZATION)); } @Test void testTraceRequestWithSensitiveHeaders() { request = new BasicHttpRequest("TRACE", "/"); request.setHeader(HttpHeaders.AUTHORIZATION, "Bearer token"); assertThrows(ProtocolException.class, () -> interceptor.process(request, null, context)); } @Test void testTraceRequestWithBody() { request = new BasicHttpRequest("TRACE", "/"); final EntityDetails entity = new BasicEntityDetails(10, null); assertThrows(ProtocolException.class, () -> interceptor.process(request, entity, context)); } @Test void testNonTraceRequest() throws HttpException, IOException { request = new BasicHttpRequest("GET", "/"); request.setHeader(HttpHeaders.AUTHORIZATION, "Bearer token"); interceptor.process(request, null, context); assertNotNull(request.getHeader(HttpHeaders.AUTHORIZATION)); } @Test void testTraceRequestWithCookieHeader() { request = new BasicHttpRequest("TRACE", "/"); request.setHeader(HttpHeaders.COOKIE, "someCookie=someValue"); assertThrows(ProtocolException.class, () -> interceptor.process(request, null, context)); } } httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestAddCookies.java0100664 0000000 0000000 00000044213 15005672016 030415 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.time.Instant; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteInfo.LayerType; import org.apache.hc.client5.http.RouteInfo.TunnelType; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.CookieSpec; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.cookie.StandardCookieSpec; import org.apache.hc.client5.http.impl.cookie.BasicClientCookie; import org.apache.hc.client5.http.impl.cookie.IgnoreCookieSpecFactory; import org.apache.hc.client5.http.impl.cookie.RFC6265CookieSpecFactory; import org.apache.hc.client5.http.impl.cookie.RFC6265StrictSpec; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentMatchers; import org.mockito.Mockito; class TestRequestAddCookies { private HttpHost target; private CookieStore cookieStore; private Lookup cookieSpecRegistry; @BeforeEach void setUp() { this.target = new HttpHost("localhost.local", 80); this.cookieStore = new BasicCookieStore(); final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value1"); cookie1.setDomain("localhost.local"); cookie1.setPath("/"); this.cookieStore.addCookie(cookie1); final BasicClientCookie cookie2 = new BasicClientCookie("name2", "value2"); cookie2.setDomain("localhost.local"); cookie2.setPath("/"); this.cookieStore.addCookie(cookie2); this.cookieSpecRegistry = RegistryBuilder.create() .register(StandardCookieSpec.RELAXED, new RFC6265CookieSpecFactory( RFC6265CookieSpecFactory.CompatibilityLevel.RELAXED, null)) .register(StandardCookieSpec.STRICT, new RFC6265CookieSpecFactory( RFC6265CookieSpecFactory.CompatibilityLevel.STRICT, null)) .register(StandardCookieSpec.IGNORE, new IgnoreCookieSpecFactory()) .build(); } @Test void testRequestParameterCheck() { final HttpClientContext context = HttpClientContext.create(); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; Assertions.assertThrows(NullPointerException.class, () -> interceptor.process(null, null, context)); } @Test void testContextParameterCheck() { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; Assertions.assertThrows(NullPointerException.class, () -> interceptor.process(request, null, null)); } @Test void testAddCookies() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpRoute route = new HttpRoute(this.target, null, false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final Header[] headers = request.getHeaders("Cookie"); Assertions.assertNotNull(headers); Assertions.assertEquals(1, headers.length); Assertions.assertEquals("name1=value1; name2=value2", headers[0].getValue()); final CookieOrigin cookieOrigin = context.getCookieOrigin(); Assertions.assertNotNull(cookieOrigin); Assertions.assertEquals(this.target.getHostName(), cookieOrigin.getHost()); Assertions.assertEquals(this.target.getPort(), cookieOrigin.getPort()); Assertions.assertEquals("/", cookieOrigin.getPath()); Assertions.assertFalse(cookieOrigin.isSecure()); } @Test void testCookiesForConnectRequest() throws Exception { final HttpRequest request = new BasicHttpRequest("CONNECT", "www.somedomain.com"); final HttpRoute route = new HttpRoute(this.target, null, false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final Header[] headers = request.getHeaders("Cookie"); Assertions.assertNotNull(headers); Assertions.assertEquals(0, headers.length); } @Test void testNoCookieStore() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpRoute route = new HttpRoute(this.target, null, false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(null); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final Header[] headers = request.getHeaders("Cookie"); Assertions.assertNotNull(headers); Assertions.assertEquals(0, headers.length); } @Test void testNoCookieSpecRegistry() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpRoute route = new HttpRoute(this.target, null, false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(null); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final Header[] headers = request.getHeaders("Cookie"); Assertions.assertNotNull(headers); Assertions.assertEquals(0, headers.length); } @Test void testNoHttpConnection() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpClientContext context = HttpClientContext.create(); context.setEndpointDetails(null); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final Header[] headers = request.getHeaders("Cookie"); Assertions.assertNotNull(headers); Assertions.assertEquals(0, headers.length); } @Test void testAddCookiesUsingExplicitCookieSpec() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final RequestConfig config = RequestConfig.custom() .setCookieSpec(StandardCookieSpec.STRICT) .build(); final HttpRoute route = new HttpRoute(this.target, null, false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setRequestConfig(config); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final CookieSpec cookieSpec = context.getCookieSpec(); Assertions.assertTrue(cookieSpec instanceof RFC6265StrictSpec); final Header[] headers1 = request.getHeaders("Cookie"); Assertions.assertNotNull(headers1); Assertions.assertEquals(1, headers1.length); Assertions.assertEquals("name1=value1; name2=value2", headers1[0].getValue()); } @Test void testAuthScopeInvalidRequestURI() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "crap:"); final HttpRoute route = new HttpRoute(this.target, null, false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); } @Test void testAuthScopeRemotePortWhenDirect() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/stuff"); this.target = new HttpHost("localhost.local"); final HttpRoute route = new HttpRoute(new HttpHost("localhost.local", 1234), null, false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final CookieOrigin cookieOrigin = context.getCookieOrigin(); Assertions.assertNotNull(cookieOrigin); Assertions.assertEquals(this.target.getHostName(), cookieOrigin.getHost()); Assertions.assertEquals(1234, cookieOrigin.getPort()); Assertions.assertEquals("/stuff", cookieOrigin.getPath()); Assertions.assertFalse(cookieOrigin.isSecure()); } @Test void testAuthDefaultHttpPortWhenProxy() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/stuff"); this.target = new HttpHost("localhost.local"); final HttpRoute route = new HttpRoute( new HttpHost("localhost.local", 80), null, new HttpHost("localhost", 8888), false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final CookieOrigin cookieOrigin = context.getCookieOrigin(); Assertions.assertNotNull(cookieOrigin); Assertions.assertEquals(this.target.getHostName(), cookieOrigin.getHost()); Assertions.assertEquals(80, cookieOrigin.getPort()); Assertions.assertEquals("/stuff", cookieOrigin.getPath()); Assertions.assertFalse(cookieOrigin.isSecure()); } @Test void testAuthDefaultHttpsPortWhenProxy() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/stuff"); this.target = new HttpHost("https", "localhost", -1); final HttpRoute route = new HttpRoute( new HttpHost("https", "localhost", 443), null, new HttpHost("http", "localhost", 8888), true, TunnelType.TUNNELLED, LayerType.LAYERED); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final CookieOrigin cookieOrigin = context.getCookieOrigin(); Assertions.assertNotNull(cookieOrigin); Assertions.assertEquals(this.target.getHostName(), cookieOrigin.getHost()); Assertions.assertEquals(443, cookieOrigin.getPort()); Assertions.assertEquals("/stuff", cookieOrigin.getPath()); Assertions.assertTrue(cookieOrigin.isSecure()); } @Test void testExcludeExpiredCookies() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final BasicClientCookie cookie3 = new BasicClientCookie("name3", "value3"); cookie3.setDomain("localhost.local"); cookie3.setPath("/"); cookie3.setExpiryDate(Instant.now().plusMillis(100)); this.cookieStore.addCookie(cookie3); Assertions.assertEquals(3, this.cookieStore.getCookies().size()); this.cookieStore = Mockito.spy(this.cookieStore); final HttpRoute route = new HttpRoute(this.target, null, false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); // Make sure the third cookie expires Thread.sleep(200); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final Header[] headers = request.getHeaders("Cookie"); Assertions.assertNotNull(headers); Assertions.assertEquals(1, headers.length); Assertions.assertEquals("name1=value1; name2=value2", headers[0].getValue()); Mockito.verify(this.cookieStore, Mockito.times(1)).clearExpired(ArgumentMatchers.any(Instant.class)); } @Test void testNoMatchingCookies() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); this.cookieStore.clear(); final BasicClientCookie cookie3 = new BasicClientCookie("name3", "value3"); cookie3.setDomain("www.somedomain.com"); cookie3.setPath("/"); this.cookieStore.addCookie(cookie3); final HttpRoute route = new HttpRoute(this.target, null, false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final Header[] headers = request.getHeaders("Cookie"); Assertions.assertNotNull(headers); Assertions.assertEquals(0, headers.length); } // Helper method private BasicClientCookie makeCookie(final String name, final String value, final String domain, final String path) { final BasicClientCookie cookie = new BasicClientCookie(name, value); cookie.setDomain(domain); cookie.setPath(path); return cookie; } @Test // Test for ordering adapted from test in Commons HC 3.1 void testCookieOrder() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/foobar/yada/yada"); this.cookieStore.clear(); cookieStore.addCookie(makeCookie("nomatch", "value", "localhost.local", "/noway")); cookieStore.addCookie(makeCookie("name2", "value", "localhost.local", "/foobar/yada")); cookieStore.addCookie(makeCookie("name3", "value", "localhost.local", "/foobar")); cookieStore.addCookie(makeCookie("name1", "value", "localhost.local", "/foobar/yada/yada")); final HttpRoute route = new HttpRoute(this.target, null, false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); final Header[] headers1 = request.getHeaders("Cookie"); Assertions.assertNotNull(headers1); Assertions.assertEquals(1, headers1.length); Assertions.assertEquals("name1=value; name2=value; name3=value", headers1[0].getValue()); } @Test void testSkipAddingCookiesWhenCookieHeaderPresent() throws Exception { // Prepare a request with an existing Cookie header final HttpRequest request = new BasicHttpRequest("GET", "/"); request.addHeader("Cookie", "existingCookie=existingValue"); final HttpRoute route = new HttpRoute(this.target, null, false); final HttpClientContext context = HttpClientContext.create(); context.setRoute(route); context.setCookieStore(this.cookieStore); context.setCookieSpecRegistry(this.cookieSpecRegistry); final HttpRequestInterceptor interceptor = RequestAddCookies.INSTANCE; interceptor.process(request, null, context); // Check that no additional cookies were added final Header[] headers = request.getHeaders("Cookie"); Assertions.assertNotNull(headers); Assertions.assertEquals(1, headers.length); Assertions.assertEquals("existingCookie=existingValue", headers[0].getValue()); } } httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestDefaultHeaders.java0100664 0000000 0000000 00000006460 14704162040 031266 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import java.util.ArrayList; import java.util.List; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestRequestDefaultHeaders { @Test void testRequestParameterCheck() { final HttpContext context = HttpClientContext.create(); final HttpRequestInterceptor interceptor = RequestDefaultHeaders.INSTANCE; Assertions.assertThrows(NullPointerException.class, () -> interceptor.process(null, null, context)); } @Test void testNoDefaultHeadersForConnectRequest() throws Exception { final HttpRequest request = new BasicHttpRequest("CONNECT", "www.somedomain.com"); final List
defheaders = new ArrayList<>(); defheaders.add(new BasicHeader("custom", "stuff")); final HttpContext context = HttpClientContext.create(); final HttpRequestInterceptor interceptor = new RequestDefaultHeaders(defheaders); interceptor.process(request, null, context); final Header header1 = request.getFirstHeader("custom"); Assertions.assertNull(header1); } @Test void testDefaultHeaders() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); request.addHeader("custom", "stuff"); final List
defheaders = new ArrayList<>(); defheaders.add(new BasicHeader("custom", "other stuff")); final HttpContext context = HttpClientContext.create(); final HttpRequestInterceptor interceptor = new RequestDefaultHeaders(defheaders); interceptor.process(request, null, context); final Header[] headers = request.getHeaders("custom"); Assertions.assertNotNull(headers); Assertions.assertEquals(1, headers.length); Assertions.assertEquals("stuff", headers[0].getValue()); } } httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestClientConnControl.java0100664 0000000 0000000 00000013560 14704162040 032002 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteInfo.LayerType; import org.apache.hc.client5.http.RouteInfo.TunnelType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HeaderElements; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestRequestClientConnControl { @Test void testRequestParameterCheck() { final HttpClientContext context = HttpClientContext.create(); final HttpRequestInterceptor interceptor = new RequestClientConnControl(); Assertions.assertThrows(NullPointerException.class, () -> interceptor.process(null, null, context)); } @Test void testConnectionKeepAliveForConnectRequest() throws Exception { final HttpRequest request = new BasicHttpRequest("CONNECT", "www.somedomain.com"); final HttpClientContext context = HttpClientContext.create(); final HttpRequestInterceptor interceptor = new RequestClientConnControl(); interceptor.process(request, null, context); final Header header = request.getFirstHeader(HttpHeaders.CONNECTION); Assertions.assertNull(header); } @Test void testConnectionKeepAliveForDirectRequests() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpClientContext context = HttpClientContext.create(); final HttpHost target = new HttpHost("http", "localhost", 80); final HttpRoute route = new HttpRoute(target, null, false); context.setRoute(route); final HttpRequestInterceptor interceptor = new RequestClientConnControl(); interceptor.process(request, null, context); final Header header = request.getFirstHeader(HttpHeaders.CONNECTION); Assertions.assertNotNull(header); Assertions.assertEquals(HeaderElements.KEEP_ALIVE, header.getValue()); } @Test void testConnectionKeepAliveForTunneledRequests() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpClientContext context = HttpClientContext.create(); final HttpHost target = new HttpHost("https", "localhost", 443); final HttpHost proxy = new HttpHost("localhost", 8080); final HttpRoute route = new HttpRoute(target, null, proxy, true, TunnelType.TUNNELLED, LayerType.LAYERED); context.setRoute(route); final HttpRequestInterceptor interceptor = new RequestClientConnControl(); interceptor.process(request, null, context); final Header header = request.getFirstHeader(HttpHeaders.CONNECTION); Assertions.assertNotNull(header); Assertions.assertEquals(HeaderElements.KEEP_ALIVE, header.getValue()); } @Test void testProxyConnectionKeepAliveForRequestsOverProxy() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpClientContext context = HttpClientContext.create(); final HttpHost target = new HttpHost("http", "localhost", 80); final HttpHost proxy = new HttpHost("localhost", 8080); final HttpRoute route = new HttpRoute(target, null, proxy, false, TunnelType.PLAIN, LayerType.PLAIN); context.setRoute(route); final HttpRequestInterceptor interceptor = new RequestClientConnControl(); interceptor.process(request, null, context); final Header header = request.getFirstHeader(HttpHeaders.CONNECTION); Assertions.assertNull(header); } @Test void testPreserveCustomConnectionHeader() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); request.addHeader(HttpHeaders.CONNECTION, HeaderElements.CLOSE); final HttpClientContext context = HttpClientContext.create(); final HttpHost target = new HttpHost("https", "localhost", 443); final HttpHost proxy = new HttpHost("localhost", 8080); final HttpRoute route = new HttpRoute(target, null, proxy, true, TunnelType.TUNNELLED, LayerType.LAYERED); context.setRoute(route); final HttpRequestInterceptor interceptor = new RequestClientConnControl(); interceptor.process(request, null, context); final Header header = request.getFirstHeader(HttpHeaders.CONNECTION); Assertions.assertNotNull(header); Assertions.assertEquals(HeaderElements.CLOSE, header.getValue()); } } httpclient5/src/test/java/org/apache/hc/client5/http/protocol/TestRequestIfRange.java0100664 0000000 0000000 00000013577 14704162040 027730 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.protocol; import static org.junit.jupiter.api.Assertions.assertThrows; import static org.mockito.Answers.RETURNS_DEEP_STUBS; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.protocol.HttpContext; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.MockitoAnnotations; class TestRequestIfRange { @Mock private HttpRequest request; @Mock private EntityDetails entity; @Mock private HttpContext context; private RequestIfRange requestIfRange; @BeforeEach void setUp() { MockitoAnnotations.openMocks(this); requestIfRange = new RequestIfRange(); } @Test void testNoIfRangeHeader() throws Exception { when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(null); requestIfRange.process(request, entity, context); // No exception should be thrown } @Test void testIfRangeWithoutRangeHeader() { when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(mock(Header.class)); when(request.containsHeader(HttpHeaders.RANGE)).thenReturn(false); assertThrows(ProtocolException.class, () -> requestIfRange.process(request, entity, context)); } @Test void testWeakETagInIfRange() { when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(mock(Header.class)); when(request.containsHeader(HttpHeaders.RANGE)).thenReturn(true); when(request.getFirstHeader(HttpHeaders.ETAG)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS)); when(request.getFirstHeader(HttpHeaders.ETAG).getValue()).thenReturn("W/\"weak-etag\""); assertThrows(ProtocolException.class, () -> requestIfRange.process(request, entity, context)); } @Test void testDateHeaderWithStrongValidator() throws Exception { when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(mock(Header.class)); when(request.containsHeader(HttpHeaders.RANGE)).thenReturn(true); when(request.getFirstHeader(HttpHeaders.DATE)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS)); when(request.getFirstHeader(HttpHeaders.DATE).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:31 GMT"); when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS)); when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:30 GMT"); requestIfRange.process(request, entity, context); // No exception should be thrown } @Test void testSmallDifferenceWithETagPresent() { when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(mock(Header.class)); when(request.containsHeader(HttpHeaders.RANGE)).thenReturn(true); when(request.getFirstHeader(HttpHeaders.DATE)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS)); when(request.getFirstHeader(HttpHeaders.DATE).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:30 GMT"); // Same as Last-Modified when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS)); when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:30 GMT"); final Header mockETagHeader = mock(Header.class); when(mockETagHeader.getValue()).thenReturn("\"some-value\""); // Mocking a weak ETag value when(request.getFirstHeader(HttpHeaders.ETAG)).thenReturn(mockETagHeader); assertThrows(ProtocolException.class, () -> requestIfRange.process(request, entity, context)); } @Test void testSmallDifferenceWithETagAbsent() throws Exception { when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(mock(Header.class)); when(request.containsHeader(HttpHeaders.RANGE)).thenReturn(true); when(request.getFirstHeader(HttpHeaders.DATE)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS)); when(request.getFirstHeader(HttpHeaders.DATE).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:31 GMT"); when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS)); when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:30 GMT"); when(request.getFirstHeader(HttpHeaders.ETAG)).thenReturn(null); requestIfRange.process(request, entity, context); // No exception should be thrown } }httpclient5/src/test/java/org/apache/hc/client5/http/examples/0040775 0000000 0000000 00000000000 15063503632 023311 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000147 14666635064 011655 Lustar 0000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientPreemptiveBasicAuthentication.javahttpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientPreemptiveBasicAuthentication.ja0100664 0000000 0000000 00000006071 14666635064 032764 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import org.apache.hc.client5.http.ContextBuilder; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; /** * An example of how HttpClient can be customized to authenticate * preemptively using Basic scheme. * * Generally, preemptive authentication can be considered less * secure than a response to an authentication challenge * and therefore discouraged. */ public class ClientPreemptiveBasicAuthentication { public static void main(final String[] args) throws Exception { try (final CloseableHttpClient httpclient = HttpClients.createDefault()) { final HttpClientContext localContext = ContextBuilder.create() .preemptiveBasicAuth(new HttpHost("http", "httpbin.org"), new UsernamePasswordCredentials("user", "passwd".toCharArray())) .build(); final HttpGet httpget = new HttpGet("http://httpbin.org/hidden-basic-auth/user/passwd"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); for (int i = 0; i < 3; i++) { httpclient.execute(httpget, localContext, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); } } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientMultiThreadedExecution.java0100664 0000000 0000000 00000011163 14704162040 031724 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.protocol.HttpContext; /** * An example that performs GETs from multiple threads. * */ public class ClientMultiThreadedExecution { public static void main(final String[] args) throws Exception { // Create an HttpClient with the PoolingHttpClientConnectionManager. // This connection manager must be used if more than one thread will // be using the HttpClient. final PoolingHttpClientConnectionManager cm = new PoolingHttpClientConnectionManager(); cm.setMaxTotal(100); try (final CloseableHttpClient httpclient = HttpClients.custom() .setConnectionManager(cm) .build()) { // create an array of URIs to perform GETs on final String[] urisToGet = { "http://hc.apache.org/", "http://hc.apache.org/httpcomponents-core-ga/", "http://hc.apache.org/httpcomponents-client-ga/", }; // create a thread for each URI final GetThread[] threads = new GetThread[urisToGet.length]; for (int i = 0; i < threads.length; i++) { final HttpGet httpget = new HttpGet(urisToGet[i]); threads[i] = new GetThread(httpclient, httpget, i + 1); } // start the threads for (final GetThread thread : threads) { thread.start(); } // join the threads for (final GetThread thread : threads) { thread.join(); } } } /** * A thread that performs a GET. */ static class GetThread extends Thread { private final CloseableHttpClient httpClient; private final HttpContext context; private final HttpGet httpget; private final int id; public GetThread(final CloseableHttpClient httpClient, final HttpGet httpget, final int id) { this.httpClient = httpClient; this.context = HttpClientContext.create(); this.httpget = httpget; this.id = id; } /** * Executes the GetMethod and prints some status information. */ @Override public void run() { try { System.out.println(id + " - about to get something from " + httpget.getUri()); this.httpClient.execute(httpget, response -> { System.out.println(id + " - get executed"); // get the response body as an array of bytes final HttpEntity entity = response.getEntity(); if (entity != null) { final byte[] bytes = EntityUtils.toByteArray(entity); System.out.println(id + " - " + bytes.length + " bytes read"); } return null; }); } catch (final Exception e) { System.out.println(id + " - error: " + e); } } } } ././@LongLink0100644 0000000 0000000 00000000150 14666635064 011647 Lustar 0000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientPreemptiveDigestAuthentication.javahttpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientPreemptiveDigestAuthentication.j0100664 0000000 0000000 00000010020 14666635064 033006 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import org.apache.hc.client5.http.ContextBuilder; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.auth.CredentialsProviderBuilder; import org.apache.hc.client5.http.impl.auth.DigestScheme; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; /** * An example of how HttpClient can authenticate multiple requests * using the same Digest scheme. After the initial request / response exchange * all subsequent requests sharing the same execution context can re-use * the last Digest nonce value to authenticate with the server. */ public class ClientPreemptiveDigestAuthentication { public static void main(final String[] args) throws Exception { try (final CloseableHttpClient httpclient = HttpClients.createDefault()) { final HttpHost target = new HttpHost("http", "httpbin.org", 80); final HttpClientContext localContext = ContextBuilder.create() .useCredentialsProvider(CredentialsProviderBuilder.create() .add(target, new UsernamePasswordCredentials("user", "passwd".toCharArray())) .build()) .build(); final HttpGet httpget = new HttpGet("http://httpbin.org/digest-auth/auth/user/passwd"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); for (int i = 0; i < 3; i++) { httpclient.execute(httpget, localContext, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); final AuthExchange authExchange = localContext.getAuthExchange(target); if (authExchange != null) { final AuthScheme authScheme = authExchange.getAuthScheme(); if (authScheme instanceof DigestScheme) { final DigestScheme digestScheme = (DigestScheme) authScheme; System.out.println("Nonce: " + digestScheme.getNonce() + "; count: " + digestScheme.getNounceCount()); } } return null; }); } } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientAuthentication.java0100664 0000000 0000000 00000007336 14666635064 031313 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.auth.CredentialsProviderBuilder; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.io.CloseMode; /** * A simple example that uses HttpClient to execute an HTTP request against * a target site that requires user authentication. */ public class AsyncClientAuthentication { public static void main(final String[] args) throws Exception { final CloseableHttpAsyncClient httpclient = HttpAsyncClients.custom() .setDefaultCredentialsProvider(CredentialsProviderBuilder.create() .add(new HttpHost("httpbin.org", 80), "user", "passwd".toCharArray()) .build()) .build(); httpclient.start(); final SimpleHttpRequest request = SimpleRequestBuilder.get("http://httpbin.org/basic-auth/user/passwd") .build(); System.out.println("Executing request " + request); final Future future = httpclient.execute( SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(request + "->" + new StatusLine(response)); System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { System.out.println(request + "->" + ex); } @Override public void cancelled() { System.out.println(request + " cancelled"); } }); future.get(); System.out.println("Shutting down"); httpclient.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientAuthentication.java0100664 0000000 0000000 00000005243 14666635064 030310 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.auth.CredentialsProviderBuilder; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; /** * A simple example that uses HttpClient to execute an HTTP request against * a target site that requires user authentication. */ public class ClientAuthentication { public static void main(final String[] args) throws Exception { try (final CloseableHttpClient httpclient = HttpClients.custom() .setDefaultCredentialsProvider(CredentialsProviderBuilder.create() .add(new HttpHost("httpbin.org", 80), "user", "passwd".toCharArray()) .build()) .build()) { final HttpGet httpget = new HttpGet("http://httpbin.org/basic-auth/user/passwd"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); httpclient.execute(httpget, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientExecuteProxy.java0100664 0000000 0000000 00000005270 14743175562 027773 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; /** * How to send a request via proxy. * * @since 4.0 */ public class ClientExecuteProxy { public static void main(final String[] args)throws Exception { final HttpHost target = new HttpHost("https", "httpbin.org", 443); final HttpHost proxy = new HttpHost("http", "127.0.0.1", 8080); try (final CloseableHttpClient httpclient = HttpClients.custom() .setProxy(proxy) .build()) { final RequestConfig config = RequestConfig.custom() .build(); final HttpGet request = new HttpGet("/get"); request.setConfig(config); System.out.println("Executing request " + request.getMethod() + " " + request.getUri() + " via " + proxy); httpclient.execute(target, request, response -> { System.out.println("----------------------------------------"); System.out.println(request + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientConfiguration.java0100664 0000000 0000000 00000030554 14753734441 030137 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.net.InetAddress; import java.net.UnknownHostException; import java.nio.charset.CodingErrorAction; import java.nio.charset.StandardCharsets; import java.util.Arrays; import java.util.Collections; import javax.net.ssl.SSLContext; import org.apache.hc.client5.http.ContextBuilder; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SystemDefaultDnsResolver; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.cookie.StandardCookieSpec; import org.apache.hc.client5.http.impl.auth.CredentialsProviderBuilder; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.impl.io.ManagedHttpClientConnectionFactory; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.config.CharCodingConfig; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.impl.io.DefaultClassicHttpResponseFactory; import org.apache.hc.core5.http.impl.io.DefaultHttpRequestWriterFactory; import org.apache.hc.core5.http.impl.io.DefaultHttpResponseParser; import org.apache.hc.core5.http.impl.io.DefaultHttpResponseParserFactory; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.HttpMessageParser; import org.apache.hc.core5.http.io.HttpMessageParserFactory; import org.apache.hc.core5.http.io.HttpMessageWriterFactory; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicLineParser; import org.apache.hc.core5.http.message.LineParser; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.pool.PoolConcurrencyPolicy; import org.apache.hc.core5.pool.PoolReusePolicy; import org.apache.hc.core5.ssl.SSLContexts; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * This example demonstrates how to customize and configure the most common aspects * of HTTP request execution and connection management. */ public class ClientConfiguration { public final static void main(final String[] args) throws Exception { // Create HTTP/1.1 protocol configuration final Http1Config h1Config = Http1Config.custom() .setMaxHeaderCount(200) .setMaxLineLength(2000) .build(); // Use custom message parser / writer to customize the way HTTP // messages are parsed from and written out to the data stream. final HttpMessageParserFactory responseParserFactory = new DefaultHttpResponseParserFactory() { @Override public HttpMessageParser create() { final LineParser lineParser = new BasicLineParser() { @Override public Header parseHeader(final CharArrayBuffer buffer) { try { return super.parseHeader(buffer); } catch (final ParseException ex) { return new BasicHeader(buffer.toString(), null); } } }; return new DefaultHttpResponseParser(h1Config, lineParser, DefaultClassicHttpResponseFactory.INSTANCE); } }; final HttpMessageWriterFactory requestWriterFactory = new DefaultHttpRequestWriterFactory(); // Create char coding configuration final CharCodingConfig charCodingConfig = CharCodingConfig.custom() .setMalformedInputAction(CodingErrorAction.IGNORE) .setUnmappableInputAction(CodingErrorAction.IGNORE) .setCharset(StandardCharsets.UTF_8) .build(); // Use a custom connection factory to customize the process of // initialization of outgoing HTTP connections. Beside standard connection // configuration parameters HTTP connection factory can define message // parser / writer routines to be employed by individual connections. final HttpConnectionFactory connFactory = new ManagedHttpClientConnectionFactory( h1Config, charCodingConfig, requestWriterFactory, responseParserFactory); // Client HTTP connection objects when fully initialized can be bound to // an arbitrary network socket. The process of network socket initialization, // its connection to a remote address and binding to a local one is controlled // by a connection socket factory. // SSL context for secure connections can be created either based on // system or application specific properties. final SSLContext sslContext = SSLContexts.createSystemDefault(); // Create a registry of custom connection socket factories for supported // protocol schemes. final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy(sslContext); // Use custom DNS resolver to override the system DNS resolution. final DnsResolver dnsResolver = new SystemDefaultDnsResolver() { @Override public InetAddress[] resolve(final String host) throws UnknownHostException { if (host.equalsIgnoreCase("myhost")) { return new InetAddress[] { InetAddress.getByAddress(new byte[] {127, 0, 0, 1}) }; } return super.resolve(host); } }; // Create a connection manager with custom configuration. final PoolingHttpClientConnectionManager connManager = PoolingHttpClientConnectionManagerBuilder.create() .setTlsSocketStrategy(tlsStrategy) .setConnectionFactory(connFactory) .setDnsResolver(dnsResolver) .setPoolConcurrencyPolicy(PoolConcurrencyPolicy.STRICT) .setConnPoolPolicy(PoolReusePolicy.LIFO) .build(); // Configure the connection manager to use socket configuration either // by default or for a specific host. connManager.setDefaultSocketConfig(SocketConfig.custom() .setTcpNoDelay(true) .build()); // Validate connections after 10 sec of inactivity connManager.setDefaultConnectionConfig(ConnectionConfig.custom() .setConnectTimeout(Timeout.ofSeconds(30)) .setSocketTimeout(Timeout.ofSeconds(30)) .setValidateAfterInactivity(TimeValue.ofSeconds(10)) .setTimeToLive(TimeValue.ofHours(1)) .build()); // Use TLS v1.3 only connManager.setDefaultTlsConfig(TlsConfig.custom() .setHandshakeTimeout(Timeout.ofSeconds(30)) .setSupportedProtocols(TLS.V_1_3) .build()); // Configure total max or per route limits for persistent connections // that can be kept in the pool or leased by the connection manager. connManager.setMaxTotal(100); connManager.setDefaultMaxPerRoute(10); connManager.setMaxPerRoute(new HttpRoute(new HttpHost("somehost", 80)), 20); // Use custom cookie store if necessary. final CookieStore cookieStore = new BasicCookieStore(); // Use custom credentials provider if necessary. final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .build(); // Create global request configuration final RequestConfig defaultRequestConfig = RequestConfig.custom() .setCookieSpec(StandardCookieSpec.STRICT) .setExpectContinueEnabled(true) .setTargetPreferredAuthSchemes(Arrays.asList(StandardAuthScheme.DIGEST)) .setProxyPreferredAuthSchemes(Collections.singletonList(StandardAuthScheme.BASIC)) .build(); // Create an HttpClient with the given custom dependencies and configuration. try (final CloseableHttpClient httpclient = HttpClients.custom() .setConnectionManager(connManager) .setDefaultCookieStore(cookieStore) .setDefaultCredentialsProvider(credentialsProvider) .setProxy(new HttpHost("myproxy", 8080)) .setDefaultRequestConfig(defaultRequestConfig) .build()) { final HttpGet httpget = new HttpGet("http://httpbin.org/get"); // Request configuration can be overridden at the request level. // They will take precedence over the one set at the client level. final RequestConfig requestConfig = RequestConfig.copy(defaultRequestConfig) .setConnectionRequestTimeout(Timeout.ofSeconds(5)) .build(); httpget.setConfig(requestConfig); // Execution context can be customized locally. // Contextual attributes set the local context level will take // precedence over those set at the client level. final HttpClientContext context = ContextBuilder.create() .useCookieStore(cookieStore) .useCredentialsProvider(credentialsProvider) .build(); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); httpclient.execute(httpget, context, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); // Last executed request context.getRequest(); // Execution route context.getHttpRoute(); // Auth exchanges context.getAuthExchanges(); // Cookie origin context.getCookieOrigin(); // Cookie spec used context.getCookieSpec(); // User security token context.getUserToken(); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientHttp1Pipelining.java0100664 0000000 0000000 00000012154 14666635064 031345 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.CountDownLatch; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.async.MinimalHttpAsyncClient; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.AsyncClientEndpoint; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.IOReactorConfig; /** * This example demonstrates pipelined execution of multiple HTTP/1.1 message exchanges. */ public class AsyncClientHttp1Pipelining { public static void main(final String[] args) throws Exception { final MinimalHttpAsyncClient client = HttpAsyncClients.createMinimal( H2Config.DEFAULT, Http1Config.DEFAULT, IOReactorConfig.DEFAULT, PoolingAsyncClientConnectionManagerBuilder.create() .setDefaultTlsConfig(TlsConfig.custom() .setVersionPolicy(HttpVersionPolicy.FORCE_HTTP_1) .build()) .build()); client.start(); final HttpHost target = new HttpHost("httpbin.org"); final Future leaseFuture = client.lease(target, null); final AsyncClientEndpoint endpoint = leaseFuture.get(30, TimeUnit.SECONDS); try { final String[] requestUris = new String[] {"/", "/ip", "/user-agent", "/headers"}; final CountDownLatch latch = new CountDownLatch(requestUris.length); for (final String requestUri: requestUris) { final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath(requestUri) .build(); System.out.println("Executing request " + request); endpoint.execute( SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { latch.countDown(); System.out.println(request + "->" + new StatusLine(response)); System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { latch.countDown(); System.out.println(request + "->" + ex); } @Override public void cancelled() { latch.countDown(); System.out.println(request + " cancelled"); } }); } latch.await(); } finally { endpoint.releaseAndReuse(); } System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientFullDuplexExchange.java0100664 0000000 0000000 00000013750 14704162040 032036 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.CountDownLatch; import java.util.concurrent.TimeUnit; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.async.MinimalHttpAsyncClient; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityProducer; import org.apache.hc.core5.http.nio.entity.StringAsyncEntityConsumer; import org.apache.hc.core5.http.nio.support.BasicRequestProducer; import org.apache.hc.core5.http.nio.support.BasicResponseConsumer; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.IOReactorConfig; /** * This example demonstrates a full-duplex, streaming HTTP/1.1 message exchange. */ public class AsyncClientFullDuplexExchange { public static void main(final String[] args) throws Exception { final MinimalHttpAsyncClient client = HttpAsyncClients.createMinimal( H2Config.DEFAULT, Http1Config.DEFAULT, IOReactorConfig.DEFAULT); client.start(); final BasicHttpRequest request = BasicRequestBuilder.post("http://httpbin.org/post").build(); final BasicRequestProducer requestProducer = new BasicRequestProducer(request, new BasicAsyncEntityProducer("stuff", ContentType.TEXT_PLAIN)); final BasicResponseConsumer responseConsumer = new BasicResponseConsumer<>( new StringAsyncEntityConsumer()); System.out.println("Executing request " + request); final CountDownLatch latch = new CountDownLatch(1); client.execute(new AsyncClientExchangeHandler() { @Override public void releaseResources() { requestProducer.releaseResources(); responseConsumer.releaseResources(); latch.countDown(); } @Override public void cancel() { System.out.println(request + " cancelled"); } @Override public void failed(final Exception cause) { System.out.println(request + "->" + cause); } @Override public void produceRequest(final RequestChannel channel, final HttpContext context) throws HttpException, IOException { requestProducer.sendRequest(channel, context); } @Override public int available() { return requestProducer.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { requestProducer.produce(channel); } @Override public void consumeInformation( final HttpResponse response, final HttpContext context) { System.out.println(request + "->" + new StatusLine(response)); } @Override public void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { System.out.println(request + "->" + new StatusLine(response)); responseConsumer.consumeResponse(response, entityDetails, context, null); } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { responseConsumer.updateCapacity(capacityChannel); } @Override public void consume(final ByteBuffer src) throws IOException { responseConsumer.consume(src); } @Override public void streamEnd(final List trailers) throws HttpException, IOException { responseConsumer.streamEnd(trailers); } }); latch.await(1, TimeUnit.MINUTES); System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientClassicOverAsync.java0100664 0000000 0000000 00000006703 15005672016 030530 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.io.BufferedReader; import java.io.InputStreamReader; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.core5.annotation.Experimental; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.util.Timeout; /** * This example demonstrates create an {@link CloseableHttpClient} adaptor over * {@link CloseableHttpAsyncClient} providing compatibility with the classic APIs * based on the {@link java.io.InputStream} / {@link java.io.OutputStream} model */ @Experimental public class ClientClassicOverAsync { public static void main(final String[] args) throws Exception { try (final CloseableHttpClient httpclient = HttpAsyncClients.classic( HttpAsyncClients.createDefault(), Timeout.ofMinutes(1))) { final HttpGet httpget = new HttpGet("http://httpbin.org/get"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); httpclient.execute(httpget, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); final HttpEntity entity = response.getEntity(); if (entity != null) { final ContentType contentType = ContentType.parseLenient(entity.getContentType()); final Charset charset = ContentType.getCharset(contentType, StandardCharsets.UTF_8); try (BufferedReader reader = new BufferedReader(new InputStreamReader(entity.getContent(), charset))) { String line; while ((line = reader.readLine()) != null) { System.out.println(line); } } } return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientCustomContext.java0100664 0000000 0000000 00000006356 14740224000 030127 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.List; import org.apache.hc.client5.http.ContextBuilder; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; /** * This example demonstrates the use of a local HTTP context populated with * custom attributes. */ public class ClientCustomContext { public static void main(final String[] args) throws Exception { try (final CloseableHttpClient httpclient = HttpClients.createDefault()) { // Create a local instance of cookie store final CookieStore cookieStore = new BasicCookieStore(); // Create local HTTP context final HttpClientContext localContext = ContextBuilder.create() // Bind custom cookie store to the local context .useCookieStore(cookieStore) .build(); final HttpGet httpget = new HttpGet("http://httpbin.org/cookies"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); // Pass local context as a parameter httpclient.execute(httpget, localContext, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); final List cookies = cookieStore.getCookies(); for (int i = 0; i < cookies.size(); i++) { System.out.println("Local cookie: " + cookies.get(i)); } EntityUtils.consume(response.getEntity()); return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientCustomPublicSuffixList.java0100664 0000000 0000000 00000010553 14704162040 031741 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.net.URL; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.StandardCookieSpec; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.impl.cookie.RFC6265CookieSpecFactory; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.apache.hc.client5.http.psl.PublicSuffixMatcherLoader; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.http.ssl.DefaultHostnameVerifier; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.ssl.SSLContexts; /** * This example demonstrates how to use a custom public suffix list. */ public class ClientCustomPublicSuffixList { public static void main(final String[] args) throws Exception { // Use PublicSuffixMatcherLoader to load public suffix list from a file, // resource or from an arbitrary URL final PublicSuffixMatcher publicSuffixMatcher = PublicSuffixMatcherLoader.load( new URL("https://publicsuffix.org/list/effective_tld_names.dat")); // Please use the publicsuffix.org URL to download the list no more than once per day !!! // Please consider making a local copy !!! final RFC6265CookieSpecFactory cookieSpecFactory = new RFC6265CookieSpecFactory(publicSuffixMatcher); final Lookup cookieSpecRegistry = RegistryBuilder.create() .register(StandardCookieSpec.RELAXED, cookieSpecFactory) .register(StandardCookieSpec.STRICT, cookieSpecFactory) .build(); final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy( SSLContexts.createDefault(), new DefaultHostnameVerifier(publicSuffixMatcher)); final HttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create() .setTlsSocketStrategy(tlsStrategy) .build(); try (final CloseableHttpClient httpclient = HttpClients.custom() .setConnectionManager(cm) .setDefaultCookieSpecRegistry(cookieSpecRegistry) .build()) { final HttpGet httpget = new HttpGet("https://httpbin.org/get"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); httpclient.execute(httpget, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientCustomSSL.java0100664 0000000 0000000 00000011473 14704162040 027145 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.security.cert.X509Certificate; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.ssl.SSLContexts; import org.apache.hc.core5.util.Timeout; /** * This example demonstrates how to create secure connections with a custom SSL * context. */ public class ClientCustomSSL { public final static void main(final String[] args) throws Exception { // Trust standard CA and those trusted by our custom strategy final SSLContext sslContext = SSLContexts.custom() // Custom TrustStrategy implementations are intended for verification // of certificates whose CA is not trusted by the system, and where specifying // a custom truststore containing the certificate chain is not an option. .loadTrustMaterial((chain, authType) -> { // Please note that validation of the server certificate without validation // of the entire certificate chain in this example is preferred to completely // disabling trust verification, however this still potentially allows // for man-in-the-middle attacks. final X509Certificate cert = chain[0]; return "CN=httpbin.org".equalsIgnoreCase(cert.getSubjectDN().getName()); }) .build(); final TlsSocketStrategy tlsStrategy = new DefaultClientTlsStrategy(sslContext); // Allow TLSv1.3 protocol only final HttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create() .setTlsSocketStrategy(tlsStrategy) .setDefaultTlsConfig(TlsConfig.custom() .setHandshakeTimeout(Timeout.ofSeconds(30)) .setSupportedProtocols(TLS.V_1_3) .build()) .build(); try (CloseableHttpClient httpclient = HttpClients.custom() .setConnectionManager(cm) .build()) { final HttpGet httpget = new HttpGet("https://httpbin.org/"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); final HttpClientContext clientContext = HttpClientContext.create(); httpclient.execute(httpget, clientContext, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); final SSLSession sslSession = clientContext.getSSLSession(); if (sslSession != null) { System.out.println("SSL protocol " + sslSession.getProtocol()); System.out.println("SSL cipher suite " + sslSession.getCipherSuite()); } return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientH2FullDuplexExchange.java0100664 0000000 0000000 00000015201 15005672016 032225 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.io.IOException; import java.nio.ByteBuffer; import java.util.List; import java.util.concurrent.CountDownLatch; import java.util.concurrent.TimeUnit; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.async.MinimalHttpAsyncClient; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler; import org.apache.hc.core5.http.nio.CapacityChannel; import org.apache.hc.core5.http.nio.DataStreamChannel; import org.apache.hc.core5.http.nio.RequestChannel; import org.apache.hc.core5.http.nio.entity.BasicAsyncEntityProducer; import org.apache.hc.core5.http.nio.entity.StringAsyncEntityConsumer; import org.apache.hc.core5.http.nio.support.BasicRequestProducer; import org.apache.hc.core5.http.nio.support.BasicResponseConsumer; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.IOReactorConfig; /** * This example demonstrates a full-duplex, streaming HTTP/2 message exchange. */ public class AsyncClientH2FullDuplexExchange { public static void main(final String[] args) throws Exception { final MinimalHttpAsyncClient client = HttpAsyncClients.createMinimal( H2Config.DEFAULT, Http1Config.DEFAULT, IOReactorConfig.DEFAULT, PoolingAsyncClientConnectionManagerBuilder.create() .setDefaultTlsConfig(TlsConfig.custom() .setVersionPolicy(HttpVersionPolicy.FORCE_HTTP_2) .build()) .build()); client.start(); final HttpHost target = new HttpHost("https", "nghttp2.org"); final BasicHttpRequest request = BasicRequestBuilder.post() .setHttpHost(target) .setPath("/httpbin/post") .build(); final BasicRequestProducer requestProducer = new BasicRequestProducer(request, new BasicAsyncEntityProducer("stuff", ContentType.TEXT_PLAIN)); final BasicResponseConsumer responseConsumer = new BasicResponseConsumer<>( new StringAsyncEntityConsumer()); System.out.println("Executing request " + request); final CountDownLatch latch = new CountDownLatch(1); client.execute(new AsyncClientExchangeHandler() { @Override public void releaseResources() { requestProducer.releaseResources(); responseConsumer.releaseResources(); latch.countDown(); } @Override public void cancel() { System.out.println(request + " cancelled"); } @Override public void failed(final Exception cause) { System.out.println(request + "->" + cause); } @Override public void produceRequest(final RequestChannel channel, final HttpContext context) throws HttpException, IOException { requestProducer.sendRequest(channel, context); } @Override public int available() { return requestProducer.available(); } @Override public void produce(final DataStreamChannel channel) throws IOException { requestProducer.produce(channel); } @Override public void consumeInformation( final HttpResponse response, final HttpContext context) { System.out.println(request + "->" + new StatusLine(response)); } @Override public void consumeResponse( final HttpResponse response, final EntityDetails entityDetails, final HttpContext context) throws HttpException, IOException { System.out.println(request + "->" + new StatusLine(response)); responseConsumer.consumeResponse(response, entityDetails, context, null); } @Override public void updateCapacity(final CapacityChannel capacityChannel) throws IOException { responseConsumer.updateCapacity(capacityChannel); } @Override public void consume(final ByteBuffer src) throws IOException { responseConsumer.consume(src); } @Override public void streamEnd(final List trailers) throws HttpException, IOException { responseConsumer.streamEnd(trailers); } }); latch.await(1, TimeUnit.MINUTES); System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientWithRequestFuture.java0100664 0000000 0000000 00000013124 14666635064 031005 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.CancellationException; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.FutureTask; import java.util.concurrent.TimeUnit; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.FutureRequestExecutionService; import org.apache.hc.client5.http.impl.classic.HttpClientBuilder; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.HttpClientResponseHandler; public class ClientWithRequestFuture { public static void main(final String[] args) throws Exception { // the simplest way to create a HttpAsyncClientWithFuture final HttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create() .setMaxConnPerRoute(5) .setMaxConnTotal(5) .build(); final CloseableHttpClient httpclient = HttpClientBuilder.create() .setConnectionManager(cm) .build(); final ExecutorService execService = Executors.newFixedThreadPool(5); try (final FutureRequestExecutionService requestExecService = new FutureRequestExecutionService( httpclient, execService)) { // Because things are asynchronous, you must provide a HttpClientResponseHandler final HttpClientResponseHandler handler = response -> { // simply return true if the status was OK return response.getCode() == HttpStatus.SC_OK; }; // Simple request ... final HttpGet request1 = new HttpGet("http://httpbin.org/get"); final FutureTask futureTask1 = requestExecService.execute(request1, HttpClientContext.create(), handler); final Boolean wasItOk1 = futureTask1.get(); System.out.println("It was ok? " + wasItOk1); // Cancel a request try { final HttpGet request2 = new HttpGet("http://httpbin.org/get"); final FutureTask futureTask2 = requestExecService.execute(request2, HttpClientContext.create(), handler); futureTask2.cancel(true); final Boolean wasItOk2 = futureTask2.get(); System.out.println("It was cancelled so it should never print this: " + wasItOk2); } catch (final CancellationException e) { System.out.println("We cancelled it, so this is expected"); } // Request with a timeout final HttpGet request3 = new HttpGet("http://httpbin.org/get"); final FutureTask futureTask3 = requestExecService.execute(request3, HttpClientContext.create(), handler); final Boolean wasItOk3 = futureTask3.get(10, TimeUnit.SECONDS); System.out.println("It was ok? " + wasItOk3); final FutureCallback callback = new FutureCallback() { @Override public void completed(final Boolean result) { System.out.println("completed with " + result); } @Override public void failed(final Exception ex) { System.out.println("failed with " + ex.getMessage()); } @Override public void cancelled() { System.out.println("cancelled"); } }; // Simple request with a callback final HttpGet request4 = new HttpGet("http://httpbin.org/get"); // using a null HttpContext here since it is optional // the callback will be called when the task completes, fails, or is cancelled final FutureTask futureTask4 = requestExecService.execute(request4, HttpClientContext.create(), handler, callback); final Boolean wasItOk4 = futureTask4.get(10, TimeUnit.SECONDS); System.out.println("It was ok? " + wasItOk4); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientProxyAuthentication.java0100664 0000000 0000000 00000006474 14666635064 031361 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.auth.CredentialsProviderBuilder; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; /** * A simple example that uses HttpClient to execute an HTTP request * over a secure connection tunneled through an authenticating proxy. */ public class ClientProxyAuthentication { public static void main(final String[] args) throws Exception { final CredentialsProvider credsProvider = CredentialsProviderBuilder.create() .add(new AuthScope("localhost", 8888), "squid", "squid".toCharArray()) .add(new AuthScope("httpbin.org", 80), "user", "passwd".toCharArray()) .build(); final HttpHost target = new HttpHost("http", "httpbin.org", 80); final HttpHost proxy = new HttpHost("localhost", 8888); try (final CloseableHttpClient httpclient = HttpClients.custom() .setProxy(proxy) .setDefaultCredentialsProvider(credsProvider) .build()) { final RequestConfig config = RequestConfig.custom() .build(); final HttpGet httpget = new HttpGet("/basic-auth/user/passwd"); httpget.setConfig(config); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri() + " to " + target + " via " + proxy); httpclient.execute(target, httpget, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientHttpExchangeStreaming.java0100664 0000000 0000000 00000011230 14704162040 032532 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.nio.CharBuffer; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.AbstractCharResponseConsumer; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.support.BasicRequestProducer; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Timeout; /** * Example of asynchronous HTTP/1.1 request execution with response streaming. */ public class AsyncClientHttpExchangeStreaming { public static void main(final String[] args) throws Exception { final IOReactorConfig ioReactorConfig = IOReactorConfig.custom() .setSoTimeout(Timeout.ofSeconds(5)) .build(); final CloseableHttpAsyncClient client = HttpAsyncClients.custom() .setIOReactorConfig(ioReactorConfig) .build(); client.start(); final HttpHost target = new HttpHost("httpbin.org"); final String[] requestUris = new String[] {"/", "/ip", "/user-agent", "/headers"}; for (final String requestUri: requestUris) { final BasicHttpRequest request = BasicRequestBuilder.get() .setHttpHost(target) .setPath(requestUri) .build(); System.out.println("Executing request " + request); final Future future = client.execute( new BasicRequestProducer(request, null), new AbstractCharResponseConsumer() { @Override protected void start( final HttpResponse response, final ContentType contentType) { System.out.println(request + "->" + new StatusLine(response)); } @Override protected int capacityIncrement() { return Integer.MAX_VALUE; } @Override protected void data(final CharBuffer data, final boolean endOfStream) { while (data.hasRemaining()) { System.out.print(data.get()); } if (endOfStream) { System.out.println(); } } @Override protected Void buildResult() { return null; } @Override public void failed(final Exception cause) { System.out.println(request + "->" + cause); } @Override public void releaseResources() { } }, null); future.get(); } System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientSNI.java0100664 0000000 0000000 00000006242 14704162040 025740 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import javax.net.ssl.SSLPeerUnverifiedException; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; /** * This example demonstrates how to use SNI to send requests to a virtual HTTPS * endpoint using the classic I/O. */ public class ClientSNI { public final static void main(final String[] args) throws Exception { try (CloseableHttpClient httpclient = HttpClients.createSystem()) { final HttpHost target = new HttpHost("https", "www.google.com"); final HttpGet httpget = new HttpGet("https://www.google.ch/"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); final HttpClientContext clientContext = HttpClientContext.create(); httpclient.execute(target, httpget, clientContext, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); final SSLSession sslSession = clientContext.getSSLSession(); if (sslSession != null) { try { System.out.println("Peer: " + sslSession.getPeerPrincipal()); System.out.println("TLS protocol: " + sslSession.getProtocol()); System.out.println("TLS cipher suite: " + sslSession.getCipherSuite()); } catch (final SSLPeerUnverifiedException ignore) { } } return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientInterceptors.java0100664 0000000 0000000 00000010526 14726761115 030004 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.atomic.AtomicLong; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.protocol.HttpContext; /** * This example demonstrates how to insert custom request interceptor and an execution interceptor * to the request execution chain. */ public class ClientInterceptors { public static void main(final String[] args) throws Exception { try (final CloseableHttpClient httpclient = HttpClients.custom() // Add a simple request ID to each outgoing request .addRequestInterceptorFirst(new HttpRequestInterceptor() { private final AtomicLong count = new AtomicLong(0); @Override public void process( final HttpRequest request, final EntityDetails entity, final HttpContext context) { request.setHeader("request-id", Long.toString(count.incrementAndGet())); } }) // Simulate a 404 response for some requests without passing the message down to the backend .addExecInterceptorAfter(ChainElement.PROTOCOL.name(), "custom", (request, scope, chain) -> { final Header idHeader = request.getFirstHeader("request-id"); if (idHeader != null && "13".equalsIgnoreCase(idHeader.getValue())) { final ClassicHttpResponse response = new BasicClassicHttpResponse(HttpStatus.SC_NOT_FOUND, "Oppsie"); response.setEntity(new StringEntity("bad luck", ContentType.TEXT_PLAIN)); return response; } return chain.proceed(request, scope); }) .build()) { for (int i = 0; i < 20; i++) { final HttpGet httpget = new HttpGet("http://httpbin.org/get"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); httpclient.execute(httpget, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); } } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientMultipartFormPost.java0100664 0000000 0000000 00000006201 15005672035 030762 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.io.File; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.entity.mime.FileBody; import org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder; import org.apache.hc.client5.http.entity.mime.StringBody; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.message.StatusLine; /** * Example how to use multipart/form encoded POST request. */ public class ClientMultipartFormPost { public static void main(final String[] args) throws Exception { if (args.length != 1) { System.out.println("File path not given"); System.exit(1); } try (final CloseableHttpClient httpclient = HttpClients.createDefault()) { final HttpPost httppost = new HttpPost("http://httpbin.org/post"); final FileBody bin = new FileBody(new File(args[0])); final StringBody comment = new StringBody("A binary file of some kind", ContentType.TEXT_PLAIN); final HttpEntity reqEntity = MultipartEntityBuilder.create() .addPart("bin", bin) .addPart("comment", comment) .build(); httppost.setEntity(reqEntity); System.out.println("executing request " + httppost); httpclient.execute(httppost, response -> { System.out.println("----------------------------------------"); System.out.println(httppost + "->" + new StatusLine(response)); final HttpEntity resEntity = response.getEntity(); if (resEntity != null) { resEntity.writeTo(System.out); } System.out.flush(); return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientH2Multiplexing.java0100664 0000000 0000000 00000015040 15005672016 031160 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.CountDownLatch; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManager; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Timeout; /** * Example of asynchronous HTTP/1.1 request execution with message exchange multiplexing * over HTTP/2 connections. */ public class AsyncClientH2Multiplexing { public static void main(final String[] args) throws Exception { final IOReactorConfig ioReactorConfig = IOReactorConfig.custom() .setSoTimeout(Timeout.ofSeconds(5)) .build(); final PoolingAsyncClientConnectionManager connectionManager = PoolingAsyncClientConnectionManagerBuilder.create() .setDefaultTlsConfig(TlsConfig.custom() .setVersionPolicy(HttpVersionPolicy.FORCE_HTTP_2) .build()) .setMessageMultiplexing(true) .build(); final CloseableHttpAsyncClient client = HttpAsyncClients.custom() .setConnectionManager(connectionManager) .setIOReactorConfig(ioReactorConfig) .build(); client.start(); final HttpHost target = new HttpHost("https", "nghttp2.org"); final SimpleHttpRequest warmup = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/httpbin") .build(); // Make sure there is an open HTTP/2 connection in the pool System.out.println("Executing warm-up request " + warmup); final Future future = client.execute( SimpleRequestProducer.create(warmup), SimpleResponseConsumer.create(), new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(warmup + "->" + new StatusLine(response)); System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { System.out.println(warmup + "->" + ex); } @Override public void cancelled() { System.out.println(warmup + " cancelled"); } }); future.get(); Thread.sleep(1000); System.out.println("Connection pool stats: " + connectionManager.getTotalStats()); // Execute multiple requests over the HTTP/2 connection from the pool final String[] requestUris = new String[]{"/httpbin", "/httpbin/ip", "/httpbin/user-agent", "/httpbin/headers"}; final CountDownLatch countDownLatch = new CountDownLatch(requestUris.length); for (final String requestUri : requestUris) { final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath(requestUri) .build(); System.out.println("Executing request " + request); client.execute( SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { countDownLatch.countDown(); System.out.println(request + "->" + new StatusLine(response)); System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { countDownLatch.countDown(); System.out.println(request + "->" + ex); } @Override public void cancelled() { countDownLatch.countDown(); System.out.println(request + " cancelled"); } }); } countDownLatch.await(); // There still should be a single connection in the pool System.out.println("Connection pool stats: " + connectionManager.getTotalStats()); System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientEvictExpiredConnections.java0100664 0000000 0000000 00000006770 14666635064 032135 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.pool.PoolStats; import org.apache.hc.core5.util.TimeValue; /** * Example demonstrating how to evict expired and idle connections * from the connection pool. */ public class ClientEvictExpiredConnections { public static void main(final String[] args) throws Exception { final PoolingHttpClientConnectionManager cm = new PoolingHttpClientConnectionManager(); cm.setMaxTotal(100); try (final CloseableHttpClient httpclient = HttpClients.custom() .setConnectionManager(cm) .evictExpiredConnections() .evictIdleConnections(TimeValue.ofSeconds(5)) .build()) { // create an array of URIs to perform GETs on final String[] urisToGet = { "http://hc.apache.org/", "http://hc.apache.org/httpcomponents-core-ga/", "http://hc.apache.org/httpcomponents-client-ga/", }; for (final String requestURI : urisToGet) { final HttpGet request = new HttpGet(requestURI); System.out.println("Executing request " + request.getMethod() + " " + request.getRequestUri()); httpclient.execute(request, response -> { System.out.println("----------------------------------------"); System.out.println(request + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); } final PoolStats stats1 = cm.getTotalStats(); System.out.println("Connections kept alive: " + stats1.getAvailable()); // Sleep 10 sec and let the connection evictor do its job Thread.sleep(10000); final PoolStats stats2 = cm.getTotalStats(); System.out.println("Connections kept alive: " + stats2.getAvailable()); } } } ././@LongLink0100644 0000000 0000000 00000000154 14666635064 011653 Lustar 0000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncPreemptiveBasicClientAuthentication.javahttpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncPreemptiveBasicClientAuthenticati0100664 0000000 0000000 00000010031 14666635064 033023 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.Future; import org.apache.hc.client5.http.ContextBuilder; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.io.CloseMode; /** * A simple example that uses HttpClient to execute an HTTP request against * a target site that requires user authentication. */ public class AsyncPreemptiveBasicClientAuthentication { public static void main(final String[] args) throws Exception { final CloseableHttpAsyncClient httpclient = HttpAsyncClients.createDefault(); httpclient.start(); final HttpClientContext localContext = ContextBuilder.create() .preemptiveBasicAuth(new HttpHost("http", "httpbin.org"), new UsernamePasswordCredentials("user", "passwd".toCharArray())) .build(); final SimpleHttpRequest request = SimpleRequestBuilder.get("http://httpbin.org:80/basic-auth/user/passwd") .build(); System.out.println("Executing request " + request); for (int i = 0; i < 3; i++) { final Future future = httpclient.execute( SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), localContext, new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(request + "->" + new StatusLine(response)); System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { System.out.println(request + "->" + ex); } @Override public void cancelled() { System.out.println(request + " cancelled"); } }); future.get(); } System.out.println("Shutting down"); httpclient.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientHttpExchange.java0100664 0000000 0000000 00000007753 14720575470 030714 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Timeout; /** * Example of asynchronous HTTP/1.1 request execution. */ public class AsyncClientHttpExchange { public static void main(final String[] args) throws Exception { final IOReactorConfig ioReactorConfig = IOReactorConfig.custom() .setSoTimeout(Timeout.ofSeconds(5)) .build(); final CloseableHttpAsyncClient client = HttpAsyncClients.custom() .setIOReactorConfig(ioReactorConfig) .build(); client.start(); final HttpHost target = new HttpHost("httpbin.org"); final String[] requestUris = new String[] {"/", "/ip", "/user-agent", "/headers"}; for (final String requestUri: requestUris) { final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath(requestUri) .build(); System.out.println("Executing request " + request); final Future future = client.execute( SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(request + "->" + new StatusLine(response)); System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { System.out.println(request + "->" + ex); } @Override public void cancelled() { System.out.println(request + " cancelled"); } }); future.get(); } System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientSNI.java0100664 0000000 0000000 00000010707 14704162040 026737 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.Future; import javax.net.ssl.SSLPeerUnverifiedException; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.io.CloseMode; /** * This example demonstrates how to use SNI to send requests to a virtual HTTPS * endpoint using the async I/O. */ public class AsyncClientSNI { public static void main(final String[] args) throws Exception { try (final CloseableHttpAsyncClient client = HttpAsyncClients.createSystem()) { client.start(); final HttpHost target = new HttpHost("https", "www.google.com"); final SimpleHttpRequest request = SimpleRequestBuilder.get() .setUri("https://www.google.ch/") .build(); final HttpClientContext clientContext = HttpClientContext.create(); System.out.println("Executing request " + request); final Future future = client.execute( target, SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), null, clientContext, new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(request + "->" + new StatusLine(response)); final SSLSession sslSession = clientContext.getSSLSession(); if (sslSession != null) { try { System.out.println("Peer: " + sslSession.getPeerPrincipal()); System.out.println("TLS protocol: " + sslSession.getProtocol()); System.out.println("TLS cipher suite: " + sslSession.getCipherSuite()); } catch (final SSLPeerUnverifiedException ignore) { } } } @Override public void failed(final Exception ex) { System.out.println(request + "->" + ex); } @Override public void cancelled() { System.out.println(request + " cancelled"); } }); future.get(); System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientConnectionConfig.java0100664 0000000 0000000 00000011321 15005672016 030532 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * This example demonstrates how to use connection configuration on a per-route or a per-host * basis. */ public class ClientConnectionConfig { public final static void main(final String[] args) throws Exception { final PoolingHttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create() .setConnectionConfigResolver(route -> { // Use different settings for all secure (TLS) connections if (route.isSecure()) { return ConnectionConfig.custom() .setConnectTimeout(Timeout.ofMinutes(2)) .setSocketTimeout(Timeout.ofMinutes(2)) .setValidateAfterInactivity(TimeValue.ofMinutes(1)) .setTimeToLive(TimeValue.ofHours(1)) .build(); } return ConnectionConfig.custom() .setConnectTimeout(Timeout.ofMinutes(1)) .setSocketTimeout(Timeout.ofMinutes(1)) .setValidateAfterInactivity(TimeValue.ofSeconds(15)) .setTimeToLive(TimeValue.ofMinutes(15)) .build(); }) .setTlsConfigResolver(host -> { // Use different settings for specific hosts if (host.getSchemeName().equalsIgnoreCase("httpbin.org")) { return TlsConfig.custom() .setSupportedProtocols(TLS.V_1_3) .setHandshakeTimeout(Timeout.ofSeconds(10)) .build(); } return TlsConfig.DEFAULT; }) .build(); try (CloseableHttpClient httpclient = HttpClients.custom() .setConnectionManager(cm) .build()) { for (final URIScheme uriScheme : URIScheme.values()) { final ClassicHttpRequest request = ClassicRequestBuilder.get() .setHttpHost(new HttpHost(uriScheme.id, "httpbin.org")) .setPath("/headers") .build(); System.out.println("Executing request " + request); httpclient.execute(request, response -> { System.out.println("----------------------------------------"); System.out.println(request + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); } } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientRemoteEndpointDetails.java0100664 0000000 0000000 00000010663 14704162040 031553 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpHead; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.EndpointDetails; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; /** * This example demonstrates how to get details of the underlying connection endpoint. */ public class ClientRemoteEndpointDetails { public static void main(final String[] args) throws Exception { try (final CloseableHttpClient httpclient = HttpClients.createDefault()) { // Create local HTTP context final HttpClientContext localContext = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://httpbin.org/get"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); // Pass local context as a parameter httpclient.execute(httpget, localContext, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); final EndpointDetails endpointDetails = localContext.getEndpointDetails(); System.out.println("Remote address: " + endpointDetails.getRemoteAddress()); System.out.println("Request counts: " + endpointDetails.getRequestCount()); System.out.println("Response counts: " + endpointDetails.getResponseCount()); System.out.println("Bytes sent: " + endpointDetails.getSentBytesCount()); System.out.println("Bytes received: " + endpointDetails.getReceivedBytesCount()); return null; }); // EndpointDetails is present in the context even if the underlying connection // gets immediately released back to the connection pool final HttpHead httphead = new HttpHead("http://httpbin.org/get"); System.out.println("Executing request " + httphead.getMethod() + " " + httphead.getUri()); // Pass local context as a parameter httpclient.execute(httphead, localContext, response -> { System.out.println("----------------------------------------"); System.out.println(httphead + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); final EndpointDetails endpointDetails = localContext.getEndpointDetails(); System.out.println("Remote address: " + endpointDetails.getRemoteAddress()); System.out.println("Request counts: " + endpointDetails.getRequestCount()); System.out.println("Response counts: " + endpointDetails.getResponseCount()); System.out.println("Bytes sent: " + endpointDetails.getSentBytesCount()); System.out.println("Bytes received: " + endpointDetails.getReceivedBytesCount()); return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ReactiveClientFullDuplexExchange.java0100664 0000000 0000000 00000007740 15063503632 032532 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.net.URI; import java.nio.ByteBuffer; import java.nio.charset.StandardCharsets; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.async.MinimalHttpAsyncClient; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.Message; import org.apache.hc.core5.http.config.Http1Config; import org.apache.hc.core5.http.nio.support.BasicRequestProducer; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactive.ReactiveEntityProducer; import org.apache.hc.core5.reactive.ReactiveResponseConsumer; import org.apache.hc.core5.reactor.IOReactorConfig; import org.reactivestreams.Publisher; import io.reactivex.Flowable; import io.reactivex.Observable; /** * This example demonstrates a reactive, full-duplex HTTP/1.1 message exchange using RxJava. */ public class ReactiveClientFullDuplexExchange { public static void main(final String[] args) throws Exception { final MinimalHttpAsyncClient client = HttpAsyncClients.createMinimal( H2Config.DEFAULT, Http1Config.DEFAULT, IOReactorConfig.DEFAULT); client.start(); final URI requestUri = new URI("http://httpbin.org/post"); final byte[] bs = "stuff".getBytes(StandardCharsets.UTF_8); final ReactiveEntityProducer reactiveEntityProducer = new ReactiveEntityProducer( Flowable.just(ByteBuffer.wrap(bs)), bs.length, ContentType.TEXT_PLAIN, null); final BasicRequestProducer requestProducer = new BasicRequestProducer( "POST", requestUri, reactiveEntityProducer); final ReactiveResponseConsumer consumer = new ReactiveResponseConsumer(); final Future requestFuture = client.execute(requestProducer, consumer, null); final Message> streamingResponse = consumer.getResponseFuture().get(); System.out.println(streamingResponse.getHead()); for (final Header header : streamingResponse.getHead().getHeaders()) { System.out.println(header); } System.out.println(); Observable.fromPublisher(streamingResponse.getBody()) .map(byteBuffer -> { final byte[] string = new byte[byteBuffer.remaining()]; byteBuffer.get(string); return new String(string); }) .materialize() .forEach(System.out::println); requestFuture.get(1, TimeUnit.MINUTES); System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientMessageTrailers.java0100664 0000000 0000000 00000010645 14666635064 031423 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.entity.DigestingEntityProducer; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Timeout; /** * This example demonstrates how to use a custom execution interceptor * to add trailers to all outgoing request enclosing an entity. */ public class AsyncClientMessageTrailers { public final static void main(final String[] args) throws Exception { final IOReactorConfig ioReactorConfig = IOReactorConfig.custom() .setSoTimeout(Timeout.ofSeconds(5)) .build(); final CloseableHttpAsyncClient client = HttpAsyncClients.custom() .setIOReactorConfig(ioReactorConfig) .addExecInterceptorAfter(ChainElement.PROTOCOL.name(), "custom", (request, entityProducer, scope, chain, asyncExecCallback) -> { // Send MD5 hash in a trailer by decorating the original entity producer chain.proceed( request, entityProducer != null ? new DigestingEntityProducer("MD5", entityProducer) : null, scope, asyncExecCallback); }) .build(); client.start(); final SimpleHttpRequest request = SimpleRequestBuilder.post("http://httpbin.org/post") .setBody("some stuff", ContentType.TEXT_PLAIN) .build(); System.out.println("Executing request " + request); final Future future = client.execute( SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(request + "->" + new StatusLine(response)); System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { System.out.println(request + "->" + ex); } @Override public void cancelled() { System.out.println(request + " cancelled"); } }); future.get(); System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientAbortMethod.java0100664 0000000 0000000 00000005373 15016633414 027530 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.Executors; import java.util.concurrent.ScheduledExecutorService; import java.util.concurrent.TimeUnit; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; import org.apache.logging.log4j.core.util.Log4jThreadFactory; /** * This example demonstrates how to abort an HTTP method before its normal completion. */ public class ClientAbortMethod { public static void main(final String[] args) throws Exception { try (final CloseableHttpClient httpclient = HttpClients.createDefault()) { final HttpGet httpget = new HttpGet("http://httpbin.org/get"); final ScheduledExecutorService executorService = Executors.newScheduledThreadPool(1, Log4jThreadFactory.createDaemonThreadFactory("demo")); // Cancel the request after once second executorService.schedule(httpget::cancel, 1, TimeUnit.SECONDS); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); httpclient.execute(httpget, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientConnectionRelease.java0100664 0000000 0000000 00000005464 14736457150 030732 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; /** * This example demonstrates how to ensure the release of the underlying HTTP connection back to * the connection manager in case of a manual processing of HTTP responses. */ public class ClientConnectionRelease { public static void main(final String[] args) throws Exception { try (final CloseableHttpClient httpclient = HttpClients.createDefault()) { final HttpHost target = new HttpHost("http", "httpbin.org"); final HttpGet httpget = new HttpGet("/get"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); // Make sure the response is always closed at the end of the message exchange try (ClassicHttpResponse response = httpclient.executeOpen(target, httpget, null)) { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); // Make sure the response content entity has been fully consumed // in order to ensure the underlying connection can be re-used for // subsequent requests EntityUtils.consume(response.getEntity()); } } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientConnectionConfig.java0100664 0000000 0000000 00000013537 15005672016 031543 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManager; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.ssl.TLS; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * This example demonstrates how to use connection configuration on a per-route or a per-host * basis. */ public class AsyncClientConnectionConfig { public static void main(final String[] args) throws Exception { final PoolingAsyncClientConnectionManager cm = PoolingAsyncClientConnectionManagerBuilder.create() .setConnectionConfigResolver(route -> { // Use different settings for all secure (TLS) connections if (route.isSecure()) { return ConnectionConfig.custom() .setConnectTimeout(Timeout.ofMinutes(2)) .setSocketTimeout(Timeout.ofMinutes(2)) .setValidateAfterInactivity(TimeValue.ofMinutes(1)) .setTimeToLive(TimeValue.ofHours(1)) .build(); } return ConnectionConfig.custom() .setConnectTimeout(Timeout.ofMinutes(1)) .setSocketTimeout(Timeout.ofMinutes(1)) .setValidateAfterInactivity(TimeValue.ofSeconds(15)) .setTimeToLive(TimeValue.ofMinutes(15)) .build(); }) .setTlsConfigResolver(host -> { // Use different settings for specific hosts if (host.getSchemeName().equalsIgnoreCase("httpbin.org")) { return TlsConfig.custom() .setSupportedProtocols(TLS.V_1_3) .setHandshakeTimeout(Timeout.ofSeconds(10)) .build(); } return TlsConfig.DEFAULT; }) .build(); try (final CloseableHttpAsyncClient client = HttpAsyncClients.custom() .setConnectionManager(cm) .build()) { client.start(); for (final URIScheme uriScheme : URIScheme.values()) { final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(new HttpHost(uriScheme.id, "httpbin.org")) .setPath("/headers") .build(); System.out.println("Executing request " + request); final Future future = client.execute( SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(request + "->" + new StatusLine(response)); System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { System.out.println(request + "->" + ex); } @Override public void cancelled() { System.out.println(request + " cancelled"); } }); future.get(); } System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientCustomSSL.java0100664 0000000 0000000 00000013624 14726633241 030155 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.security.cert.X509Certificate; import java.util.concurrent.Future; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManager; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.ssl.ClientTlsStrategyBuilder; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.ssl.TlsStrategy; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.ssl.SSLContexts; /** * This example demonstrates how to create secure connections with a custom SSL * context. */ public class AsyncClientCustomSSL { public static void main(final String[] args) throws Exception { // Trust standard CA and those trusted by our custom strategy final SSLContext sslContext = SSLContexts.custom() // Custom TrustStrategy implementations are intended for verification // of certificates whose CA is not trusted by the system, and where specifying // a custom truststore containing the certificate chain is not an option. .loadTrustMaterial((chain, authType) -> { // Please note that validation of the server certificate without validation // of the entire certificate chain in this example is preferred to completely // disabling trust verification, however this still potentially allows // for man-in-the-middle attacks. final X509Certificate cert = chain[0]; return "CN=httpbin.org".equalsIgnoreCase(cert.getSubjectDN().getName()); }) .build(); final TlsStrategy tlsStrategy = ClientTlsStrategyBuilder.create() .setSslContext(sslContext) .build(); final PoolingAsyncClientConnectionManager cm = PoolingAsyncClientConnectionManagerBuilder.create() .setTlsStrategy(tlsStrategy) .build(); try (final CloseableHttpAsyncClient client = HttpAsyncClients.custom() .setConnectionManager(cm) .build()) { client.start(); final HttpHost target = new HttpHost("https", "httpbin.org"); final HttpClientContext clientContext = HttpClientContext.create(); final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); System.out.println("Executing request " + request); final Future future = client.execute( SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), clientContext, new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(request + "->" + new StatusLine(response)); final SSLSession sslSession = clientContext.getSSLSession(); if (sslSession != null) { System.out.println("SSL protocol " + sslSession.getProtocol()); System.out.println("SSL cipher suite " + sslSession.getCipherSuite()); } System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { System.out.println(request + "->" + ex); } @Override public void cancelled() { System.out.println(request + " cancelled"); } }); future.get(); System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientInterceptors.java0100664 0000000 0000000 00000014065 14704162040 030770 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.nio.ByteBuffer; import java.nio.charset.StandardCharsets; import java.util.concurrent.Future; import java.util.concurrent.atomic.AtomicLong; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.impl.ChainElement; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.EntityDetails; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpRequestInterceptor; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.impl.BasicEntityDetails; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.AsyncDataConsumer; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.Timeout; /** * This example demonstrates how to insert custom request interceptor and an execution interceptor * to the request execution chain. */ public class AsyncClientInterceptors { public static void main(final String[] args) throws Exception { final IOReactorConfig ioReactorConfig = IOReactorConfig.custom() .setSoTimeout(Timeout.ofSeconds(5)) .build(); final CloseableHttpAsyncClient client = HttpAsyncClients.custom() .setIOReactorConfig(ioReactorConfig) // Add a simple request ID to each outgoing request .addRequestInterceptorFirst(new HttpRequestInterceptor() { private final AtomicLong count = new AtomicLong(0); @Override public void process( final HttpRequest request, final EntityDetails entity, final HttpContext context) { request.setHeader("request-id", Long.toString(count.incrementAndGet())); } }) // Simulate a 404 response for some requests without passing the message down to the backend .addExecInterceptorAfter(ChainElement.PROTOCOL.name(), "custom", (request, requestEntityProducer, scope, chain, asyncExecCallback) -> { final Header idHeader = request.getFirstHeader("request-id"); if (idHeader != null && "13".equalsIgnoreCase(idHeader.getValue())) { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_NOT_FOUND, "Oppsie"); final ByteBuffer content = ByteBuffer.wrap("bad luck".getBytes(StandardCharsets.US_ASCII)); final AsyncDataConsumer asyncDataConsumer = asyncExecCallback.handleResponse( response, new BasicEntityDetails(content.remaining(), ContentType.TEXT_PLAIN)); asyncDataConsumer.consume(content); asyncDataConsumer.streamEnd(null); } else { chain.proceed(request, requestEntityProducer, scope, asyncExecCallback); } }) .build(); client.start(); final String requestUri = "http://httpbin.org/get"; for (int i = 0; i < 20; i++) { final SimpleHttpRequest request = SimpleRequestBuilder.get(requestUri).build(); System.out.println("Executing request " + request); final Future future = client.execute( request, new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(request + "->" + new StatusLine(response)); System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { System.out.println(request + "->" + ex); } @Override public void cancelled() { System.out.println(request + " cancelled"); } }); future.get(); } System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientExecuteSOCKS.java0100664 0000000 0000000 00000006075 15030472235 027523 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.net.InetSocketAddress; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager; import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; /** * How to send a request via SOCKS proxy. * * @since 4.1 */ public class ClientExecuteSOCKS { public static void main(final String[] args)throws Exception { final InetSocketAddress socksaddr = new InetSocketAddress("localhost", 1080); final PoolingHttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create() .setDefaultSocketConfig(SocketConfig.custom() .setSocksProxyAddress(socksaddr) .build()) .build(); try (final CloseableHttpClient httpclient = HttpClients.custom() .setConnectionManager(cm) .build()) { final HttpHost target = new HttpHost("http", "httpbin.org", 80); final HttpGet request = new HttpGet("/get"); System.out.println("Executing request " + request.getMethod() + " " + request.getUri() + " via SOCKS proxy " + socksaddr); httpclient.execute(target, request, response -> { System.out.println("----------------------------------------"); System.out.println(request + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientChunkEncodedPost.java0100664 0000000 0000000 00000006167 15005672016 030521 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.io.File; import java.io.FileInputStream; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.message.StatusLine; /** * Example how to use unbuffered chunk-encoded POST request. */ public class ClientChunkEncodedPost { public static void main(final String[] args) throws Exception { if (args.length != 1) { System.out.println("File path not given"); System.exit(1); } try (final CloseableHttpClient httpclient = HttpClients.createDefault()) { final HttpPost httppost = new HttpPost("http://httpbin.org/post"); final File file = new File(args[0]); final InputStreamEntity reqEntity = new InputStreamEntity( new FileInputStream(file), -1, ContentType.APPLICATION_OCTET_STREAM); // It may be more appropriate to use FileEntity class in this particular // instance but we are using a more generic InputStreamEntity to demonstrate // the capability to stream out data from any arbitrary source // // FileEntity entity = new FileEntity(file, "binary/octet-stream"); httppost.setEntity(reqEntity); System.out.println("Executing request " + httppost.getMethod() + " " + httppost.getUri()); httpclient.execute(httppost, response -> { System.out.println("----------------------------------------"); System.out.println(httppost + "->" + new StatusLine(response)); EntityUtils.consume(response.getEntity()); return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientH2ServerPush.java0100664 0000000 0000000 00000014571 15005672016 030615 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.nio.ByteBuffer; import java.nio.CharBuffer; import java.util.concurrent.Future; import org.apache.hc.client5.http.async.methods.AbstractBinPushConsumer; import org.apache.hc.client5.http.async.methods.AbstractCharResponseConsumer; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.impl.routing.RequestRouter; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http.nio.AsyncPushConsumer; import org.apache.hc.core5.http.nio.support.BasicRequestProducer; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.http2.config.H2Config; import org.apache.hc.core5.io.CloseMode; /** * This example demonstrates handling of HTTP/2 message exchanges pushed by the server. */ public class AsyncClientH2ServerPush { public static void main(final String[] args) throws Exception { final CloseableHttpAsyncClient client = HttpAsyncClients.custom() .setH2Config(H2Config.custom() .setPushEnabled(true) .build()) .setConnectionManager(PoolingAsyncClientConnectionManagerBuilder.create() .setDefaultTlsConfig(TlsConfig.custom() .setVersionPolicy(HttpVersionPolicy.FORCE_HTTP_2) .build()) .build()) .build(); client.start(); final RequestRouter> pushRequestRouter = RequestRouter.>builder() // Route all requests to the local authority .resolveAuthority(RequestRouter.LOCAL_AUTHORITY_RESOLVER) // Use the same route for all requests .addRoute(RequestRouter.LOCAL_AUTHORITY, "*", () -> new AbstractBinPushConsumer() { @Override protected void start( final HttpRequest promise, final HttpResponse response, final ContentType contentType) { System.out.println(promise.getPath() + " (push)->" + new StatusLine(response)); } @Override protected int capacityIncrement() { return Integer.MAX_VALUE; } @Override protected void data(final ByteBuffer data, final boolean endOfStream) { } @Override protected void completed() { } @Override public void failed(final Exception cause) { System.out.println("(push)->" + cause); } @Override public void releaseResources() { } }) .build(); final HttpHost target = new HttpHost("https", "nghttp2.org"); final BasicHttpRequest request = BasicRequestBuilder.get() .setHttpHost(target) .setPath("/httpbin/") .build(); System.out.println("Executing request " + request); final Future future = client.execute( new BasicRequestProducer(request, null), new AbstractCharResponseConsumer() { @Override protected void start( final HttpResponse response, final ContentType contentType) { System.out.println(request + "->" + new StatusLine(response)); } @Override protected int capacityIncrement() { return Integer.MAX_VALUE; } @Override protected void data(final CharBuffer data, final boolean endOfStream) { } @Override protected Void buildResult() { return null; } @Override public void failed(final Exception cause) { System.out.println(request + "->" + cause); } @Override public void releaseResources() { } }, HttpAsyncClients.pushRouter(pushRequestRouter), null, null); future.get(); System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ProxyTunnelDemo.java0100664 0000000 0000000 00000005510 14666635064 027303 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.io.BufferedReader; import java.io.InputStreamReader; import java.io.OutputStreamWriter; import java.io.Writer; import java.net.Socket; import java.nio.charset.StandardCharsets; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.impl.classic.ProxyClient; import org.apache.hc.core5.http.HttpHost; /** * Example code for using {@link ProxyClient} in order to establish a tunnel through an HTTP proxy. */ public class ProxyTunnelDemo { public final static void main(final String[] args) throws Exception { final ProxyClient proxyClient = new ProxyClient(); final HttpHost target = new HttpHost("www.yahoo.com", 80); final HttpHost proxy = new HttpHost("localhost", 8888); final UsernamePasswordCredentials credentials = new UsernamePasswordCredentials("user", "pwd".toCharArray()); try (final Socket socket = proxyClient.tunnel(proxy, target, credentials)) { final Writer out = new OutputStreamWriter(socket.getOutputStream(), StandardCharsets.ISO_8859_1); out.write("GET / HTTP/1.1\r\n"); out.write("Host: " + target.toHostString() + "\r\n"); out.write("Agent: whatever\r\n"); out.write("Connection: close\r\n"); out.write("\r\n"); out.flush(); final BufferedReader in = new BufferedReader( new InputStreamReader(socket.getInputStream(), StandardCharsets.ISO_8859_1)); String line = null; while ((line = in.readLine()) != null) { System.out.println(line); } } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientHttpVersionPolicy.java0100664 0000000 0000000 00000012271 14666635064 031773 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.Future; import javax.net.ssl.SSLSession; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManager; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.io.CloseMode; /** * This example demonstrates how to make HttpClient negotiate or force a particular * version of HTTP protocol during the TLS handshake. *

* Please note that protocol version policy setting also applies to non-HTTPS * connections. */ public class AsyncClientHttpVersionPolicy { public static void main(final String[] args) throws Exception { final PoolingAsyncClientConnectionManager cm = PoolingAsyncClientConnectionManagerBuilder.create() .setTlsConfigResolver(httphost -> TlsConfig.custom() // .setVersionPolicy(HttpVersionPolicy.FORCE_HTTP_1) // .setVersionPolicy(HttpVersionPolicy.FORCE_HTTP_2) .setVersionPolicy(HttpVersionPolicy.NEGOTIATE) .build()) .build(); try (final CloseableHttpAsyncClient client = HttpAsyncClients.custom() .setConnectionManager(cm) .build()) { client.start(); final HttpHost target = new HttpHost("https", "httpbin.org"); final HttpClientContext clientContext = HttpClientContext.create(); final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(target) .setPath("/") .build(); System.out.println("Executing request " + request); final Future future = client.execute( SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), clientContext, new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(request + "->" + new StatusLine(response)); System.out.println("HTTP protocol " + clientContext.getProtocolVersion()); final SSLSession sslSession = clientContext.getSSLSession(); if (sslSession != null) { System.out.println("SSL protocol " + sslSession.getProtocol()); System.out.println("SSL cipher suite " + sslSession.getCipherSuite()); } System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { System.out.println(request + "->" + ex); } @Override public void cancelled() { System.out.println(request + " cancelled"); } }); future.get(); System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/AsyncClientConnectionEviction.java0100664 0000000 0000000 00000011546 14666635064 032132 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import org.apache.hc.client5.http.async.methods.SimpleHttpRequest; import org.apache.hc.client5.http.async.methods.SimpleHttpResponse; import org.apache.hc.client5.http.async.methods.SimpleRequestBuilder; import org.apache.hc.client5.http.async.methods.SimpleRequestProducer; import org.apache.hc.client5.http.async.methods.SimpleResponseConsumer; import org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.StatusLine; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; /** * Example demonstrating how to evict expired and idle connections * from the connection pool. */ public class AsyncClientConnectionEviction { public static void main(final String[] args) throws Exception { final IOReactorConfig ioReactorConfig = IOReactorConfig.custom() .setSoTimeout(Timeout.ofSeconds(5)) .build(); final CloseableHttpAsyncClient client = HttpAsyncClients.custom() .setIOReactorConfig(ioReactorConfig) .evictExpiredConnections() .evictIdleConnections(TimeValue.ofSeconds(10)) .build(); client.start(); final SimpleHttpRequest request = SimpleRequestBuilder.get() .setHttpHost(new HttpHost("httpbin.org")) .setPath("/") .build(); System.out.println("Executing request " + request); final Future future1 = client.execute( SimpleRequestProducer.create(request), SimpleResponseConsumer.create(), new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(request + "->" + new StatusLine(response)); System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { System.out.println(request + "->" + ex); } @Override public void cancelled() { System.out.println(request + " cancelled"); } }); future1.get(); Thread.sleep(TimeUnit.SECONDS.toMillis(30)); // Previous connection should get evicted from the pool by now final Future future2 = client.execute( request, new FutureCallback() { @Override public void completed(final SimpleHttpResponse response) { System.out.println(request + "->" + new StatusLine(response)); System.out.println(response.getBody()); } @Override public void failed(final Exception ex) { System.out.println(request + "->" + ex); } @Override public void cancelled() { System.out.println(request + " cancelled"); } }); future2.get(); System.out.println("Shutting down"); client.close(CloseMode.GRACEFUL); } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientResponseProcessing.java0100664 0000000 0000000 00000005266 14666635064 031171 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.message.StatusLine; /** * This example demonstrates the recommended way of processing the HTTP response and releasing * associated resources. */ public class ClientResponseProcessing { public static void main(final String[] args) throws Exception { try (final CloseableHttpClient httpclient = HttpClients.createDefault()) { final HttpGet httpget = new HttpGet("http://httpbin.org/get"); System.out.println("Executing request " + httpget.getMethod() + " " + httpget.getUri()); final Result result = httpclient.execute(httpget, response -> { System.out.println("----------------------------------------"); System.out.println(httpget + "->" + new StatusLine(response)); // Process response message and convert it into a value object return new Result(response.getCode(), EntityUtils.toString(response.getEntity())); }); System.out.println(result); } } static class Result { final int status; final String content; Result(final int status, final String content) { this.status = status; this.content = content; } } } httpclient5/src/test/java/org/apache/hc/client5/http/examples/ClientFormLogin.java0100664 0000000 0000000 00000007750 14675561713 027231 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.examples; import java.net.URI; import java.util.List; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.impl.classic.CloseableHttpClient; import org.apache.hc.client5.http.impl.classic.HttpClients; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; /** * A example that demonstrates how HttpClient APIs can be used to perform * form-based logon. */ public class ClientFormLogin { public static void main(final String[] args) throws Exception { final BasicCookieStore cookieStore = new BasicCookieStore(); try (final CloseableHttpClient httpclient = HttpClients.custom() .setDefaultCookieStore(cookieStore) .build()) { final HttpGet httpget = new HttpGet("https://someportal/"); httpclient.execute(httpget, response -> { System.out.println("----------------------------------------"); System.out.println("Login form get: " + response.getCode() + " " + response.getReasonPhrase()); EntityUtils.consume(response.getEntity()); System.out.println("Initial set of cookies:"); final List cookies = cookieStore.getCookies(); if (cookies.isEmpty()) { System.out.println("None"); } else { for (int i = 0; i < cookies.size(); i++) { System.out.println("- " + cookies.get(i)); } } return null; }); final ClassicHttpRequest login = ClassicRequestBuilder.post() .setUri(new URI("https://someportal/")) .addParameter("IDToken1", "username") .addParameter("IDToken2", "password") .build(); httpclient.execute(login, response -> { System.out.println("----------------------------------------"); System.out.println("Login form get: " + response.getCode() + " " + response.getReasonPhrase()); EntityUtils.consume(response.getEntity()); System.out.println("Post logon cookies:"); final List cookies = cookieStore.getCookies(); if (cookies.isEmpty()) { System.out.println("None"); } else { for (int i = 0; i < cookies.size(); i++) { System.out.println("- " + cookies.get(i)); } } return null; }); } } } httpclient5/src/test/java/org/apache/hc/client5/http/HeaderMatcher.java0100664 0000000 0000000 00000004450 14666635064 025047 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.util.Objects; import org.apache.hc.core5.http.Header; import org.hamcrest.BaseMatcher; import org.hamcrest.Description; import org.hamcrest.Matcher; public class HeaderMatcher extends BaseMatcher

{ private final String headerName; private final Object headerValue; public HeaderMatcher(final String headerName, final Object headerValue) { this.headerName = headerName; this.headerValue = headerValue; } @Override public boolean matches(final Object item) { if (item instanceof Header) { final Header header = (Header) item; return headerName.equalsIgnoreCase(header.getName()) && Objects.equals(headerValue, header.getValue()); } return false; } @Override public void describeTo(final Description description) { description.appendText("same header as ").appendValue(headerValue).appendText(": ").appendValue(headerValue); } public static Matcher
same(final String headerName, final Object headerValue) { return new HeaderMatcher(headerName, headerValue); } } httpclient5/src/test/java/org/apache/hc/client5/http/ssl/0040775 0000000 0000000 00000000000 15063503632 022274 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/ssl/AbstractClientTlsStrategyTest.java0100664 0000000 0000000 00000010726 15005672016 031111 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; import java.security.cert.X509Certificate; import javax.net.ssl.SSLEngine; import javax.net.ssl.SSLParameters; import javax.net.ssl.SSLSession; import javax.security.auth.x500.X500Principal; import org.apache.hc.core5.reactor.ssl.SSLBufferMode; import org.apache.hc.core5.reactor.ssl.TlsDetails; import org.apache.hc.core5.ssl.SSLContexts; import org.junit.jupiter.api.Test; class AbstractClientTlsStrategyTest { @Test void testToEscapedString_withControlCharacters() { // Create a X500Principal with control characters final X500Principal principal = new X500Principal("CN=Test\b\bName\n,O=TestOrg"); // Create a mock subclass of AbstractClientTlsStrategy final AbstractClientTlsStrategy tlsStrategy = new AbstractClientTlsStrategy( SSLContexts.createDefault(), null, null, SSLBufferMode.STATIC, HostnameVerificationPolicy.BUILTIN, HttpsSupport.getDefaultHostnameVerifier()) { @Override void applyParameters(final SSLEngine sslEngine, final SSLParameters sslParameters, final String[] appProtocols) { // No-op for test } @Override TlsDetails createTlsDetails(final SSLEngine sslEngine) { return null; // No-op for test } }; // Call the toEscapedString method final String escaped = tlsStrategy.toEscapedString(principal); // Assert that control characters are properly escaped assertEquals("CN=Test\\x08\\x08Name\\x0a,O=TestOrg", escaped); } @Test void testVerifySession_escapedPeerAndIssuer() throws Exception { // Mock SSLSession and X509Certificate final SSLSession mockSession = mock(SSLSession.class); final X509Certificate mockCert = mock(X509Certificate.class); // Create a mock X500Principal with control characters final X500Principal peerPrincipal = new X500Principal("CN=Peer\bName,O=PeerOrg"); final X500Principal issuerPrincipal = new X500Principal("CN=Issuer\bName,O=IssuerOrg"); when(mockSession.getPeerCertificates()).thenReturn(new X509Certificate[]{mockCert}); when(mockCert.getSubjectX500Principal()).thenReturn(peerPrincipal); when(mockCert.getIssuerX500Principal()).thenReturn(issuerPrincipal); // Create a mock subclass of AbstractClientTlsStrategy final AbstractClientTlsStrategy tlsStrategy = new AbstractClientTlsStrategy( SSLContexts.createDefault(), null, null, SSLBufferMode.STATIC, HostnameVerificationPolicy.BUILTIN, HttpsSupport.getDefaultHostnameVerifier()) { @Override void applyParameters(final SSLEngine sslEngine, final SSLParameters sslParameters, final String[] appProtocols) { // No-op for test } @Override TlsDetails createTlsDetails(final SSLEngine sslEngine) { return null; // No-op for test } }; // Test the verifySession method tlsStrategy.verifySession("localhost", mockSession, null); } }httpclient5/src/test/java/org/apache/hc/client5/http/ssl/TestDefaultHostnameVerifier.java0100664 0000000 0000000 00000075007 15005672035 030564 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; import java.math.BigInteger; import java.net.InetAddress; import java.nio.charset.StandardCharsets; import java.security.InvalidKeyException; import java.security.NoSuchAlgorithmException; import java.security.NoSuchProviderException; import java.security.Principal; import java.security.PublicKey; import java.security.SignatureException; import java.security.cert.CertificateEncodingException; import java.security.cert.CertificateException; import java.security.cert.CertificateExpiredException; import java.security.cert.CertificateFactory; import java.security.cert.CertificateNotYetValidException; import java.security.cert.X509Certificate; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.Date; import java.util.List; import java.util.Set; import javax.net.ssl.SSLException; import org.apache.hc.client5.http.psl.PublicSuffixList; import org.apache.hc.client5.http.psl.PublicSuffixListParser; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.apache.hc.client5.http.utils.DnsUtils; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; /** * Unit tests for {@link org.apache.hc.client5.http.ssl.DefaultHostnameVerifier}. */ class TestDefaultHostnameVerifier { private DefaultHostnameVerifier impl; private PublicSuffixMatcher publicSuffixMatcher; private static final String PUBLIC_SUFFIX_MATCHER_SOURCE_FILE = "suffixlistmatcher.txt"; @BeforeEach void setup() throws IOException { impl = new DefaultHostnameVerifier(); // Load the test PublicSuffixMatcher final ClassLoader classLoader = getClass().getClassLoader(); final InputStream in = classLoader.getResourceAsStream(PUBLIC_SUFFIX_MATCHER_SOURCE_FILE); Assertions.assertNotNull(in); final List lists = PublicSuffixListParser.INSTANCE.parseByType( new InputStreamReader(in, StandardCharsets.UTF_8)); publicSuffixMatcher = new PublicSuffixMatcher(lists); } @Test void testVerify() throws Exception { final CertificateFactory cf = CertificateFactory.getInstance("X.509"); InputStream in; X509Certificate x509; in = new ByteArrayInputStream(CertificatesToPlayWith.X509_FOO); x509 = (X509Certificate) cf.generateCertificate(in); impl.verify("foo.com", x509); exceptionPlease(impl, "a.foo.com", x509); exceptionPlease(impl, "bar.com", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.X509_HANAKO); x509 = (X509Certificate) cf.generateCertificate(in); impl.verify("\u82b1\u5b50.co.jp", x509); exceptionPlease(impl, "a.\u82b1\u5b50.co.jp", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.X509_FOO_BAR); x509 = (X509Certificate) cf.generateCertificate(in); exceptionPlease(impl, "foo.com", x509); exceptionPlease(impl, "a.foo.com", x509); impl.verify("bar.com", x509); exceptionPlease(impl, "a.bar.com", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.X509_FOO_BAR_HANAKO); x509 = (X509Certificate) cf.generateCertificate(in); exceptionPlease(impl, "foo.com", x509); exceptionPlease(impl, "a.foo.com", x509); impl.verify("bar.com", x509); exceptionPlease(impl, "a.bar.com", x509); /* Java isn't extracting international subjectAlts properly. (Or OpenSSL isn't storing them properly). */ // DEFAULT.verify("\u82b1\u5b50.co.jp", x509 ); // impl.verify("\u82b1\u5b50.co.jp", x509 ); exceptionPlease(impl, "a.\u82b1\u5b50.co.jp", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.X509_NO_CNS_FOO); x509 = (X509Certificate) cf.generateCertificate(in); impl.verify("foo.com", x509); exceptionPlease(impl, "a.foo.com", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.X509_NO_CNS_FOO); x509 = (X509Certificate) cf.generateCertificate(in); impl.verify("foo.com", x509); exceptionPlease(impl, "a.foo.com", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.X509_THREE_CNS_FOO_BAR_HANAKO); x509 = (X509Certificate) cf.generateCertificate(in); exceptionPlease(impl, "foo.com", x509); exceptionPlease(impl, "a.foo.com", x509); exceptionPlease(impl, "bar.com", x509); exceptionPlease(impl, "a.bar.com", x509); impl.verify("\u82b1\u5b50.co.jp", x509); exceptionPlease(impl, "a.\u82b1\u5b50.co.jp", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.X509_WILD_FOO); x509 = (X509Certificate) cf.generateCertificate(in); exceptionPlease(impl, "foo.com", x509); impl.verify("www.foo.com", x509); impl.verify("\u82b1\u5b50.foo.com", x509); exceptionPlease(impl, "a.b.foo.com", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.X509_WILD_CO_JP); x509 = (X509Certificate) cf.generateCertificate(in); // Silly test because no-one would ever be able to lookup an IP address // using "*.co.jp". impl.verify("*.co.jp", x509); impl.verify("foo.co.jp", x509); impl.verify("\u82b1\u5b50.co.jp", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.X509_WILD_FOO_BAR_HANAKO); x509 = (X509Certificate) cf.generateCertificate(in); // try the foo.com variations exceptionPlease(impl, "foo.com", x509); exceptionPlease(impl, "www.foo.com", x509); exceptionPlease(impl, "\u82b1\u5b50.foo.com", x509); exceptionPlease(impl, "a.b.foo.com", x509); // try the bar.com variations exceptionPlease(impl, "bar.com", x509); impl.verify("www.bar.com", x509); impl.verify("\u82b1\u5b50.bar.com", x509); exceptionPlease(impl, "a.b.bar.com", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.X509_MULTIPLE_VALUE_AVA); x509 = (X509Certificate) cf.generateCertificate(in); impl.verify("repository.infonotary.com", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.S_GOOGLE_COM); x509 = (X509Certificate) cf.generateCertificate(in); impl.verify("*.google.com", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.S_GOOGLE_COM); x509 = (X509Certificate) cf.generateCertificate(in); impl.verify("*.Google.com", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.IP_1_1_1_1); x509 = (X509Certificate) cf.generateCertificate(in); impl.verify("1.1.1.1", x509); impl.verify("dummy-value.com", x509); exceptionPlease(impl, "1.1.1.2", x509); exceptionPlease(impl, "not-the-cn.com", x509); in = new ByteArrayInputStream(CertificatesToPlayWith.EMAIL_ALT_SUBJECT_NAME); x509 = (X509Certificate) cf.generateCertificate(in); impl.verify("www.company.com", x509); } @Test void testSubjectAlt() throws Exception { final CertificateFactory cf = CertificateFactory.getInstance("X.509"); final InputStream in = new ByteArrayInputStream(CertificatesToPlayWith.X509_MULTIPLE_SUBJECT_ALT); final X509Certificate x509 = (X509Certificate) cf.generateCertificate(in); Assertions.assertEquals("CN=localhost, OU=Unknown, O=Unknown, L=Unknown, ST=Unknown, C=CH", x509.getSubjectDN().getName()); impl.verify("localhost.localdomain", x509); impl.verify("127.0.0.1", x509); Assertions.assertThrows(SSLException.class, () -> impl.verify("localhost", x509)); Assertions.assertThrows(SSLException.class, () -> impl.verify("local.host", x509)); Assertions.assertThrows(SSLException.class, () -> impl.verify("127.0.0.2", x509)); } public void exceptionPlease(final DefaultHostnameVerifier hv, final String host, final X509Certificate x509) { Assertions.assertThrows(SSLException.class, () -> hv.verify(host, x509)); } @Test void testParseFQDN() { Assertions.assertEquals(Arrays.asList("blah"), DefaultHostnameVerifier.parseFQDN("blah")); Assertions.assertEquals(Arrays.asList("blah", "blah"), DefaultHostnameVerifier.parseFQDN("blah.blah")); Assertions.assertEquals(Arrays.asList("blah", "blah", "blah"), DefaultHostnameVerifier.parseFQDN("blah.blah.blah")); Assertions.assertEquals(Arrays.asList("", "", "blah", ""), DefaultHostnameVerifier.parseFQDN(".blah..")); Assertions.assertEquals(Arrays.asList(""), DefaultHostnameVerifier.parseFQDN("")); Assertions.assertEquals(Arrays.asList("", ""), DefaultHostnameVerifier.parseFQDN(".")); Assertions.assertEquals(Arrays.asList("com", "domain", "host"), DefaultHostnameVerifier.parseFQDN("host.domain.com")); } @Test void testDomainRootMatching() { Assertions.assertFalse(DefaultHostnameVerifier.matchDomainRoot("a.b.c", null)); Assertions.assertTrue(DefaultHostnameVerifier.matchDomainRoot("a.b.c", "a.b.c")); Assertions.assertFalse(DefaultHostnameVerifier.matchDomainRoot("aa.b.c", "a.b.c")); Assertions.assertFalse(DefaultHostnameVerifier.matchDomainRoot("a.b.c", "aa.b.c")); Assertions.assertTrue(DefaultHostnameVerifier.matchDomainRoot("a.a.b.c", "a.b.c")); } static boolean matchIdentity(final String host, final String identity, final PublicSuffixMatcher publicSuffixMatcher, final boolean strict) { return DefaultHostnameVerifier.matchIdentity( DnsUtils.normalizeUnicode(host), DnsUtils.normalizeUnicode(identity), publicSuffixMatcher, strict); } static boolean matchIdentity(final String host, final String identity, final PublicSuffixMatcher publicSuffixMatcher) { return matchIdentity(host, identity, publicSuffixMatcher, false); } static boolean matchIdentity(final String host, final String identity) { return matchIdentity(host, identity, null, false); } static boolean matchIdentityStrict(final String host, final String identity, final PublicSuffixMatcher publicSuffixMatcher) { return matchIdentity(host, identity, publicSuffixMatcher, true); } static boolean matchIdentityStrict(final String host, final String identity) { return matchIdentity(host, identity, null, true); } @Test void testIdentityMatching() { Assertions.assertTrue(matchIdentity("a.b.c", "*.b.c")); Assertions.assertTrue(matchIdentityStrict("a.b.c", "*.b.c")); Assertions.assertTrue(matchIdentity("s.a.b.c", "*.b.c")); Assertions.assertFalse(matchIdentityStrict("s.a.b.c", "*.b.c")); // subdomain not OK Assertions.assertTrue(matchIdentity("a.gov.uk", "*.gov.uk", publicSuffixMatcher)); Assertions.assertTrue(matchIdentityStrict("a.gov.uk", "*.gov.uk", publicSuffixMatcher)); // Bad 2TLD Assertions.assertTrue(matchIdentity("s.a.gov.uk", "*.a.gov.uk", publicSuffixMatcher)); Assertions.assertTrue(matchIdentityStrict("s.a.gov.uk", "*.a.gov.uk", publicSuffixMatcher)); Assertions.assertTrue(matchIdentity("s.a.gov.uk", "*.gov.uk", publicSuffixMatcher)); Assertions.assertFalse(matchIdentityStrict("s.a.gov.uk", "*.gov.uk", publicSuffixMatcher)); // BBad 2TLD/no subdomain allowed Assertions.assertTrue(matchIdentity("a.gov.com", "*.gov.com", publicSuffixMatcher)); Assertions.assertTrue(matchIdentityStrict("a.gov.com", "*.gov.com", publicSuffixMatcher)); Assertions.assertTrue(matchIdentity("s.a.gov.com", "*.gov.com", publicSuffixMatcher)); Assertions.assertFalse(matchIdentityStrict("s.a.gov.com", "*.gov.com", publicSuffixMatcher)); // no subdomain allowed Assertions.assertTrue(matchIdentity("a.gov.uk", "a*.gov.uk", publicSuffixMatcher)); Assertions.assertTrue(matchIdentityStrict("a.gov.uk", "a*.gov.uk", publicSuffixMatcher)); // Bad 2TLD Assertions.assertFalse(matchIdentity("s.a.gov.uk", "a*.gov.uk", publicSuffixMatcher)); // Bad 2TLD Assertions.assertFalse(matchIdentityStrict("s.a.gov.uk", "a*.gov.uk", publicSuffixMatcher)); // Bad 2TLD/no subdomain allowed Assertions.assertFalse(matchIdentity("a.b.c", "*.b.*")); Assertions.assertFalse(matchIdentityStrict("a.b.c", "*.b.*")); Assertions.assertFalse(matchIdentity("a.b.c", "*.*.c")); Assertions.assertFalse(matchIdentityStrict("a.b.c", "*.*.c")); Assertions.assertTrue(matchIdentity("a.b.xxx.uk", "a.b.xxx.uk", publicSuffixMatcher)); Assertions.assertTrue(matchIdentityStrict("a.b.xxx.uk", "a.b.xxx.uk", publicSuffixMatcher)); Assertions.assertTrue(matchIdentity("a.b.xxx.uk", "*.b.xxx.uk", publicSuffixMatcher)); Assertions.assertTrue(matchIdentityStrict("a.b.xxx.uk", "*.b.xxx.uk", publicSuffixMatcher)); Assertions.assertTrue(matchIdentity("b.xxx.uk", "b.xxx.uk", publicSuffixMatcher)); Assertions.assertTrue(matchIdentityStrict("b.xxx.uk", "b.xxx.uk", publicSuffixMatcher)); Assertions.assertTrue(matchIdentity("b.xxx.uk", "*.xxx.uk", publicSuffixMatcher)); Assertions.assertTrue(matchIdentityStrict("b.xxx.uk", "*.xxx.uk", publicSuffixMatcher)); } @Test void testHTTPCLIENT_1097() { Assertions.assertTrue(matchIdentity("a.b.c", "a*.b.c")); Assertions.assertTrue(matchIdentityStrict("a.b.c", "a*.b.c")); Assertions.assertTrue(matchIdentity("a.a.b.c", "a*.b.c")); Assertions.assertFalse(matchIdentityStrict("a.a.b.c", "a*.b.c")); } @Test void testHTTPCLIENT_1255() { Assertions.assertTrue(matchIdentity("mail.a.b.c.com", "m*.a.b.c.com")); Assertions.assertTrue(matchIdentityStrict("mail.a.b.c.com", "m*.a.b.c.com")); } @Test void testHTTPCLIENT_1997() { String domain; // Unknown domain = "dev.b.cloud.a"; Assertions.assertTrue(matchIdentity("service.apps." + domain, "*.apps." + domain)); Assertions.assertTrue(matchIdentityStrict("service.apps." + domain, "*.apps." + domain)); Assertions.assertTrue(matchIdentity("service.apps." + domain, "*.apps." + domain, publicSuffixMatcher)); Assertions.assertTrue(matchIdentityStrict("service.apps." + domain, "*.apps." + domain, publicSuffixMatcher)); // ICANN domain = "dev.b.cloud.com"; Assertions.assertTrue(matchIdentity("service.apps." + domain, "*.apps." + domain)); Assertions.assertTrue(matchIdentityStrict("service.apps." + domain, "*.apps." + domain)); Assertions.assertTrue(matchIdentity("service.apps." + domain, "*.apps." + domain, publicSuffixMatcher)); Assertions.assertTrue(matchIdentityStrict("service.apps." + domain, "*.apps." + domain, publicSuffixMatcher)); // PRIVATE domain = "dev.b.cloud.lan"; Assertions.assertTrue(matchIdentity("service.apps." + domain, "*.apps." + domain)); Assertions.assertTrue(matchIdentityStrict("service.apps." + domain, "*.apps." + domain)); Assertions.assertTrue(matchIdentity("service.apps." + domain, "*.apps." + domain, publicSuffixMatcher)); Assertions.assertTrue(matchIdentityStrict("service.apps." + domain, "*.apps." + domain, publicSuffixMatcher)); } @Test // Check compressed IPv6 hostname matching void testHTTPCLIENT_1316() throws Exception { final String host1 = "2001:0db8:aaaa:bbbb:cccc:0:0:0001"; DefaultHostnameVerifier.matchIPv6Address(host1, Collections.singletonList(SubjectName.IP("2001:0db8:aaaa:bbbb:cccc:0:0:0001"))); DefaultHostnameVerifier.matchIPv6Address(host1, Collections.singletonList(SubjectName.IP("2001:0db8:aaaa:bbbb:cccc::1"))); Assertions.assertThrows(SSLException.class, () -> DefaultHostnameVerifier.matchIPv6Address(host1, Collections.singletonList(SubjectName.IP("2001:0db8:aaaa:bbbb:cccc::10")))); final String host2 = "2001:0db8:aaaa:bbbb:cccc::1"; DefaultHostnameVerifier.matchIPv6Address(host2, Collections.singletonList(SubjectName.IP("2001:0db8:aaaa:bbbb:cccc:0:0:0001"))); DefaultHostnameVerifier.matchIPv6Address(host2, Collections.singletonList(SubjectName.IP("2001:0db8:aaaa:bbbb:cccc::1"))); Assertions.assertThrows(SSLException.class, () -> DefaultHostnameVerifier.matchIPv6Address(host2, Collections.singletonList(SubjectName.IP("2001:0db8:aaaa:bbbb:cccc::10")))); } @Test void testHTTPCLIENT_2149() throws Exception { final CertificateFactory cf = CertificateFactory.getInstance("X.509"); final InputStream in = new ByteArrayInputStream(CertificatesToPlayWith.SUBJECT_ALT_IP_ONLY); final X509Certificate x509 = (X509Certificate) cf.generateCertificate(in); Assertions.assertEquals("CN=www.foo.com", x509.getSubjectDN().getName()); impl.verify("127.0.0.1", x509); impl.verify("www.foo.com", x509); exceptionPlease(impl, "127.0.0.2", x509); exceptionPlease(impl, "www.bar.com", x509); } @Test void testExtractCN() throws Exception { Assertions.assertEquals("blah", DefaultHostnameVerifier.extractCN("cn=blah, ou=blah, o=blah")); Assertions.assertEquals("blah", DefaultHostnameVerifier.extractCN("cn=blah, cn=yada, cn=booh")); Assertions.assertEquals("blah", DefaultHostnameVerifier.extractCN("c = pampa , cn = blah , ou = blah , o = blah")); Assertions.assertEquals("blah", DefaultHostnameVerifier.extractCN("cn=\"blah\", ou=blah, o=blah")); Assertions.assertEquals("blah blah", DefaultHostnameVerifier.extractCN("cn=\"blah blah\", ou=blah, o=blah")); Assertions.assertEquals("blah, blah", DefaultHostnameVerifier.extractCN("cn=\"blah, blah\", ou=blah, o=blah")); Assertions.assertEquals("blah, blah", DefaultHostnameVerifier.extractCN("cn=blah\\, blah, ou=blah, o=blah")); Assertions.assertEquals("blah", DefaultHostnameVerifier.extractCN("c = cn=uuh, cn=blah, ou=blah, o=blah")); Assertions.assertThrows(SSLException.class, () -> DefaultHostnameVerifier.extractCN("blah,blah")); Assertions.assertThrows(SSLException.class, () -> DefaultHostnameVerifier.extractCN("cn,o=blah")); } @Test void testMatchDNSName() throws Exception { DefaultHostnameVerifier.matchDNSName( "host.domain.com", Collections.singletonList(SubjectName.DNS("*.domain.com")), publicSuffixMatcher); DefaultHostnameVerifier.matchDNSName( "host.xx", Collections.singletonList(SubjectName.DNS("*.xx")), publicSuffixMatcher); DefaultHostnameVerifier.matchDNSName( "host.appspot.com", Collections.singletonList(SubjectName.DNS("*.appspot.com")), publicSuffixMatcher); DefaultHostnameVerifier.matchDNSName( "demo-s3-bucket.s3.eu-central-1.amazonaws.com", Collections.singletonList(SubjectName.DNS("*.s3.eu-central-1.amazonaws.com")), publicSuffixMatcher); DefaultHostnameVerifier.matchDNSName( "hostname-workspace-1.local", Collections.singletonList(SubjectName.DNS("hostname-workspace-1.local")), publicSuffixMatcher); Assertions.assertThrows(SSLException.class, () -> DefaultHostnameVerifier.matchDNSName( "host.domain.com", Collections.singletonList(SubjectName.DNS("some.other.com")), publicSuffixMatcher)); DefaultHostnameVerifier.matchDNSName( "host.ec2.compute-1.amazonaws.com", Collections.singletonList(SubjectName.DNS("host.ec2.compute-1.amazonaws.com")), publicSuffixMatcher); DefaultHostnameVerifier.matchDNSName( "host.ec2.compute-1.amazonaws.com", Collections.singletonList(SubjectName.DNS("*.ec2.compute-1.amazonaws.com")), publicSuffixMatcher); Assertions.assertThrows(SSLException.class, () -> DefaultHostnameVerifier.matchDNSName( "compute-1.amazonaws.com", Collections.singletonList(SubjectName.DNS("*.compute-1.amazonaws.com")), publicSuffixMatcher)); DefaultHostnameVerifier.matchDNSName( "ec2.compute-1.amazonaws.com", Collections.singletonList(SubjectName.DNS("*.compute-1.amazonaws.com")), publicSuffixMatcher); } @Test void testMatchIdentity() { // Test 1: IDN matching punycode final String unicodeHost1 = "поиск-слов.рф"; final String punycodeHost1 = "xn----dtbqigoecuc.xn--p1ai"; // These should now match, thanks to IDN.toASCII(): Assertions.assertTrue(matchIdentity(unicodeHost1, punycodeHost1), "Expected the Unicode host and its punycode to match" ); // ‘example.com’ vs. an unrelated punycode domain should fail: Assertions.assertFalse( matchIdentity("example.com", punycodeHost1), "Expected mismatch between example.com and xn----dtbqigoecuc.xn--p1ai" ); // Test 2: Unicode host and Unicode identity final String unicodeHost2 = "пример.рф"; final String unicodeIdentity2 = "пример.рф"; Assertions.assertTrue(matchIdentity(unicodeHost2, unicodeIdentity2), "Expected Unicode host and Unicode identity to match" ); // Test 3: Punycode host and Unicode identity final String unicodeHost3 = "пример.рф"; final String punycodeIdentity3 = "xn--e1afmkfd.xn--p1ai"; Assertions.assertTrue(matchIdentity(unicodeHost3, punycodeIdentity3), "Expected Unicode host and punycode identity to match" ); // Test 4: Wildcard matching in the left-most label final String unicodeHost4 = "sub.пример.рф"; final String unicodeIdentity4 = "*.пример.рф"; Assertions.assertTrue(matchIdentity(unicodeHost4, unicodeIdentity4), "Expected wildcard to match subdomain" ); // Test 5: Invalid host final String invalidHost = "invalid_host"; final String unicodeIdentity5 = "пример.рф"; Assertions.assertFalse( matchIdentity(invalidHost, unicodeIdentity5), "Expected invalid host to not match" ); // Test 6: Invalid identity final String unicodeHost4b = "пример.рф"; final String invalidIdentity = "xn--invalid-punycode"; Assertions.assertFalse( matchIdentity(unicodeHost4b, invalidIdentity), "Expected invalid identity to not match" ); // Test 7: Mixed case comparison final String unicodeHost5 = "ПрИмеР.рф"; final String unicodeIdentity6 = "пример.рф"; Assertions.assertTrue(matchIdentity(unicodeHost5, unicodeIdentity6), "Expected case-insensitive Unicode comparison to match" ); // Test 8: Wildcard in the middle label (per RFC 2818, should match) final String unicodeHost6 = "sub.пример.рф"; final String unicodeIdentity8 = "sub.*.рф"; Assertions.assertTrue(matchIdentity(unicodeHost6, unicodeIdentity8), "Expected wildcard in the middle label to match" ); } @Test void testSimulatedByteProperties() throws Exception { // Simulated byte array for an IP address final byte[] ipAsByteArray = {1, 1, 1, 1}; // 1.1.1.1 in byte form final List> entries = new ArrayList<>(); final List entry = new ArrayList<>(); entry.add(SubjectName.IP); entry.add(ipAsByteArray); entries.add(entry); // Mocking the certificate behavior final X509Certificate mockCert = generateX509Certificate(entries); final List result = DefaultHostnameVerifier.getSubjectAltNames(mockCert, -1); Assertions.assertEquals(1, result.size(), "Should have one SubjectAltName"); final SubjectName sn = result.get(0); Assertions.assertEquals(SubjectName.IP, sn.getType(), "Should be an IP type"); // Here, you'll need logic to convert byte array to string for assertion Assertions.assertEquals("1.1.1.1", sn.getValue(), "IP address should match after conversion"); } @Test void testSimulatedBytePropertiesIPv6() throws Exception { final byte[] ipv6AsByteArray = InetAddress.getByName("2001:db8:85a3::8a2e:370:7334").getAddress(); // IPv6 2001:db8:85a3::8a2e:370:7334 final List> entries = new ArrayList<>(); final List entry = new ArrayList<>(); entry.add(SubjectName.IP); entry.add(ipv6AsByteArray); entries.add(entry); // Mocking the certificate behavior final X509Certificate mockCert = generateX509Certificate(entries); final List result = DefaultHostnameVerifier.getSubjectAltNames(mockCert, -1); Assertions.assertEquals(1, result.size(), "Should have one SubjectAltName"); final SubjectName sn = result.get(0); Assertions.assertEquals(SubjectName.IP, sn.getType(), "Should be an IP type"); // Here, you'll need logic to convert byte array to string for assertion Assertions.assertEquals("2001:0db8:85a3:0000:0000:8a2e:0370:7334", sn.getValue(), "IP address should match after conversion"); } private X509Certificate generateX509Certificate(final List> entries) { return new X509Certificate() { @Override public boolean hasUnsupportedCriticalExtension() { return false; } @Override public Set getCriticalExtensionOIDs() { return null; } @Override public Set getNonCriticalExtensionOIDs() { return null; } @Override public byte[] getExtensionValue(final String oid) { return new byte[0]; } @Override public byte[] getEncoded() throws CertificateEncodingException { return new byte[0]; } @Override public void verify(final PublicKey key) throws CertificateException, NoSuchAlgorithmException, InvalidKeyException, NoSuchProviderException, SignatureException { } @Override public void verify(final PublicKey key, final String sigProvider) throws CertificateException, NoSuchAlgorithmException, InvalidKeyException, NoSuchProviderException, SignatureException { } @Override public String toString() { return ""; } @Override public PublicKey getPublicKey() { return null; } @Override public void checkValidity() throws CertificateExpiredException, CertificateNotYetValidException { } @Override public void checkValidity(final Date date) throws CertificateExpiredException, CertificateNotYetValidException { } @Override public int getVersion() { return 0; } @Override public BigInteger getSerialNumber() { return null; } @Override public Principal getIssuerDN() { return null; } @Override public Principal getSubjectDN() { return null; } @Override public Date getNotBefore() { return null; } @Override public Date getNotAfter() { return null; } @Override public byte[] getTBSCertificate() throws CertificateEncodingException { return new byte[0]; } @Override public byte[] getSignature() { return new byte[0]; } @Override public String getSigAlgName() { return ""; } @Override public String getSigAlgOID() { return ""; } @Override public byte[] getSigAlgParams() { return new byte[0]; } @Override public boolean[] getIssuerUniqueID() { return new boolean[0]; } @Override public boolean[] getSubjectUniqueID() { return new boolean[0]; } @Override public boolean[] getKeyUsage() { return new boolean[0]; } @Override public int getBasicConstraints() { return 0; } @Override public Collection> getSubjectAlternativeNames() { return entries; } }; } }httpclient5/src/test/java/org/apache/hc/client5/http/ssl/CertificatesToPlayWith.java0100664 0000000 0000000 00000112402 14704162040 027521 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; /** * Some X509 certificates to test against. *

* Note: some of these certificates have Japanese Kanji in the "subjectAlt" * field (UTF8). Not sure how realistic that is since international characters * in DNS names usually get translated into ASCII using "xn--" style DNS * entries. "xn--i8s592g.co.jp" is what FireFox actually uses when trying to * find 花子.co.jp. So would the CN in the certificate contain * "xn--i8s592g.co.jp" in ASCII, or "花子.co.jp" in UTF8? (Both?) *

* * @since 11-Dec-2006 */ class CertificatesToPlayWith { /** * CN=foo.com */ public final static byte[] X509_FOO = ( "-----BEGIN CERTIFICATE-----\n" + "MIIERjCCAy6gAwIBAgIJAIz+EYMBU6aQMA0GCSqGSIb3DQEBBQUAMIGiMQswCQYD\n" + "VQQGEwJDQTELMAkGA1UECBMCQkMxEjAQBgNVBAcTCVZhbmNvdXZlcjEWMBQGA1UE\n" + "ChMNd3d3LmN1Y2JjLmNvbTEUMBIGA1UECxQLY29tbW9uc19zc2wxHTAbBgNVBAMU\n" + "FGRlbW9faW50ZXJtZWRpYXRlX2NhMSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZp\n" + "ZXNAZ21haWwuY29tMB4XDTA2MTIxMTE1MzE0MVoXDTI4MTEwNTE1MzE0MVowgaQx\n" + "CzAJBgNVBAYTAlVTMREwDwYDVQQIEwhNYXJ5bGFuZDEUMBIGA1UEBxMLRm9yZXN0\n" + "IEhpbGwxFzAVBgNVBAoTDmh0dHBjb21wb25lbnRzMRowGAYDVQQLExF0ZXN0IGNl\n" + "cnRpZmljYXRlczEQMA4GA1UEAxMHZm9vLmNvbTElMCMGCSqGSIb3DQEJARYWanVs\n" + "aXVzZGF2aWVzQGdtYWlsLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\n" + "ggEBAMhjr5aCPoyp0R1iroWAfnEyBMGYWoCidH96yGPFjYLowez5aYKY1IOKTY2B\n" + "lYho4O84X244QrZTRl8kQbYtxnGh4gSCD+Z8gjZ/gMvLUlhqOb+WXPAUHMB39GRy\n" + "zerA/ZtrlUqf+lKo0uWcocxeRc771KN8cPH3nHZ0rV0Hx4ZAZy6U4xxObe4rtSVY\n" + "07hNKXAb2odnVqgzcYiDkLV8ilvEmoNWMWrp8UBqkTcpEhYhCYp3cTkgJwMSuqv8\n" + "BqnGd87xQU3FVZI4tbtkB+KzjD9zz8QCDJAfDjZHR03KNQ5mxOgXwxwKw6lGMaiV\n" + "JTxpTKqym93whYk93l3ocEe55c0CAwEAAaN7MHkwCQYDVR0TBAIwADAsBglghkgB\n" + "hvhCAQ0EHxYdT3BlblNTTCBHZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0OBBYE\n" + "FJ8Ud78/OrbKOIJCSBYs2tDLXofYMB8GA1UdIwQYMBaAFHua2o+QmU5S0qzbswNS\n" + "yoemDT4NMA0GCSqGSIb3DQEBBQUAA4IBAQC3jRmEya6sQCkmieULcvx8zz1euCk9\n" + "fSez7BEtki8+dmfMXe3K7sH0lI8f4jJR0rbSCjpmCQLYmzC3NxBKeJOW0RcjNBpO\n" + "c2JlGO9auXv2GDP4IYiXElLJ6VSqc8WvDikv0JmCCWm0Zga+bZbR/EWN5DeEtFdF\n" + "815CLpJZNcYwiYwGy/CVQ7w2TnXlG+mraZOz+owr+cL6J/ZesbdEWfjoS1+cUEhE\n" + "HwlNrAu8jlZ2UqSgskSWlhYdMTAP9CPHiUv9N7FcT58Itv/I4fKREINQYjDpvQcx\n" + "SaTYb9dr5sB4WLNglk7zxDtM80H518VvihTcP7FHL+Gn6g4j5fkI98+S\n" + "-----END CERTIFICATE-----\n").getBytes(); /** * CN=花子.co.jp */ public final static byte[] X509_HANAKO = ( "-----BEGIN CERTIFICATE-----\n" + "MIIESzCCAzOgAwIBAgIJAIz+EYMBU6aTMA0GCSqGSIb3DQEBBQUAMIGiMQswCQYD\n" + "VQQGEwJDQTELMAkGA1UECBMCQkMxEjAQBgNVBAcTCVZhbmNvdXZlcjEWMBQGA1UE\n" + "ChMNd3d3LmN1Y2JjLmNvbTEUMBIGA1UECxQLY29tbW9uc19zc2wxHTAbBgNVBAMU\n" + "FGRlbW9faW50ZXJtZWRpYXRlX2NhMSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZp\n" + "ZXNAZ21haWwuY29tMB4XDTA2MTIxMTE1NDIxNVoXDTI4MTEwNTE1NDIxNVowgakx\n" + "CzAJBgNVBAYTAlVTMREwDwYDVQQIDAhNYXJ5bGFuZDEUMBIGA1UEBwwLRm9yZXN0\n" + "IEhpbGwxFzAVBgNVBAoMDmh0dHBjb21wb25lbnRzMRowGAYDVQQLDBF0ZXN0IGNl\n" + "cnRpZmljYXRlczEVMBMGA1UEAwwM6Iqx5a2QLmNvLmpwMSUwIwYJKoZIhvcNAQkB\n" + "FhZqdWxpdXNkYXZpZXNAZ21haWwuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A\n" + "MIIBCgKCAQEAyGOvloI+jKnRHWKuhYB+cTIEwZhagKJ0f3rIY8WNgujB7PlpgpjU\n" + "g4pNjYGViGjg7zhfbjhCtlNGXyRBti3GcaHiBIIP5nyCNn+Ay8tSWGo5v5Zc8BQc\n" + "wHf0ZHLN6sD9m2uVSp/6UqjS5ZyhzF5FzvvUo3xw8fecdnStXQfHhkBnLpTjHE5t\n" + "7iu1JVjTuE0pcBvah2dWqDNxiIOQtXyKW8Sag1YxaunxQGqRNykSFiEJindxOSAn\n" + "AxK6q/wGqcZ3zvFBTcVVkji1u2QH4rOMP3PPxAIMkB8ONkdHTco1DmbE6BfDHArD\n" + "qUYxqJUlPGlMqrKb3fCFiT3eXehwR7nlzQIDAQABo3sweTAJBgNVHRMEAjAAMCwG\n" + "CWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNV\n" + "HQ4EFgQUnxR3vz86tso4gkJIFiza0Mteh9gwHwYDVR0jBBgwFoAUe5raj5CZTlLS\n" + "rNuzA1LKh6YNPg0wDQYJKoZIhvcNAQEFBQADggEBALJ27i3okV/KvlDp6KMID3gd\n" + "ITl68PyItzzx+SquF8gahMh016NX73z/oVZoVUNdftla8wPUB1GwIkAnGkhQ9LHK\n" + "spBdbRiCj0gMmLCsX8SrjFvr7cYb2cK6J/fJe92l1tg/7Y4o7V/s4JBe/cy9U9w8\n" + "a0ctuDmEBCgC784JMDtT67klRfr/2LlqWhlOEq7pUFxRLbhpquaAHSOjmIcWnVpw\n" + "9BsO7qe46hidgn39hKh1WjKK2VcL/3YRsC4wUi0PBtFW6ScMCuMhgIRXSPU55Rae\n" + "UIlOdPjjr1SUNWGId1rD7W16Scpwnknn310FNxFMHVI0GTGFkNdkilNCFJcIoRA=\n" + "-----END CERTIFICATE-----\n").getBytes(); /** * CN=foo.com, subjectAlt=bar.com */ public final static byte[] X509_FOO_BAR = ( "-----BEGIN CERTIFICATE-----\n" + "MIIEXDCCA0SgAwIBAgIJAIz+EYMBU6aRMA0GCSqGSIb3DQEBBQUAMIGiMQswCQYD\n" + "VQQGEwJDQTELMAkGA1UECBMCQkMxEjAQBgNVBAcTCVZhbmNvdXZlcjEWMBQGA1UE\n" + "ChMNd3d3LmN1Y2JjLmNvbTEUMBIGA1UECxQLY29tbW9uc19zc2wxHTAbBgNVBAMU\n" + "FGRlbW9faW50ZXJtZWRpYXRlX2NhMSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZp\n" + "ZXNAZ21haWwuY29tMB4XDTA2MTIxMTE1MzYyOVoXDTI4MTEwNTE1MzYyOVowgaQx\n" + "CzAJBgNVBAYTAlVTMREwDwYDVQQIEwhNYXJ5bGFuZDEUMBIGA1UEBxMLRm9yZXN0\n" + "IEhpbGwxFzAVBgNVBAoTDmh0dHBjb21wb25lbnRzMRowGAYDVQQLExF0ZXN0IGNl\n" + "cnRpZmljYXRlczEQMA4GA1UEAxMHZm9vLmNvbTElMCMGCSqGSIb3DQEJARYWanVs\n" + "aXVzZGF2aWVzQGdtYWlsLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\n" + "ggEBAMhjr5aCPoyp0R1iroWAfnEyBMGYWoCidH96yGPFjYLowez5aYKY1IOKTY2B\n" + "lYho4O84X244QrZTRl8kQbYtxnGh4gSCD+Z8gjZ/gMvLUlhqOb+WXPAUHMB39GRy\n" + "zerA/ZtrlUqf+lKo0uWcocxeRc771KN8cPH3nHZ0rV0Hx4ZAZy6U4xxObe4rtSVY\n" + "07hNKXAb2odnVqgzcYiDkLV8ilvEmoNWMWrp8UBqkTcpEhYhCYp3cTkgJwMSuqv8\n" + "BqnGd87xQU3FVZI4tbtkB+KzjD9zz8QCDJAfDjZHR03KNQ5mxOgXwxwKw6lGMaiV\n" + "JTxpTKqym93whYk93l3ocEe55c0CAwEAAaOBkDCBjTAJBgNVHRMEAjAAMCwGCWCG\n" + "SAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNVHQ4E\n" + "FgQUnxR3vz86tso4gkJIFiza0Mteh9gwHwYDVR0jBBgwFoAUe5raj5CZTlLSrNuz\n" + "A1LKh6YNPg0wEgYDVR0RBAswCYIHYmFyLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEA\n" + "dQyprNZBmVnvuVWjV42sey/PTfkYShJwy1j0/jcFZR/ypZUovpiHGDO1DgL3Y3IP\n" + "zVQ26uhUsSw6G0gGRiaBDe/0LUclXZoJzXX1qpS55OadxW73brziS0sxRgGrZE/d\n" + "3g5kkio6IED47OP6wYnlmZ7EKP9cqjWwlnvHnnUcZ2SscoLNYs9rN9ccp8tuq2by\n" + "88OyhKwGjJfhOudqfTNZcDzRHx4Fzm7UsVaycVw4uDmhEHJrAsmMPpj/+XRK9/42\n" + "2xq+8bc6HojdtbCyug/fvBZvZqQXSmU8m8IVcMmWMz0ZQO8ee3QkBHMZfCy7P/kr\n" + "VbWx/uETImUu+NZg22ewEw==\n" + "-----END CERTIFICATE-----\n").getBytes(); /** * CN=foo.com, subjectAlt=bar.com, subjectAlt=花子.co.jp * (hanako.co.jp in kanji) */ public final static byte[] X509_FOO_BAR_HANAKO = ( "-----BEGIN CERTIFICATE-----\n" + "MIIEajCCA1KgAwIBAgIJAIz+EYMBU6aSMA0GCSqGSIb3DQEBBQUAMIGiMQswCQYD\n" + "VQQGEwJDQTELMAkGA1UECBMCQkMxEjAQBgNVBAcTCVZhbmNvdXZlcjEWMBQGA1UE\n" + "ChMNd3d3LmN1Y2JjLmNvbTEUMBIGA1UECxQLY29tbW9uc19zc2wxHTAbBgNVBAMU\n" + "FGRlbW9faW50ZXJtZWRpYXRlX2NhMSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZp\n" + "ZXNAZ21haWwuY29tMB4XDTA2MTIxMTE1MzgxM1oXDTI4MTEwNTE1MzgxM1owgaQx\n" + "CzAJBgNVBAYTAlVTMREwDwYDVQQIEwhNYXJ5bGFuZDEUMBIGA1UEBxMLRm9yZXN0\n" + "IEhpbGwxFzAVBgNVBAoTDmh0dHBjb21wb25lbnRzMRowGAYDVQQLExF0ZXN0IGNl\n" + "cnRpZmljYXRlczEQMA4GA1UEAxMHZm9vLmNvbTElMCMGCSqGSIb3DQEJARYWanVs\n" + "aXVzZGF2aWVzQGdtYWlsLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\n" + "ggEBAMhjr5aCPoyp0R1iroWAfnEyBMGYWoCidH96yGPFjYLowez5aYKY1IOKTY2B\n" + "lYho4O84X244QrZTRl8kQbYtxnGh4gSCD+Z8gjZ/gMvLUlhqOb+WXPAUHMB39GRy\n" + "zerA/ZtrlUqf+lKo0uWcocxeRc771KN8cPH3nHZ0rV0Hx4ZAZy6U4xxObe4rtSVY\n" + "07hNKXAb2odnVqgzcYiDkLV8ilvEmoNWMWrp8UBqkTcpEhYhCYp3cTkgJwMSuqv8\n" + "BqnGd87xQU3FVZI4tbtkB+KzjD9zz8QCDJAfDjZHR03KNQ5mxOgXwxwKw6lGMaiV\n" + "JTxpTKqym93whYk93l3ocEe55c0CAwEAAaOBnjCBmzAJBgNVHRMEAjAAMCwGCWCG\n" + "SAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNVHQ4E\n" + "FgQUnxR3vz86tso4gkJIFiza0Mteh9gwHwYDVR0jBBgwFoAUe5raj5CZTlLSrNuz\n" + "A1LKh6YNPg0wIAYDVR0RBBkwF4IHYmFyLmNvbYIM6Iqx5a2QLmNvLmpwMA0GCSqG\n" + "SIb3DQEBBQUAA4IBAQBeZs7ZIYyKtdnVxVvdLgwySEPOE4pBSXii7XYv0Q9QUvG/\n" + "++gFGQh89HhABzA1mVUjH5dJTQqSLFvRfqTHqLpxSxSWqMHnvRM4cPBkIRp/XlMK\n" + "PlXadYtJLPTgpbgvulA1ickC9EwlNYWnowZ4uxnfsMghW4HskBqaV+PnQ8Zvy3L0\n" + "12c7Cg4mKKS5pb1HdRuiD2opZ+Hc77gRQLvtWNS8jQvd/iTbh6fuvTKfAOFoXw22\n" + "sWIKHYrmhCIRshUNohGXv50m2o+1w9oWmQ6Dkq7lCjfXfUB4wIbggJjpyEtbNqBt\n" + "j4MC2x5rfsLKKqToKmNE7pFEgqwe8//Aar1b+Qj+\n" + "-----END CERTIFICATE-----\n").getBytes(); /** * CN=*.foo.com */ public final static byte[] X509_WILD_FOO = ( "-----BEGIN CERTIFICATE-----\n" + "MIIESDCCAzCgAwIBAgIJAIz+EYMBU6aUMA0GCSqGSIb3DQEBBQUAMIGiMQswCQYD\n" + "VQQGEwJDQTELMAkGA1UECBMCQkMxEjAQBgNVBAcTCVZhbmNvdXZlcjEWMBQGA1UE\n" + "ChMNd3d3LmN1Y2JjLmNvbTEUMBIGA1UECxQLY29tbW9uc19zc2wxHTAbBgNVBAMU\n" + "FGRlbW9faW50ZXJtZWRpYXRlX2NhMSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZp\n" + "ZXNAZ21haWwuY29tMB4XDTA2MTIxMTE2MTU1NVoXDTI4MTEwNTE2MTU1NVowgaYx\n" + "CzAJBgNVBAYTAlVTMREwDwYDVQQIEwhNYXJ5bGFuZDEUMBIGA1UEBxMLRm9yZXN0\n" + "IEhpbGwxFzAVBgNVBAoTDmh0dHBjb21wb25lbnRzMRowGAYDVQQLExF0ZXN0IGNl\n" + "cnRpZmljYXRlczESMBAGA1UEAxQJKi5mb28uY29tMSUwIwYJKoZIhvcNAQkBFhZq\n" + "dWxpdXNkYXZpZXNAZ21haWwuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\n" + "CgKCAQEAyGOvloI+jKnRHWKuhYB+cTIEwZhagKJ0f3rIY8WNgujB7PlpgpjUg4pN\n" + "jYGViGjg7zhfbjhCtlNGXyRBti3GcaHiBIIP5nyCNn+Ay8tSWGo5v5Zc8BQcwHf0\n" + "ZHLN6sD9m2uVSp/6UqjS5ZyhzF5FzvvUo3xw8fecdnStXQfHhkBnLpTjHE5t7iu1\n" + "JVjTuE0pcBvah2dWqDNxiIOQtXyKW8Sag1YxaunxQGqRNykSFiEJindxOSAnAxK6\n" + "q/wGqcZ3zvFBTcVVkji1u2QH4rOMP3PPxAIMkB8ONkdHTco1DmbE6BfDHArDqUYx\n" + "qJUlPGlMqrKb3fCFiT3eXehwR7nlzQIDAQABo3sweTAJBgNVHRMEAjAAMCwGCWCG\n" + "SAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNVHQ4E\n" + "FgQUnxR3vz86tso4gkJIFiza0Mteh9gwHwYDVR0jBBgwFoAUe5raj5CZTlLSrNuz\n" + "A1LKh6YNPg0wDQYJKoZIhvcNAQEFBQADggEBAH0ipG6J561UKUfgkeW7GvYwW98B\n" + "N1ZooWX+JEEZK7+Pf/96d3Ij0rw9ACfN4bpfnCq0VUNZVSYB+GthQ2zYuz7tf/UY\n" + "A6nxVgR/IjG69BmsBl92uFO7JTNtHztuiPqBn59pt+vNx4yPvno7zmxsfI7jv0ww\n" + "yfs+0FNm7FwdsC1k47GBSOaGw38kuIVWqXSAbL4EX9GkryGGOKGNh0qvAENCdRSB\n" + "G9Z6tyMbmfRY+dLSh3a9JwoEcBUso6EWYBakLbq4nG/nvYdYvG9ehrnLVwZFL82e\n" + "l3Q/RK95bnA6cuRClGusLad0e6bjkBzx/VQ3VarDEpAkTLUGVAa0CLXtnyc=\n" + "-----END CERTIFICATE-----\n").getBytes(); /** * CN=*.co.jp */ public final static byte[] X509_WILD_CO_JP = ( "-----BEGIN CERTIFICATE-----\n" + "MIIERjCCAy6gAwIBAgIJAIz+EYMBU6aVMA0GCSqGSIb3DQEBBQUAMIGiMQswCQYD\n" + "VQQGEwJDQTELMAkGA1UECBMCQkMxEjAQBgNVBAcTCVZhbmNvdXZlcjEWMBQGA1UE\n" + "ChMNd3d3LmN1Y2JjLmNvbTEUMBIGA1UECxQLY29tbW9uc19zc2wxHTAbBgNVBAMU\n" + "FGRlbW9faW50ZXJtZWRpYXRlX2NhMSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZp\n" + "ZXNAZ21haWwuY29tMB4XDTA2MTIxMTE2MTYzMFoXDTI4MTEwNTE2MTYzMFowgaQx\n" + "CzAJBgNVBAYTAlVTMREwDwYDVQQIEwhNYXJ5bGFuZDEUMBIGA1UEBxMLRm9yZXN0\n" + "IEhpbGwxFzAVBgNVBAoTDmh0dHBjb21wb25lbnRzMRowGAYDVQQLExF0ZXN0IGNl\n" + "cnRpZmljYXRlczEQMA4GA1UEAxQHKi5jby5qcDElMCMGCSqGSIb3DQEJARYWanVs\n" + "aXVzZGF2aWVzQGdtYWlsLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC\n" + "ggEBAMhjr5aCPoyp0R1iroWAfnEyBMGYWoCidH96yGPFjYLowez5aYKY1IOKTY2B\n" + "lYho4O84X244QrZTRl8kQbYtxnGh4gSCD+Z8gjZ/gMvLUlhqOb+WXPAUHMB39GRy\n" + "zerA/ZtrlUqf+lKo0uWcocxeRc771KN8cPH3nHZ0rV0Hx4ZAZy6U4xxObe4rtSVY\n" + "07hNKXAb2odnVqgzcYiDkLV8ilvEmoNWMWrp8UBqkTcpEhYhCYp3cTkgJwMSuqv8\n" + "BqnGd87xQU3FVZI4tbtkB+KzjD9zz8QCDJAfDjZHR03KNQ5mxOgXwxwKw6lGMaiV\n" + "JTxpTKqym93whYk93l3ocEe55c0CAwEAAaN7MHkwCQYDVR0TBAIwADAsBglghkgB\n" + "hvhCAQ0EHxYdT3BlblNTTCBHZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0OBBYE\n" + "FJ8Ud78/OrbKOIJCSBYs2tDLXofYMB8GA1UdIwQYMBaAFHua2o+QmU5S0qzbswNS\n" + "yoemDT4NMA0GCSqGSIb3DQEBBQUAA4IBAQA0sWglVlMx2zNGvUqFC73XtREwii53\n" + "CfMM6mtf2+f3k/d8KXhLNySrg8RRlN11zgmpPaLtbdTLrmG4UdAHHYr8O4y2BBmE\n" + "1cxNfGxxechgF8HX10QV4dkyzp6Z1cfwvCeMrT5G/V1pejago0ayXx+GPLbWlNeZ\n" + "S+Kl0m3p+QplXujtwG5fYcIpaGpiYraBLx3Tadih39QN65CnAh/zRDhLCUzKyt9l\n" + "UGPLEUDzRHMPHLnSqT1n5UU5UDRytbjJPXzF+l/+WZIsanefWLsxnkgAuZe/oMMF\n" + "EJMryEzOjg4Tfuc5qM0EXoPcQ/JlheaxZ40p2IyHqbsWV4MRYuFH4bkM\n" + "-----END CERTIFICATE-----\n").getBytes(); /** * CN=*.foo.com, subjectAlt=*.bar.com, subjectAlt=*.花子.co.jp * (*.hanako.co.jp in kanji) */ public final static byte[] X509_WILD_FOO_BAR_HANAKO = ( "-----BEGIN CERTIFICATE-----\n" + "MIIEcDCCA1igAwIBAgIJAIz+EYMBU6aWMA0GCSqGSIb3DQEBBQUAMIGiMQswCQYD\n" + "VQQGEwJDQTELMAkGA1UECBMCQkMxEjAQBgNVBAcTCVZhbmNvdXZlcjEWMBQGA1UE\n" + "ChMNd3d3LmN1Y2JjLmNvbTEUMBIGA1UECxQLY29tbW9uc19zc2wxHTAbBgNVBAMU\n" + "FGRlbW9faW50ZXJtZWRpYXRlX2NhMSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZp\n" + "ZXNAZ21haWwuY29tMB4XDTA2MTIxMTE2MTczMVoXDTI4MTEwNTE2MTczMVowgaYx\n" + "CzAJBgNVBAYTAlVTMREwDwYDVQQIEwhNYXJ5bGFuZDEUMBIGA1UEBxMLRm9yZXN0\n" + "IEhpbGwxFzAVBgNVBAoTDmh0dHBjb21wb25lbnRzMRowGAYDVQQLExF0ZXN0IGNl\n" + "cnRpZmljYXRlczESMBAGA1UEAxQJKi5mb28uY29tMSUwIwYJKoZIhvcNAQkBFhZq\n" + "dWxpdXNkYXZpZXNAZ21haWwuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\n" + "CgKCAQEAyGOvloI+jKnRHWKuhYB+cTIEwZhagKJ0f3rIY8WNgujB7PlpgpjUg4pN\n" + "jYGViGjg7zhfbjhCtlNGXyRBti3GcaHiBIIP5nyCNn+Ay8tSWGo5v5Zc8BQcwHf0\n" + "ZHLN6sD9m2uVSp/6UqjS5ZyhzF5FzvvUo3xw8fecdnStXQfHhkBnLpTjHE5t7iu1\n" + "JVjTuE0pcBvah2dWqDNxiIOQtXyKW8Sag1YxaunxQGqRNykSFiEJindxOSAnAxK6\n" + "q/wGqcZ3zvFBTcVVkji1u2QH4rOMP3PPxAIMkB8ONkdHTco1DmbE6BfDHArDqUYx\n" + "qJUlPGlMqrKb3fCFiT3eXehwR7nlzQIDAQABo4GiMIGfMAkGA1UdEwQCMAAwLAYJ\n" + "YIZIAYb4QgENBB8WHU9wZW5TU0wgR2VuZXJhdGVkIENlcnRpZmljYXRlMB0GA1Ud\n" + "DgQWBBSfFHe/Pzq2yjiCQkgWLNrQy16H2DAfBgNVHSMEGDAWgBR7mtqPkJlOUtKs\n" + "27MDUsqHpg0+DTAkBgNVHREEHTAbggkqLmJhci5jb22CDiou6Iqx5a2QLmNvLmpw\n" + "MA0GCSqGSIb3DQEBBQUAA4IBAQBobWC+D5/lx6YhX64CwZ26XLjxaE0S415ajbBq\n" + "DK7lz+Rg7zOE3GsTAMi+ldUYnhyz0wDiXB8UwKXl0SDToB2Z4GOgqQjAqoMmrP0u\n" + "WB6Y6dpkfd1qDRUzI120zPYgSdsXjHW9q2H77iV238hqIU7qCvEz+lfqqWEY504z\n" + "hYNlknbUnR525ItosEVwXFBJTkZ3Yw8gg02c19yi8TAh5Li3Ad8XQmmSJMWBV4XK\n" + "qFr0AIZKBlg6NZZFf/0dP9zcKhzSriW27bY0XfzA6GSiRDXrDjgXq6baRT6YwgIg\n" + "pgJsDbJtZfHnV1nd3M6zOtQPm1TIQpNmMMMd/DPrGcUQerD3\n" + "-----END CERTIFICATE-----\n").getBytes(); /** * CN=foo.com, CN=bar.com, CN=花子.co.jp */ public final static byte[] X509_THREE_CNS_FOO_BAR_HANAKO = ( "-----BEGIN CERTIFICATE-----\n" + "MIIEbzCCA1egAwIBAgIJAIz+EYMBU6aXMA0GCSqGSIb3DQEBBQUAMIGiMQswCQYD\n" + "VQQGEwJDQTELMAkGA1UECBMCQkMxEjAQBgNVBAcTCVZhbmNvdXZlcjEWMBQGA1UE\n" + "ChMNd3d3LmN1Y2JjLmNvbTEUMBIGA1UECxQLY29tbW9uc19zc2wxHTAbBgNVBAMU\n" + "FGRlbW9faW50ZXJtZWRpYXRlX2NhMSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZp\n" + "ZXNAZ21haWwuY29tMB4XDTA2MTIxMTE2MTk0NVoXDTI4MTEwNTE2MTk0NVowgc0x\n" + "CzAJBgNVBAYTAlVTMREwDwYDVQQIDAhNYXJ5bGFuZDEUMBIGA1UEBwwLRm9yZXN0\n" + "IEhpbGwxFzAVBgNVBAoMDmh0dHBjb21wb25lbnRzMRowGAYDVQQLDBF0ZXN0IGNl\n" + "cnRpZmljYXRlczEQMA4GA1UEAwwHZm9vLmNvbTEQMA4GA1UEAwwHYmFyLmNvbTEV\n" + "MBMGA1UEAwwM6Iqx5a2QLmNvLmpwMSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZp\n" + "ZXNAZ21haWwuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyGOv\n" + "loI+jKnRHWKuhYB+cTIEwZhagKJ0f3rIY8WNgujB7PlpgpjUg4pNjYGViGjg7zhf\n" + "bjhCtlNGXyRBti3GcaHiBIIP5nyCNn+Ay8tSWGo5v5Zc8BQcwHf0ZHLN6sD9m2uV\n" + "Sp/6UqjS5ZyhzF5FzvvUo3xw8fecdnStXQfHhkBnLpTjHE5t7iu1JVjTuE0pcBva\n" + "h2dWqDNxiIOQtXyKW8Sag1YxaunxQGqRNykSFiEJindxOSAnAxK6q/wGqcZ3zvFB\n" + "TcVVkji1u2QH4rOMP3PPxAIMkB8ONkdHTco1DmbE6BfDHArDqUYxqJUlPGlMqrKb\n" + "3fCFiT3eXehwR7nlzQIDAQABo3sweTAJBgNVHRMEAjAAMCwGCWCGSAGG+EIBDQQf\n" + "Fh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNVHQ4EFgQUnxR3vz86\n" + "tso4gkJIFiza0Mteh9gwHwYDVR0jBBgwFoAUe5raj5CZTlLSrNuzA1LKh6YNPg0w\n" + "DQYJKoZIhvcNAQEFBQADggEBAGuZb8ai1NO2j4v3y9TLZvd5s0vh5/TE7n7RX+8U\n" + "y37OL5k7x9nt0mM1TyAKxlCcY+9h6frue8MemZIILSIvMrtzccqNz0V1WKgA+Orf\n" + "uUrabmn+CxHF5gpy6g1Qs2IjVYWA5f7FROn/J+Ad8gJYc1azOWCLQqSyfpNRLSvY\n" + "EriQFEV63XvkJ8JrG62b+2OT2lqT4OO07gSPetppdlSa8NBSKP6Aro9RIX1ZjUZQ\n" + "SpQFCfo02NO0uNRDPUdJx2huycdNb+AXHaO7eXevDLJ+QnqImIzxWiY6zLOdzjjI\n" + "VBMkLHmnP7SjGSQ3XA4ByrQOxfOUTyLyE7NuemhHppuQPxE=\n" + "-----END CERTIFICATE-----\n").getBytes(); /** * subjectAlt=foo.com */ public final static byte[] X509_NO_CNS_FOO = ( "-----BEGIN CERTIFICATE-----\n" + "MIIESjCCAzKgAwIBAgIJAIz+EYMBU6aYMA0GCSqGSIb3DQEBBQUAMIGiMQswCQYD\n" + "VQQGEwJDQTELMAkGA1UECBMCQkMxEjAQBgNVBAcTCVZhbmNvdXZlcjEWMBQGA1UE\n" + "ChMNd3d3LmN1Y2JjLmNvbTEUMBIGA1UECxQLY29tbW9uc19zc2wxHTAbBgNVBAMU\n" + "FGRlbW9faW50ZXJtZWRpYXRlX2NhMSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZp\n" + "ZXNAZ21haWwuY29tMB4XDTA2MTIxMTE2MjYxMFoXDTI4MTEwNTE2MjYxMFowgZIx\n" + "CzAJBgNVBAYTAlVTMREwDwYDVQQIDAhNYXJ5bGFuZDEUMBIGA1UEBwwLRm9yZXN0\n" + "IEhpbGwxFzAVBgNVBAoMDmh0dHBjb21wb25lbnRzMRowGAYDVQQLDBF0ZXN0IGNl\n" + "cnRpZmljYXRlczElMCMGCSqGSIb3DQEJARYWanVsaXVzZGF2aWVzQGdtYWlsLmNv\n" + "bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMhjr5aCPoyp0R1iroWA\n" + "fnEyBMGYWoCidH96yGPFjYLowez5aYKY1IOKTY2BlYho4O84X244QrZTRl8kQbYt\n" + "xnGh4gSCD+Z8gjZ/gMvLUlhqOb+WXPAUHMB39GRyzerA/ZtrlUqf+lKo0uWcocxe\n" + "Rc771KN8cPH3nHZ0rV0Hx4ZAZy6U4xxObe4rtSVY07hNKXAb2odnVqgzcYiDkLV8\n" + "ilvEmoNWMWrp8UBqkTcpEhYhCYp3cTkgJwMSuqv8BqnGd87xQU3FVZI4tbtkB+Kz\n" + "jD9zz8QCDJAfDjZHR03KNQ5mxOgXwxwKw6lGMaiVJTxpTKqym93whYk93l3ocEe5\n" + "5c0CAwEAAaOBkDCBjTAJBgNVHRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NM\n" + "IEdlbmVyYXRlZCBDZXJ0aWZpY2F0ZTAdBgNVHQ4EFgQUnxR3vz86tso4gkJIFiza\n" + "0Mteh9gwHwYDVR0jBBgwFoAUe5raj5CZTlLSrNuzA1LKh6YNPg0wEgYDVR0RBAsw\n" + "CYIHZm9vLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEAjl78oMjzFdsMy6F1sGg/IkO8\n" + "tF5yUgPgFYrs41yzAca7IQu6G9qtFDJz/7ehh/9HoG+oqCCIHPuIOmS7Sd0wnkyJ\n" + "Y7Y04jVXIb3a6f6AgBkEFP1nOT0z6kjT7vkA5LJ2y3MiDcXuRNMSta5PYVnrX8aZ\n" + "yiqVUNi40peuZ2R8mAUSBvWgD7z2qWhF8YgDb7wWaFjg53I36vWKn90ZEti3wNCw\n" + "qAVqixM+J0qJmQStgAc53i2aTMvAQu3A3snvH/PHTBo+5UL72n9S1kZyNCsVf1Qo\n" + "n8jKTiRriEM+fMFlcgQP284EBFzYHyCXFb9O/hMjK2+6mY9euMB1U1aFFzM/Bg==\n" + "-----END CERTIFICATE-----\n").getBytes(); /** * Intermediate CA for all of these. */ public final static byte[] X509_INTERMEDIATE_CA = ( "-----BEGIN CERTIFICATE-----\n" + "MIIEnDCCA4SgAwIBAgIJAJTNwZ6yNa5cMA0GCSqGSIb3DQEBBQUAMIGGMQswCQYD\n" + "VQQGEwJDQTELMAkGA1UECBMCQkMxFjAUBgNVBAoTDXd3dy5jdWNiYy5jb20xFDAS\n" + "BgNVBAsUC2NvbW1vbnNfc3NsMRUwEwYDVQQDFAxkZW1vX3Jvb3RfY2ExJTAjBgkq\n" + "hkiG9w0BCQEWFmp1bGl1c2Rhdmllc0BnbWFpbC5jb20wHhcNMDYxMTA1MjE0OTMx\n" + "WhcNMDcxMTA1MjE0OTMxWjCBojELMAkGA1UEBhMCQ0ExCzAJBgNVBAgTAkJDMRIw\n" + "EAYDVQQHEwlWYW5jb3V2ZXIxFjAUBgNVBAoTDXd3dy5jdWNiYy5jb20xFDASBgNV\n" + "BAsUC2NvbW1vbnNfc3NsMR0wGwYDVQQDFBRkZW1vX2ludGVybWVkaWF0ZV9jYTEl\n" + "MCMGCSqGSIb3DQEJARYWanVsaXVzZGF2aWVzQGdtYWlsLmNvbTCCASIwDQYJKoZI\n" + "hvcNAQEBBQADggEPADCCAQoCggEBAL0S4y3vUO0EM6lwqOEfK8fvrUprIbsikXaG\n" + "XzejcZ+T3l2Dc7t8WtBfRf78i4JypMqJQSijrUicj3H6mOMIReKaXm6ls4hA5d8w\n" + "Lhmgiqsz/kW+gA8SeWGWRN683BD/RbQmzOls6ynBvap9jZlthXWBrSIlPCQoBLXY\n" + "KVaxGzbL4ezaq+XFMKMQSm2uKwVmHHQNbfmZlPsuendBVomb/ked53Ab9IH6dwwN\n" + "qJH9WIrvIzIVEXWlpvQ5MCqozM7u1akU+G8cazr8theGPCaYkzoXnigWua4OjdpV\n" + "9z5ZDknhfBzG1AjapdG07FIirwWWgIyZXqZSD96ikmLtwT29qnsCAwEAAaOB7jCB\n" + "6zAdBgNVHQ4EFgQUe5raj5CZTlLSrNuzA1LKh6YNPg0wgbsGA1UdIwSBszCBsIAU\n" + "rN8eFIvMiRFXXgDqKumS0/W2AhOhgYykgYkwgYYxCzAJBgNVBAYTAkNBMQswCQYD\n" + "VQQIEwJCQzEWMBQGA1UEChMNd3d3LmN1Y2JjLmNvbTEUMBIGA1UECxQLY29tbW9u\n" + "c19zc2wxFTATBgNVBAMUDGRlbW9fcm9vdF9jYTElMCMGCSqGSIb3DQEJARYWanVs\n" + "aXVzZGF2aWVzQGdtYWlsLmNvbYIJAJTNwZ6yNa5bMAwGA1UdEwQFMAMBAf8wDQYJ\n" + "KoZIhvcNAQEFBQADggEBAIB4KMZvHD20pdKajFtMBpL7X4W4soq6EeTtjml3NYa9\n" + "Qc52bsQEGNccKY9afYSBIndaQvFdtmz6HdoN+B8TjYShw2KhyjtKimGLpWYoi1YF\n" + "e4aHdmA/Gp5xk8pZzR18FmooxC9RqBux+NAM2iTFSLgDtGIIj4sg2rbn6Bb6ZlQT\n" + "1rg6VucXCA1629lNfMeNcu7CBNmUKIdaxHR/YJQallE0KfGRiOIWPrPj/VNk0YA6\n" + "XFg0ocjqXJ2/N0N9rWVshMUaXgOh7m4D/5zga5/nuxDU+PoToA6mQ4bV6eCYqZbh\n" + "aa1kQYtR9B4ZiG6pB82qVc2dCqStOH2FAEWos2gAVkQ=\n" + "-----END CERTIFICATE-----\n").getBytes(); /** * Root CA for all of these. */ public final static byte[] X509_ROOT_CA = ( "-----BEGIN CERTIFICATE-----\n" + "MIIEgDCCA2igAwIBAgIJAJTNwZ6yNa5bMA0GCSqGSIb3DQEBBQUAMIGGMQswCQYD\n" + "VQQGEwJDQTELMAkGA1UECBMCQkMxFjAUBgNVBAoTDXd3dy5jdWNiYy5jb20xFDAS\n" + "BgNVBAsUC2NvbW1vbnNfc3NsMRUwEwYDVQQDFAxkZW1vX3Jvb3RfY2ExJTAjBgkq\n" + "hkiG9w0BCQEWFmp1bGl1c2Rhdmllc0BnbWFpbC5jb20wHhcNMDYxMTA1MjEzNjQz\n" + "WhcNMjYxMTA1MjEzNjQzWjCBhjELMAkGA1UEBhMCQ0ExCzAJBgNVBAgTAkJDMRYw\n" + "FAYDVQQKEw13d3cuY3VjYmMuY29tMRQwEgYDVQQLFAtjb21tb25zX3NzbDEVMBMG\n" + "A1UEAxQMZGVtb19yb290X2NhMSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZpZXNA\n" + "Z21haWwuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAv+OnocmJ\n" + "79UeO2hlCwK+Cle5uZWnU6uwJl+08z5cvebb5tT64WL9+psDbfgUH/Gm9JsuxKTg\n" + "w1tZO/4duIgnaLNSx4HoqaTjwigd/hR3TsoGEPXTCkz1ikgTCOEDvl+iMid6aOrd\n" + "mViE8HhscxKZ+h5FE7oHZyuT6gFoiaIXhFq+xK2w4ZwDz9L+paiwqywyUJJMnh9U\n" + "jKorY+nua81N0oxpIhHPspCanDU4neMzCzYOZyLR/LqV5xORvHcFY84GWMz5hI25\n" + "JbgaWJsYKuCAvNsnQwVoqKPGa7x1fn7x6oGsXJaCVt8weUwIj2xwg1lxMhrNaisH\n" + "EvKpEAEnGGwWKQIDAQABo4HuMIHrMB0GA1UdDgQWBBSs3x4Ui8yJEVdeAOoq6ZLT\n" + "9bYCEzCBuwYDVR0jBIGzMIGwgBSs3x4Ui8yJEVdeAOoq6ZLT9bYCE6GBjKSBiTCB\n" + "hjELMAkGA1UEBhMCQ0ExCzAJBgNVBAgTAkJDMRYwFAYDVQQKEw13d3cuY3VjYmMu\n" + "Y29tMRQwEgYDVQQLFAtjb21tb25zX3NzbDEVMBMGA1UEAxQMZGVtb19yb290X2Nh\n" + "MSUwIwYJKoZIhvcNAQkBFhZqdWxpdXNkYXZpZXNAZ21haWwuY29tggkAlM3BnrI1\n" + "rlswDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOCAQEAlPl3/8h1LttR1svC\n" + "S8RXbHpAWIT2BEDhGHUNjSmgDQNkE/itf/FCEXh0tlU4bYdtBSOHzflbnzOyIPId\n" + "VZeSWs33V38xDFy6KoVg1gT8JxkLmE5S1vWkpsHIlpw/U6r7KD0Kx9FYx5AiXjw0\n" + "lzz/zlVNuO2U09KIDwDPVG1mBzQiMiSWj1U1pM4KxINkWQwDy/fvu/I983s8lW5z\n" + "hf2WuFNzQN3fcMK5dpBE9NVIu27oYuGYh2sak34v+7T700W2ooBB71qFXtm9P5rl\n" + "Yp9RCEsg3KEEPNTtCBs8fROeXvLDrP0cmBIqwGYDuRNCxFDTOdjv6YGdA8nLOjaH\n" + "2dDk0g==\n" + "-----END CERTIFICATE-----\n").getBytes(); /** * Below is the private key for all the server certificates above (but * not the intermediate CA or the root CA). All of those server certs * came from the same private key. */ public final static String RSA_PUBLIC_MODULUS = "00c863af96823e8ca9d11d62ae85807e713204c1985a80a2747f7ac863c5" + "8d82e8c1ecf9698298d4838a4d8d81958868e0ef385f6e3842b653465f24" + "41b62dc671a1e204820fe67c82367f80cbcb52586a39bf965cf0141cc077" + "f46472cdeac0fd9b6b954a9ffa52a8d2e59ca1cc5e45cefbd4a37c70f1f7" + "9c7674ad5d07c78640672e94e31c4e6dee2bb52558d3b84d29701bda8767" + "56a83371888390b57c8a5bc49a8356316ae9f1406a913729121621098a77" + "713920270312baabfc06a9c677cef1414dc5559238b5bb6407e2b38c3f73" + "cfc4020c901f0e3647474dca350e66c4e817c31c0ac3a94631a895253c69" + "4caab29bddf085893dde5de87047b9e5cd"; public final static String RSA_PUBLIC_EXPONENT = "65537"; public final static String RSA_PRIVATE_EXPONENT = "577abd3295553d0efd4d38c13b62a6d03fa7b7e40cce4f1d5071877d96c6" + "7a39a63f0f7ab21a89db8acae45587b3ef251309a70f74dc1ac02bde68f3" + "8ed658e54e685ed370a18c054449512ea66a2252ed36e82b565b5159ec83" + "f23df40ae189550a183865b25fd77789e960f0d8cedcd72f32d7a66edb4b" + "a0a2baf3fbeb6c7d75f56ef0af9a7cff1c8c7f297d72eae7982164e50a89" + "d450698cf598d39343201094241d2d180a95882a7111e58f4a5bdbc5c125" + "a967dd6ed9ec614c5853e88e4c71e8b682a7cf89cb1d82b6fe78cc865084" + "c8c5dfbb50c939df2b839c977b0245bfa3615e0592b527b1013d5b675ecb" + "44e6b355c1df581f50997175166eef39"; public final static String RSA_PRIME1 = "00fe759c4f0ce8b763880215e82767e7a937297668f4e4b1e119c6b22a3c" + "a2c7b06c547d88d0aa45f645d7d3aeadaf7f8bc594deae0978529592977c" + "b1ff890f05033a9e9e15551cad9fbf9c41d12139ccd99c1c3ac7b2197eff" + "350d236bb900c1440953b64956e0a058ef824a2e16894af175177c77dbe1" + "fef7d8b532608d2513"; public final static String RSA_PRIME2 = "00c99a45878737a4cf73f9896680b75487f1b669b7686a6ba07103856f31" + "db668c2c440c44cdd116f708f631c37a9adf119f5b5cb58ffe3dc62e20af" + "af72693d936dc6bb3c5194996468389c1f094079b81522e94572b4ad7d39" + "529178e9b8ebaeb1f0fdd83b8731c5223f1dea125341d1d64917f6b1a6ae" + "c18d320510d79f859f"; public final static String RSA_EXPONENT1 = "029febf0d4cd41b7011c2465b4a259bd6118486464c247236f44a169d61e" + "47b9062508f674508d5031003ceabc57e714e600d71b2c75d5443db2da52" + "6bb45a374f0537c5a1aab3150764ce93cf386c84346a6bd01f6732e42075" + "c7a0e9e78a9e73b934e7d871d0f75673820089e129a1604438edcbbeb4e2" + "106467da112ce389"; public final static String RSA_EXPONENT2 = "00827e76650c946afcd170038d32e1f8386ab00d6be78d830efe382e45d4" + "7ad4bd04e6231ee22e66740efbf52838134932c9f8c460cdccdec58a1424" + "4427859192fd6ab6c58b74e97941b0eaf577f2a11713af5e5952af3ae124" + "9a9a892e98410dfa2628d9af668a43b5302fb7d496c9b2fec69f595292b6" + "e997f079b0f6314eb7"; public final static String RSA_COEFFICIENT = "00e6b62add350f1a2a8968903ff76c31cf703b0d7326c4a620aef01225b7" + "1640b3f2ec375208c5f7299863f6005b7799b6e529bb1133c8435bf5fdb5" + "a786f6cd8a19ee7094a384e6557c600a38845a0960ddbfd1df18d0af5740" + "001853788f1b5ccbf9affb4c52c9d2efdb8aab0183d86735b32737fb4e79" + "2b8a9c7d91c7d175ae"; /** * subjectAlt=IP Address:127.0.0.1, email:oleg@ural.ru, DNS:localhost.localdomain */ public final static byte[] X509_MULTIPLE_SUBJECT_ALT = ( "-----BEGIN CERTIFICATE-----\n" + "MIIDcTCCAtqgAwIBAgIBATANBgkqhkiG9w0BAQUFADBAMQswCQYDVQQGEwJDSDEL\n" + "MAkGA1UECBMCWkgxDzANBgNVBAcTBlp1cmljaDETMBEGA1UEAxMKTXkgVGVzdCBD\n" + "QTAeFw0wODEwMzExMTU3NDVaFw0wOTEwMzExMTU3NDVaMGkxCzAJBgNVBAYTAkNI\n" + "MRAwDgYDVQQIEwdVbmtub3duMRAwDgYDVQQHEwdVbmtub3duMRAwDgYDVQQKEwdV\n" + "bmtub3duMRAwDgYDVQQLEwdVbmtub3duMRIwEAYDVQQDEwlsb2NhbGhvc3QwggG4\n" + "MIIBLAYHKoZIzjgEATCCAR8CgYEA/X9TgR11EilS30qcLuzk5/YRt1I870QAwx4/\n" + "gLZRJmlFXUAiUftZPY1Y+r/F9bow9subVWzXgTuAHTRv8mZgt2uZUKWkn5/oBHsQ\n" + "IsJPu6nX/rfGG/g7V+fGqKYVDwT7g/bTxR7DAjVUE1oWkTL2dfOuK2HXKu/yIgMZ\n" + "ndFIAccCFQCXYFCPFSMLzLKSuYKi64QL8Fgc9QKBgQD34aCF1ps93su8q1w2uFe5\n" + "eZSvu/o66oL5V0wLPQeCZ1FZV4661FlP5nEHEIGAtEkWcSPoTCgWE7fPCTKMyKbh\n" + "PBZ6i1R8jSjgo64eK7OmdZFuo38L+iE1YvH7YnoBJDvMpPG+qFGQiaiD3+Fa5Z8G\n" + "kotmXoB7VSVkAUw7/s9JKgOBhQACgYEA6ogAb/YLM1Rz9AoXKW4LA70VtFf7Mqqp\n" + "divdu9f72WQc1vMKo1YMf3dQadkMfBYRvAAa1IXDnoiFCHhXnVRkWkoUBJyNebLB\n" + "N92CZc0RVFZiMFgQMEh8UldnvAIi4cBk0/YuN3BGl4MzmquVIGrFovdWGqeaveOu\n" + "Xcu4lKGJNiqjODA2MDQGA1UdEQQtMCuHBH8AAAGBDG9sZWdAdXJhbC5ydYIVbG9j\n" + "YWxob3N0LmxvY2FsZG9tYWluMA0GCSqGSIb3DQEBBQUAA4GBAIgEwIoCSRkU3O7K\n" + "USYaOYyfJB9hsvs6YpClvYXiQ/5kPGARP60pM62v4wC7wI9shEizokIAxY2+O3cC\n" + "vwuJhNYaa2FJMELIwRN3XES8X8R6JHWbPaRjaAAPhczuEd8SZYy8yiVLmJTgw0gH\n" + "BSW775NHlkjsscFVgXkNf0PobqJ9\n" + "-----END CERTIFICATE-----").getBytes(); /** * subject CN=repository.infonotary.com (Multiple AVA in RDN). */ public final static byte[] X509_MULTIPLE_VALUE_AVA = ( "-----BEGIN CERTIFICATE-----\n" + "MIIFxzCCBK+gAwIBAgIIRO/2+/XA7z4wDQYJKoZIhvcNAQEFBQAwgZwxgZkwCQYD\n" + "VQQGDAJCRzAVBgNVBAoMDkluZm9Ob3RhcnkgUExDMBcGCgmSJomT8ixkARkWCWRv\n" + "bWFpbi1jYTAtBgNVBAMMJmktTm90YXJ5IFRydXN0UGF0aCBWYWxpZGF0ZWQgRG9t\n" + "YWluIENBMC0GA1UECwwmaS1Ob3RhcnkgVHJ1c3RQYXRoIFZhbGlkYXRlZCBEb21h\n" + "aW4gQ0EwHhcNMTIwNjE4MDg1MzIyWhcNMTMwNjE4MDg1MzIyWjCBxjGBwzAJBgNV\n" + "BAYTAkJHMBUGA1UEChMOSW5mb05vdGFyeSBQTEMwFwYDVQQLExBGaWxlcyBSZXBv\n" + "c2l0b3J5MBcGCgmSJomT8ixkARkWCWRvbWFpbi1jYTAgBgNVBAMTGXJlcG9zaXRv\n" + "cnkuaW5mb25vdGFyeS5jb20wIwYJKoZIhvcNAQkBFhZzdXBwb3J0QGluZm9ub3Rh\n" + "cnkuY29tMCYGCSqGSIb3DQEJAhMZcmVwb3NpdG9yeS5pbmZvbm90YXJ5LmNvbTCC\n" + "ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALKWjGpgsuz103xVEW/GSg5I\n" + "tBoLbXPxockabOTHnOh0VO2sImycyhBH78nMj+VMexn4y+kdCOuJqAA5LApxyhTA\n" + "KgKlRN7TfoC90IYHjB1dqLMIseg4YM7Oe0e4Z2nL50bHoqXg7OUHaILUQn7ufpYp\n" + "+VCWxyI43KvaR4+HnST3x47wqeArg/rULGV1a16X+46cxq2eoMAcDfostXHaemvz\n" + "vg/Wd5xcWfPbF/oY1/sBXH+AK+peVBMen82+3GtAWtNWbyPE3bT4RG+WgKUyfLZ1\n" + "7A67rX9DkUEVMPQpa50MpLnrRveiM9w6R3mrMHMHbNnwID0Tqfds5zzOi/7cLD0C\n" + "AwEAAaOCAd8wggHbMA4GA1UdDwEB/wQEAwIDuDATBgNVHSUEDDAKBggrBgEFBQcD\n" + "ATBEBggrBgEFBQcBAQQ4MDYwNAYIKwYBBQUHMAGGKGh0dHA6Ly9vY3NwLmluZm9u\n" + "b3RhcnkuY29tL3Jlc3BvbmRlci5jZ2kwgZAGA1UdIASBiDCBhTCBggYMKwYBBAGB\n" + "rQABAgMBMHIwOAYIKwYBBQUHAgEWLGh0dHA6Ly9yZXBvc2l0b3J5LmluZm9ub3Rh\n" + "cnkuY29tL2RvbWFpbi5odG1sMDYGCCsGAQUFBwICMCoaKGktTm90YXJ5IFZhbGlk\n" + "YXRlZCBEb21haW4gQ2VydGlmaWNhdGUgQ1AwgYkGA1UdHwSBgTB/MDWgL6Athito\n" + "dHRwOi8vY3JsLmluZm9ub3RhcnkuY29tL2NybC9kb21haW4tY2EuY3JsgQIBVjBG\n" + "oECgPoY8bGRhcDovL2xkYXAuaW5mb25vdGFyeS5jb20vZGM9ZG9tYWluLWNhLGRj\n" + "PWluZm9ub3RhcnksZGM9Y29tgQIBVjAPBgNVHRMBAf8EBTADAQEAMB0GA1UdDgQW\n" + "BBTImKJZrgV/8n7mHrA0U5EeGsBvbzAfBgNVHSMEGDAWgBTbkorEK+bPdVPpvyVI\n" + "PTxGFnuOoDANBgkqhkiG9w0BAQUFAAOCAQEAhsMbqsqvkbfVaKZ+wDY9rX3EtuDS\n" + "isdAo4AjmWgTtj/aBGiEiXcIGP312x+0JF+mEEQ75ZOKN+WsM8eLB0F4aqylklk7\n" + "6yRYauRXp8dfbXrT3ozxekt0cpSMqbzze456krI12nL+C00V2Iwq96k5J/yZboNW\n" + "Q+ibCaEAHNiL4tGVHSHm6znkWvIuUTbDgDEsm5RdafO27suz5H6zMnV+VE6onN1J\n" + "I1mQmUs44cg2HZAqnFBpDyJQhNYy8M7yGVaRkbfuVaMqiPa+xDPR5v7NFB3kxRq2\n" + "Za2Snopi52eUxDEhJ0MNqFi3Jfj/ZSmJ+XHra5lU4R8lijCAq8SVLZCmIQ==\n" + "-----END CERTIFICATE-----").getBytes(); public final static byte[] S_GOOGLE_COM = ( "-----BEGIN CERTIFICATE-----\n" + "MIICpzCCAY+gAwIBAgIBATANBgkqhkiG9w0BAQUFADAXMRUwEwYDVQQDDAwqLmdv\n" + "b2dsZS5jb20wHhcNMTcwMTEzMjI0OTAzWhcNMTgwMTEzMjI0OTAzWjAXMRUwEwYD\n" + "VQQDDAwqLmdvb2dsZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB\n" + "AQDHuzznuHdJ5PH344xCyGYnUnIRhyLGBKN3WDLLrXWtr/5Sf3Q1qkiMiJ4BINsh\n" + "3Xy0z7VvHmMFlntgHXtkofBUPvTihxsVIypRkCZb5hpsWLotR10AW2JpVl/oxLP2\n" + "227/36X1zKh33fjImLJl9KzGWHLsbCBleQQJOn7YRsNR/QBZO0XGGkN/R2rRfLF3\n" + "rseRfI5gJjZkO0WDxocnf/iieOe0XNR0NAZaY1aozzPmZ/pRrOKYB8OFH7F73WOC\n" + "lPIUGai/byJ9SpbXdLUcMlGhml/4XzcnV/WVRD2P/mlY+xEFG3UEy3ufhNnKFJul\n" + "yjZrOaKbagamqtOyktzkjnerAgMBAAEwDQYJKoZIhvcNAQEFBQADggEBADaMcwVs\n" + "w5kbnoDJzMBJ01H16T4u8k78i/ybwz7u7krgkU0tABXCRj7S/4Dt3jqQ/rV6evj4\n" + "gIJ/2kZUp/PHKkV7CxWI48XBTAQUu9LEpxj0Hut3AtNMD9y/J6cFn2978tWsHFHI\n" + "mYgvclKUDE4WFMvuxfQVuX3RcGQ5i8khEMczY/KVhZYDcLU1PU0GTTJqqrQm59Z4\n" + "T4UyI3OPBR7Nb/kaU1fcgQ083uxRXcNYRMMZnU6c2oFnR+c6pO6aGoXo0C6rgC4R\n" + "pOj4hPvHCfZO2xg6HAdQ7UPALLX8pu5KGot7GRc8yiJ/Q1nBEuiPKKu0MIwQoFgP\n" + "WUux/APTsgLR7Vc=\n" + "-----END CERTIFICATE-----" ).getBytes(); public final static byte[] IP_1_1_1_1 = ( "-----BEGIN CERTIFICATE-----\n" + "MIICwjCCAaqgAwIBAgIBATANBgkqhkiG9w0BAQUFADAaMRgwFgYDVQQDEw9kdW1t\n" + "eS12YWx1ZS5jb20wHhcNMTcwMTEzMjI1MTQ2WhcNMTgwMTEzMjI1MTQ2WjAaMRgw\n" + "FgYDVQQDEw9kdW1teS12YWx1ZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\n" + "ggEKAoIBAQDfrapp3jHLp1RlElzpR/4sF9AcTYwMF1N+adkHRoVtmTlJV2lTIAjn\n" + "QLauy0Kkzv8uxmbID3uROgrFNDQ5RxTTCe+kW/vE6Pyzr5Z5ayjSTKeycTE7mAC4\n" + "6ntoCeEWiD593zlfqVo5PuRSp9Kusd+kexNVjC/BETDPa3yXctcH1ouW9GyGItgQ\n" + "u4GhCE8cipKMuTltgfK+Gh/5e9lFG9/F2fD+wHUVBULLR3JOQoqwgk2zAwKDwLuS\n" + "sEd1CBi35+W3apCKN0SEdTKIAxc/R+O/1j2hpOl9yXCCYyveGwJdFXVZtDcx+9/H\n" + "7NXhOdmw/mTXC5fOQGKciEo2SXt8Wp89AgMBAAGjEzARMA8GA1UdEQQIMAaHBAEB\n" + "AQEwDQYJKoZIhvcNAQEFBQADggEBAEAO6CE8twpcfdjk9oMjI5nX9GdC5Wt6+ujd\n" + "tLj0SbXvMKzCLLkveT0xTEzXfyEo8KW2qYYvPP1h83BIxsbR/J3Swt35UQVofv+4\n" + "JgO0FIdgB+iLEcjUh5+60xslylqWE+9bSWm4f06OXuv78tq5NYPZKku/3i4tqLRp\n" + "gH2rTtjX7Q4olSS7GdAgfiA2AnDZAbMtxtsnTt/QFpYQqhlkqHVDwgkGP7C8aMBD\n" + "RH0UIQCPxUkhwhtNmVyHO42r6oHXselZoVU6XRHuhogrGxPf/pzDUvrKBiJhsZQQ\n" + "oEu+pZCwkFLiNwUoq1G2oDpkkdBWB0JcBXB2Txa536ezFFWZYc0=\n" + "-----END CERTIFICATE-----" ).getBytes(); public final static byte[] EMAIL_ALT_SUBJECT_NAME = ( "-----BEGIN CERTIFICATE-----\n" + "MIIDpTCCAo2gAwIBAgIJANqkMEtlkelbMA0GCSqGSIb3DQEBCwUAMHAxCzAJBgNV\n" + "BAYTAlVTMQswCQYDVQQIDAJWQTERMA8GA1UEBwwIU29tZUNpdHkxEjAQBgNVBAoM\n" + "CU15Q29tcGFueTETMBEGA1UECwwKTXlEaXZpc2lvbjEYMBYGA1UEAwwPd3d3LmNv\n" + "bXBhbnkuY29tMB4XDTE4MDIxNTA3MjkzMFoXDTIwMDIxNTA3MjkzMFowcDELMAkG\n" + "A1UEBhMCVVMxCzAJBgNVBAgMAlZBMREwDwYDVQQHDAhTb21lQ2l0eTESMBAGA1UE\n" + "CgwJTXlDb21wYW55MRMwEQYDVQQLDApNeURpdmlzaW9uMRgwFgYDVQQDDA93d3cu\n" + "Y29tcGFueS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC4v6Oq\n" + "Ua0goRVn1cmT7MOpJhXFm3A70bTpvJIRpEjtGIz99hb34/9r5AYyf1VhKyWmBq24\n" + "XNcOJ59XOlyjjbm2Tl811ufTOdcNbPadoVBmMt4039OSUFpVb4wAw2XPWLTCG2h1\n" + "HNj9GuFHmwcDsg5EiIRrhDGQm2LLLAGoe5PdReoMZCeeWzNWvKTCV14pyRzwQhJL\n" + "F1OmzLYzovbPfB8LZVhQgDbLsh034FScivf2oKDB+NEzAEagNpnrFR0MFLWGYsu1\n" + "nWD5RiZi78HFGiibmhH7QrEPfGlo2eofuUga6naoBUROqkmMCIL8n1HZ/Ur0oGny\n" + "vQCj1AyrfOhuVC53AgMBAAGjQjBAMAsGA1UdDwQEAwIEMDATBgNVHSUEDDAKBggr\n" + "BgEFBQcDATAcBgNVHREEFTATgRFlbWFpbEBleGFtcGxlLmNvbTANBgkqhkiG9w0B\n" + "AQsFAAOCAQEAZ0IsqRrsEmJ6Fa9Yo6PQtrKJrejN2TTDddVgyLQdokzWh/25JFad\n" + "NCMYPH5KjTUyKf96hJDlDayjbKk1PMMhSZMU5OG9NOuGMH/dQttruG1ojse7KIKg\n" + "yHDQrfq5Exxgfa7CMHRKAoTCY7JZhSLyVbTMVhmGfuUDad/RA86ZisXycp0ZmS97\n" + "qDkAmzFL0sL0ZUWNNUh4ZUWvCUZwiuN08z70NjGqXMTDCf68p3SYxbII0xTfScgf\n" + "aQ/A/hD7IbGGTexeoTwpEj01DNvefbQV6//neo32/R5XD0D5jn3TCgZcMThA6H3a\n" + "VkEghVg+s7uMfL/UEebOBQWXQJ/uVoknMA==\n" + "-----END CERTIFICATE-----" ).getBytes(); /** * subject CN=www.foo.com, subjectAlt=IP Address:127.0.0.1 */ public final static byte[] SUBJECT_ALT_IP_ONLY = ( "-----BEGIN CERTIFICATE-----\n" + "MIIBQjCB6qADAgECAgYBeLZWSL0wCgYIKoZIzj0EAwIwFjEUMBIGA1UEAwwLd3d3\n" + "LmZvby5jb20wHhcNMjEwNDA5MTExMzI2WhcNMjEwNDA5MTE0MzMxWjAWMRQwEgYD\n" + "VQQDDAt3d3cuZm9vLmNvbTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABPC+8O/v\n" + "IPWSC/iPdPAgpgzpyLKZevNH8ENOb6PaJRDyNHdd1MbJvurKtJ+HP6UYV3keNHUk\n" + "r657s2JjufiTmuSjJDAiMAwGA1UdEwQFMAMBAf8wEgYDVR0RAQH/BAgwBocEfwAA\n" + "ATAKBggqhkjOPQQDAgNHADBEAiA2svKw50Mr5nnF4TXyFcvzhJWkC+7m46JROMiy\n" + "TMt3BQIgK5IHScVH6Cbi106y+BILx4U0Ygt5IFNnMx/K+Jusuls=\n" + "-----END CERTIFICATE-----" ).getBytes(); } httpclient5/src/test/java/org/apache/hc/client5/http/ssl/TestDistinguishedNameParser.java0100664 0000000 0000000 00000012500 14704162040 030546 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.ssl; import static org.hamcrest.MatcherAssert.assertThat; import java.util.Arrays; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; /** * Unit tests for {@link DistinguishedNameParser}. */ class TestDistinguishedNameParser { private DistinguishedNameParser impl; @BeforeEach void setup() { impl = DistinguishedNameParser.INSTANCE; } @Test void testParseBasic() { assertThat(impl.parse("cn=blah, ou=yada, o=booh"), CoreMatchers.equalTo(Arrays.asList( new BasicNameValuePair("cn", "blah"), new BasicNameValuePair("ou", "yada"), new BasicNameValuePair("o", "booh")))); } @Test void testParseRepeatedElements() { assertThat(impl.parse("cn=blah, cn=yada, cn=booh"), CoreMatchers.equalTo(Arrays.asList( new BasicNameValuePair("cn", "blah"), new BasicNameValuePair("cn", "yada"), new BasicNameValuePair("cn", "booh")))); } @Test void testParseBlanks() { assertThat(impl.parse("c = pampa , cn = blah , ou = blah , o = blah"), CoreMatchers.equalTo(Arrays.asList( new BasicNameValuePair("c", "pampa"), new BasicNameValuePair("cn", "blah"), new BasicNameValuePair("ou", "blah"), new BasicNameValuePair("o", "blah")))); } @Test void testParseQuotes() { assertThat(impl.parse("cn=\"blah\", ou=yada, o=booh"), CoreMatchers.equalTo(Arrays.asList( new BasicNameValuePair("cn", "blah"), new BasicNameValuePair("ou", "yada"), new BasicNameValuePair("o", "booh")))); } @Test void testParseQuotes2() { assertThat(impl.parse("cn=\"blah blah\", ou=yada, o=booh"), CoreMatchers.equalTo(Arrays.asList( new BasicNameValuePair("cn", "blah blah"), new BasicNameValuePair("ou", "yada"), new BasicNameValuePair("o", "booh")))); } @Test void testParseQuotes3() { assertThat(impl.parse("cn=\"blah, blah\", ou=yada, o=booh"), CoreMatchers.equalTo(Arrays.asList( new BasicNameValuePair("cn", "blah, blah"), new BasicNameValuePair("ou", "yada"), new BasicNameValuePair("o", "booh")))); } @Test void testParseEscape() { assertThat(impl.parse("cn=blah\\, blah, ou=yada, o=booh"), CoreMatchers.equalTo(Arrays.asList( new BasicNameValuePair("cn", "blah, blah"), new BasicNameValuePair("ou", "yada"), new BasicNameValuePair("o", "booh")))); } @Test void testParseUnescapedEqual() { assertThat(impl.parse("c = cn=uuh, cn=blah, ou=yada, o=booh"), CoreMatchers.equalTo(Arrays.asList( new BasicNameValuePair("c", "cn=uuh"), new BasicNameValuePair("cn", "blah"), new BasicNameValuePair("ou", "yada"), new BasicNameValuePair("o", "booh")))); } @Test void testParseInvalid() { assertThat(impl.parse("blah,blah"), CoreMatchers.equalTo(Arrays.asList( new BasicNameValuePair("blah", null), new BasicNameValuePair("blah", null)))); } @Test void testParseInvalid2() { assertThat(impl.parse("cn,o=blah"), CoreMatchers.equalTo(Arrays.asList( new BasicNameValuePair("cn", null), new BasicNameValuePair("o", "blah")))); } } httpclient5/src/test/java/org/apache/hc/client5/http/NameValuePairsMatcher.java0100664 0000000 0000000 00000006303 14666635064 026532 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.List; import java.util.Objects; import org.apache.hc.core5.http.NameValuePair; import org.hamcrest.BaseMatcher; import org.hamcrest.Description; import org.hamcrest.Matcher; public class NameValuePairsMatcher extends BaseMatcher> { private final List expectedNameValuePairList; public NameValuePairsMatcher(final List nameValuePairList) { this.expectedNameValuePairList = nameValuePairList; } @Override public boolean matches(final Object item) { if (item instanceof Collection) { final Collection collection = (Collection) item; int i = 0; for (final Object obj : collection) { if (obj instanceof NameValuePair) { final NameValuePair nvp1 = (NameValuePair) obj; final NameValuePair nvp2 = expectedNameValuePairList.get(i); if (!nvp1.getName().equalsIgnoreCase(nvp2.getName()) || !Objects.equals(nvp1.getValue(), nvp2.getValue())) { return false; } } else { return false; } i++; } return true; } return false; } @Override public void describeTo(final Description description) { description.appendText("same name/value pairs as ").appendValueList("[", ", ", "]", expectedNameValuePairList); } public static Matcher> same(final Collection nameValuePairs) { return new NameValuePairsMatcher(new ArrayList<>(nameValuePairs)); } public static Matcher> same(final NameValuePair... nameValuePairs) { return new NameValuePairsMatcher(Arrays.asList(nameValuePairs)); } } httpclient5/src/test/java/org/apache/hc/client5/http/psl/0040775 0000000 0000000 00000000000 15005672035 022271 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/psl/TestPublicSuffixMatcherLoader.java0100664 0000000 0000000 00000003450 15005672035 031031 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.psl; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; import org.junit.jupiter.api.Test; /** * Tests {@link PublicSuffixMatcherLoader}. */ class TestPublicSuffixMatcherLoader { @Test void testGetDefault() { final PublicSuffixMatcher defaultMatcher = PublicSuffixMatcherLoader.getDefault(); assertNotNull(defaultMatcher); // check for an expected-to-be-stable entry in the PUBLIC_SUFFIX_LIST assertEquals("example.net", defaultMatcher.getDomainRoot("example.net", DomainType.ICANN)); } } httpclient5/src/test/java/org/apache/hc/client5/http/psl/TestPublicSuffixMatcher.java0100664 0000000 0000000 00000036060 15005672035 027705 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.psl; import java.io.InputStream; import java.io.InputStreamReader; import java.nio.charset.StandardCharsets; import java.util.List; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestPublicSuffixMatcher { private static final String SOURCE_FILE = "suffixlistmatcher.txt"; private PublicSuffixMatcher matcher; private PublicSuffixMatcher pslMatcher; @BeforeEach void setUp() throws Exception { final ClassLoader classLoader = getClass().getClassLoader(); // Create a matcher using a custom crafted public suffix list file try (InputStream in = classLoader.getResourceAsStream(SOURCE_FILE)) { Assertions.assertNotNull(in, SOURCE_FILE); final List lists = PublicSuffixListParser.INSTANCE.parseByType(new InputStreamReader(in, StandardCharsets.UTF_8)); matcher = new PublicSuffixMatcher(lists); } // Create a matcher using the public suffix list file provided by publicsuffix.org (Mozilla). pslMatcher = PublicSuffixMatcherLoader.getDefault(); } @Test void testGetDomainRootAnyType() { // ICANN Assertions.assertEquals(null, matcher.getDomainRoot("com")); Assertions.assertEquals("blah.com", matcher.getDomainRoot("blah.com")); Assertions.assertEquals("foo.com", matcher.getDomainRoot("foo.com")); Assertions.assertEquals(null, matcher.getDomainRoot("blah.foo.com")); Assertions.assertEquals(null, matcher.getDomainRoot("booh.foo.com")); Assertions.assertEquals("blah.blah.foo.com", matcher.getDomainRoot("blah.blah.foo.com")); Assertions.assertEquals(null, matcher.getDomainRoot("kioto.jp")); Assertions.assertEquals(null, matcher.getDomainRoot("tokyo.jp")); Assertions.assertEquals(null, matcher.getDomainRoot("blah.tokyo.jp")); Assertions.assertEquals(null, matcher.getDomainRoot("booh.tokyo.jp")); Assertions.assertEquals("blah.blah.tokyo.jp", matcher.getDomainRoot("blah.blah.tokyo.jp")); Assertions.assertEquals("metro.tokyo.jp", matcher.getDomainRoot("metro.tokyo.jp")); Assertions.assertEquals("blah.ac.jp", matcher.getDomainRoot("blah.ac.jp")); Assertions.assertEquals("blah.ac.jp", matcher.getDomainRoot("blah.blah.ac.jp")); Assertions.assertEquals("metro.tokyo.jp", matcher.getDomainRoot("metro.tokyo.jp")); // Private Assertions.assertEquals("example.xx", matcher.getDomainRoot("example.XX")); Assertions.assertEquals("example.xx", matcher.getDomainRoot("www.example.XX")); Assertions.assertEquals("example.xx", matcher.getDomainRoot("www.blah.blah.example.XX")); Assertions.assertEquals(null, matcher.getDomainRoot("appspot.com")); Assertions.assertEquals("example.appspot.com", matcher.getDomainRoot("example.appspot.com")); Assertions.assertEquals(null, matcher.getDomainRoot("s3.amazonaws.com")); Assertions.assertEquals(null, matcher.getDomainRoot("blah.s3.amazonaws.com")); // Too short Assertions.assertNull(matcher.getDomainRoot("jp")); Assertions.assertNull(matcher.getDomainRoot("ac.jp")); Assertions.assertNull(matcher.getDomainRoot("any.tokyo.jp")); // Unknown Assertions.assertEquals(null, matcher.getDomainRoot("garbage")); Assertions.assertEquals("garbage.garbage", matcher.getDomainRoot("garbage.garbage")); Assertions.assertEquals("garbage.garbage", matcher.getDomainRoot("*.garbage.garbage")); Assertions.assertEquals("garbage.garbage", matcher.getDomainRoot("*.garbage.garbage.garbage")); Assertions.assertEquals(null, matcher.getDomainRoot("*.compute-1.amazonaws.com")); Assertions.assertEquals(null, matcher.getDomainRoot("blah.compute-1.amazonaws.com")); Assertions.assertEquals("blah.blah.compute-1.amazonaws.com", matcher.getDomainRoot("blah.blah.compute-1.amazonaws.com")); } @Test void testGetDomainRootOnlyPRIVATE() { // Private Assertions.assertEquals("example.xx", matcher.getDomainRoot("example.XX", DomainType.PRIVATE)); Assertions.assertEquals("example.xx", matcher.getDomainRoot("www.example.XX", DomainType.PRIVATE)); Assertions.assertEquals("example.xx", matcher.getDomainRoot("www.blah.blah.example.XX", DomainType.PRIVATE)); Assertions.assertEquals("example.appspot.com", matcher.getDomainRoot("example.appspot.com")); // Too short Assertions.assertNull(matcher.getDomainRoot("jp", DomainType.PRIVATE)); Assertions.assertNull(matcher.getDomainRoot("ac.jp", DomainType.PRIVATE)); Assertions.assertNull(matcher.getDomainRoot("any.tokyo.jp", DomainType.PRIVATE)); // ICANN Assertions.assertNull(matcher.getDomainRoot("metro.tokyo.jp", DomainType.PRIVATE)); Assertions.assertNull(matcher.getDomainRoot("blah.blah.tokyo.jp", DomainType.PRIVATE)); Assertions.assertNull(matcher.getDomainRoot("blah.blah.ac.jp", DomainType.PRIVATE)); // Unknown Assertions.assertNull(matcher.getDomainRoot("garbage", DomainType.PRIVATE)); Assertions.assertNull(matcher.getDomainRoot("garbage.garbage", DomainType.PRIVATE)); Assertions.assertNull(matcher.getDomainRoot("*.garbage.garbage", DomainType.PRIVATE)); Assertions.assertNull(matcher.getDomainRoot("*.garbage.garbage.garbage", DomainType.PRIVATE)); Assertions.assertNull(matcher.getDomainRoot("s3.amazonaws.com")); Assertions.assertNull(matcher.getDomainRoot("blah.s3.amazonaws.com")); } @Test void testGetDomainRootOnlyICANN() { // Private Assertions.assertNull(matcher.getDomainRoot("example.XX", DomainType.ICANN)); Assertions.assertNull(matcher.getDomainRoot("www.example.XX", DomainType.ICANN)); Assertions.assertNull(matcher.getDomainRoot("www.blah.blah.example.XX", DomainType.ICANN)); // Too short Assertions.assertNull(matcher.getDomainRoot("xx", DomainType.ICANN)); Assertions.assertNull(matcher.getDomainRoot("jp", DomainType.ICANN)); Assertions.assertNull(matcher.getDomainRoot("ac.jp", DomainType.ICANN)); Assertions.assertNull(matcher.getDomainRoot("any.tokyo.jp", DomainType.ICANN)); // ICANN Assertions.assertEquals("metro.tokyo.jp", matcher.getDomainRoot("metro.tokyo.jp", DomainType.ICANN)); Assertions.assertEquals("blah.blah.tokyo.jp", matcher.getDomainRoot("blah.blah.tokyo.jp", DomainType.ICANN)); Assertions.assertEquals("blah.ac.jp", matcher.getDomainRoot("blah.blah.ac.jp", DomainType.ICANN)); // Unknown Assertions.assertNull(matcher.getDomainRoot("garbage", DomainType.ICANN)); Assertions.assertNull(matcher.getDomainRoot("garbage.garbage", DomainType.ICANN)); Assertions.assertNull(matcher.getDomainRoot("*.garbage.garbage", DomainType.ICANN)); Assertions.assertNull(matcher.getDomainRoot("*.garbage.garbage.garbage", DomainType.ICANN)); } @Test void testMaySetCookies() { Assertions.assertTrue(matcher.verify("foo.com")); Assertions.assertFalse(matcher.verify("bar.foo.com")); Assertions.assertTrue(matcher.verify("example.bar.foo.com")); Assertions.assertTrue(matcher.verify("foo.bar.jp")); Assertions.assertFalse(matcher.verify("bar.jp")); Assertions.assertTrue(matcher.verify("foo.bar.hokkaido.jp")); Assertions.assertFalse(matcher.verify("bar.hokkaido.jp")); Assertions.assertTrue(matcher.verify("foo.bar.tokyo.jp")); Assertions.assertFalse(matcher.verify("bar.tokyo.jp")); Assertions.assertTrue(matcher.verify("pref.hokkaido.jp")); // exception from a wildcard rule Assertions.assertTrue(matcher.verify("metro.tokyo.jp")); // exception from a wildcard rule } @Test void testVerifyPrivate() { Assertions.assertTrue(matcher.verify("s3.amazonaws.com")); Assertions.assertTrue(matcher.verify("blah.s3.amazonaws.com")); Assertions.assertTrue(matcher.verify("blah.xxx.uk")); } @Test void testMatch() { Assertions.assertTrue(matcher.matches(".jp")); Assertions.assertTrue(matcher.matches(".ac.jp")); Assertions.assertTrue(matcher.matches(".any.tokyo.jp")); Assertions.assertTrue(matcher.matches(".xx")); Assertions.assertTrue(matcher.matches(".appspot.com")); // exception Assertions.assertFalse(matcher.matches(".metro.tokyo.jp")); } @Test void testMatchUnicode() { Assertions.assertTrue(matcher.matches(".h\u00E5.no")); // \u00E5 is Assertions.assertTrue(matcher.matches(".xn--h-2fa.no")); Assertions.assertTrue(matcher.matches(".h\u00E5.no")); Assertions.assertTrue(matcher.matches(".xn--h-2fa.no")); } private void checkPublicSuffix(final String input, final String expected) { Assertions.assertEquals(expected, pslMatcher.getDomainRoot(input)); } //see https://github.com/publicsuffix/list/blob/master/tests/test_psl.txt @Test void testGetDomainRootPublicSuffixList() { // null input. checkPublicSuffix(null, null); // Mixed case. checkPublicSuffix("COM", null); checkPublicSuffix("example.COM", "example.com"); checkPublicSuffix("WwW.example.COM", "example.com"); // Leading dot. checkPublicSuffix(".com", null); checkPublicSuffix(".example", null); checkPublicSuffix(".example.com", null); checkPublicSuffix(".example.example", null); // Unlisted TLD. checkPublicSuffix("example", null); checkPublicSuffix("example.example", "example.example"); checkPublicSuffix("b.example.example", "example.example"); checkPublicSuffix("a.b.example.example", "example.example"); // Listed, but non-Internet, TLD. //checkPublicSuffix("local", null); //checkPublicSuffix("example.local", null); //checkPublicSuffix("b.example.local", null); //checkPublicSuffix("a.b.example.local", null); // TLD with only 1 rule. checkPublicSuffix("biz", null); checkPublicSuffix("domain.biz", "domain.biz"); checkPublicSuffix("b.domain.biz", "domain.biz"); checkPublicSuffix("a.b.domain.biz", "domain.biz"); // TLD with some 2-level rules. checkPublicSuffix("com", null); checkPublicSuffix("example.com", "example.com"); checkPublicSuffix("b.example.com", "example.com"); checkPublicSuffix("a.b.example.com", "example.com"); checkPublicSuffix("uk.com", null); checkPublicSuffix("example.uk.com", "example.uk.com"); checkPublicSuffix("b.example.uk.com", "example.uk.com"); checkPublicSuffix("a.b.example.uk.com", "example.uk.com"); checkPublicSuffix("test.ac", "test.ac"); // TLD with only 1 (wildcard) rule. checkPublicSuffix("mm", null); checkPublicSuffix("c.mm", null); checkPublicSuffix("b.c.mm", "b.c.mm"); checkPublicSuffix("a.b.c.mm", "b.c.mm"); // More complex TLD. checkPublicSuffix("jp", null); checkPublicSuffix("test.jp", "test.jp"); checkPublicSuffix("www.test.jp", "test.jp"); checkPublicSuffix("ac.jp", null); checkPublicSuffix("test.ac.jp", "test.ac.jp"); checkPublicSuffix("www.test.ac.jp", "test.ac.jp"); checkPublicSuffix("kyoto.jp", null); checkPublicSuffix("test.kyoto.jp", "test.kyoto.jp"); checkPublicSuffix("ide.kyoto.jp", null); checkPublicSuffix("b.ide.kyoto.jp", "b.ide.kyoto.jp"); checkPublicSuffix("a.b.ide.kyoto.jp", "b.ide.kyoto.jp"); checkPublicSuffix("c.kobe.jp", null); checkPublicSuffix("b.c.kobe.jp", "b.c.kobe.jp"); checkPublicSuffix("a.b.c.kobe.jp", "b.c.kobe.jp"); checkPublicSuffix("city.kobe.jp", "city.kobe.jp"); checkPublicSuffix("www.city.kobe.jp", "city.kobe.jp"); // TLD with a wildcard rule and exceptions. checkPublicSuffix("ck", null); checkPublicSuffix("test.ck", null); checkPublicSuffix("b.test.ck", "b.test.ck"); checkPublicSuffix("a.b.test.ck", "b.test.ck"); checkPublicSuffix("www.ck", "www.ck"); checkPublicSuffix("www.www.ck", "www.ck"); // US K12. checkPublicSuffix("us", null); checkPublicSuffix("test.us", "test.us"); checkPublicSuffix("www.test.us", "test.us"); checkPublicSuffix("ak.us", null); checkPublicSuffix("test.ak.us", "test.ak.us"); checkPublicSuffix("www.test.ak.us", "test.ak.us"); checkPublicSuffix("k12.ak.us", null); checkPublicSuffix("test.k12.ak.us", "test.k12.ak.us"); checkPublicSuffix("www.test.k12.ak.us", "test.k12.ak.us"); // IDN labels. checkPublicSuffix("食狮.com.cn", "食狮.com.cn"); checkPublicSuffix("食狮.公司.cn", "食狮.公司.cn"); checkPublicSuffix("www.食狮.公司.cn", "食狮.公司.cn"); checkPublicSuffix("shishi.公司.cn", "shishi.公司.cn"); checkPublicSuffix("公司.cn", null); checkPublicSuffix("食狮.中国", "食狮.中国"); checkPublicSuffix("www.食狮.中国", "食狮.中国"); checkPublicSuffix("shishi.中国", "shishi.中国"); checkPublicSuffix("中国", null); // Same as above, but punycoded. checkPublicSuffix("xn--85x722f.com.cn", "xn--85x722f.com.cn"); checkPublicSuffix("xn--85x722f.xn--55qx5d.cn", "xn--85x722f.xn--55qx5d.cn"); checkPublicSuffix("www.xn--85x722f.xn--55qx5d.cn", "xn--85x722f.xn--55qx5d.cn"); checkPublicSuffix("shishi.xn--55qx5d.cn", "shishi.xn--55qx5d.cn"); checkPublicSuffix("xn--55qx5d.cn", null); checkPublicSuffix("xn--85x722f.xn--fiqs8s", "xn--85x722f.xn--fiqs8s"); checkPublicSuffix("www.xn--85x722f.xn--fiqs8s", "xn--85x722f.xn--fiqs8s"); checkPublicSuffix("shishi.xn--fiqs8s", "shishi.xn--fiqs8s"); checkPublicSuffix("xn--fiqs8s", null); } } httpclient5/src/test/java/org/apache/hc/client5/http/psl/TestPublicSuffixListParser.java0100664 0000000 0000000 00000007464 14704162040 030413 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.psl; import java.io.InputStream; import java.io.InputStreamReader; import java.nio.charset.StandardCharsets; import java.util.Arrays; import java.util.Collections; import java.util.List; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestPublicSuffixListParser { private static final String SUFFIXLIST_TXT = "suffixlist.txt"; private static final String SUFFIXLIST2_TXT = "suffixlist2.txt"; @Test void testParse() throws Exception { final ClassLoader classLoader = getClass().getClassLoader(); final PublicSuffixList suffixList; try (InputStream in = classLoader.getResourceAsStream(SUFFIXLIST_TXT)) { Assertions.assertNotNull(in, SUFFIXLIST_TXT); final PublicSuffixListParser parser = PublicSuffixListParser.INSTANCE; suffixList = parser.parse(new InputStreamReader(in, StandardCharsets.UTF_8)); } Assertions.assertNotNull(suffixList); Assertions.assertEquals(Arrays.asList("xx", "jp", "ac.jp", "*.tokyo.jp", "no", "h\u00E5.no"), suffixList.getRules()); Assertions.assertEquals(Collections.singletonList("metro.tokyo.jp"), suffixList.getExceptions()); } @Test void testParseByType() throws Exception { final ClassLoader classLoader = getClass().getClassLoader(); final List suffixLists; try (InputStream in = classLoader.getResourceAsStream(SUFFIXLIST2_TXT)) { Assertions.assertNotNull(in, SUFFIXLIST2_TXT); final PublicSuffixListParser parser = PublicSuffixListParser.INSTANCE; suffixLists = parser.parseByType(new InputStreamReader(in, StandardCharsets.UTF_8)); } Assertions.assertNotNull(suffixLists); Assertions.assertEquals(2, suffixLists.size()); final PublicSuffixList publicSuffixList1 = suffixLists.get(0); Assertions.assertNotNull(publicSuffixList1); Assertions.assertEquals(DomainType.ICANN, publicSuffixList1.getType()); Assertions.assertEquals(Arrays.asList("jp", "ac.jp", "*.tokyo.jp"), publicSuffixList1.getRules()); Assertions.assertEquals(Collections.singletonList("metro.tokyo.jp"), publicSuffixList1.getExceptions()); final PublicSuffixList publicSuffixList2 = suffixLists.get(1); Assertions.assertNotNull(publicSuffixList2); Assertions.assertEquals(DomainType.PRIVATE, publicSuffixList2.getType()); Assertions.assertEquals(Arrays.asList("googleapis.com", "googlecode.com"), publicSuffixList2.getRules()); Assertions.assertEquals(Collections.emptyList(), publicSuffixList2.getExceptions()); } } httpclient5/src/test/java/org/apache/hc/client5/http/HeadersMatcher.java0100664 0000000 0000000 00000005031 14666635064 025226 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.util.Objects; import org.apache.hc.core5.http.Header; import org.hamcrest.BaseMatcher; import org.hamcrest.Description; import org.hamcrest.Matcher; public class HeadersMatcher extends BaseMatcher { private final Header[] expectedHeaders; public HeadersMatcher(final Header... headers) { this.expectedHeaders = headers; } @Override public boolean matches(final Object item) { if (item instanceof Header[]) { final Header[] headers = (Header[]) item; if (headers.length == expectedHeaders.length) { for (int i = 0; i < headers.length; i++) { final Header h1 = headers[i]; final Header h2 = expectedHeaders[i]; if (!h1.getName().equalsIgnoreCase(h2.getName()) || !Objects.equals(h1.getValue(), h2.getValue())) { return false; } } return true; } } return false; } @Override public void describeTo(final Description description) { description.appendText("same headers as ").appendValueList("[", ", ", "]", expectedHeaders); } public static Matcher same(final Header... headers) { return new HeadersMatcher(headers); } } httpclient5/src/test/java/org/apache/hc/client5/http/ConnectExceptionSupportTest.java0100664 0000000 0000000 00000011341 14704162040 030033 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.io.IOException; import java.net.InetAddress; import org.apache.hc.core5.http.HttpHost; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Unit tests for exceptions. * Trivial, but it looks better in the Clover reports. */ class ConnectExceptionSupportTest { @Test void testConnectTimeoutExceptionFromNullMessageAndHost() { final ConnectTimeoutException ctx = ConnectExceptionSupport.createConnectTimeoutException(null, null); Assertions.assertEquals("Connect to remote endpoint timed out", ctx.getMessage()); } @Test void testConnectTimeoutExceptionFromCause() { final IOException cause = new IOException("something awful"); final ConnectTimeoutException ctx = ConnectExceptionSupport.createConnectTimeoutException(cause, null); Assertions.assertEquals("Connect to remote endpoint failed: something awful", ctx.getMessage()); } @Test void testConnectTimeoutExceptionFromCauseAndHost() { final HttpHost target = new HttpHost("localhost"); final IOException cause = new IOException(); final ConnectTimeoutException ctx = ConnectExceptionSupport.createConnectTimeoutException(cause, target); Assertions.assertEquals("Connect to http://localhost timed out", ctx.getMessage()); } @Test void testConnectTimeoutExceptionFromCauseHostAndRemoteAddress() throws Exception { final HttpHost target = new HttpHost("localhost"); final InetAddress remoteAddress = InetAddress.getByAddress(new byte[] {1,2,3,4}); final IOException cause = new IOException(); final ConnectTimeoutException ctx = ConnectExceptionSupport.createConnectTimeoutException(cause, target, remoteAddress); Assertions.assertEquals("Connect to http://localhost [/1.2.3.4] timed out", ctx.getMessage()); } @Test void testHttpHostConnectExceptionFromNullCause() { final HttpHostConnectException ctx = ConnectExceptionSupport.createHttpHostConnectException(null, null, (InetAddress [])null); Assertions.assertEquals("Connect to remote endpoint refused", ctx.getMessage()); } @Test void testHttpHostConnectExceptionFromCause() { final IOException cause = new IOException("something awful"); final HttpHostConnectException ctx = ConnectExceptionSupport.createHttpHostConnectException(cause, null); Assertions.assertEquals("Connect to remote endpoint failed: something awful", ctx.getMessage()); } @Test void testHttpHostConnectExceptionFromCauseAndHost() { final HttpHost target = new HttpHost("localhost"); final IOException cause = new IOException(); final HttpHostConnectException ctx = ConnectExceptionSupport.createHttpHostConnectException(cause, target); Assertions.assertEquals("Connect to http://localhost refused", ctx.getMessage()); } @Test void testHttpHostConnectExceptionFromCauseHostAndRemoteAddress() throws Exception { final HttpHost target = new HttpHost("localhost"); final InetAddress remoteAddress1 = InetAddress.getByAddress(new byte[] {1,2,3,4}); final InetAddress remoteAddress2 = InetAddress.getByAddress(new byte[] {5,6,7,8}); final IOException cause = new IOException(); final HttpHostConnectException ctx = ConnectExceptionSupport.createHttpHostConnectException(cause, target, remoteAddress1, remoteAddress2); Assertions.assertEquals("Connect to http://localhost [/1.2.3.4, /5.6.7.8] refused", ctx.getMessage()); } } httpclient5/src/test/java/org/apache/hc/client5/http/NameValuePairMatcher.java0100664 0000000 0000000 00000004611 14666635064 026347 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.util.Objects; import org.apache.hc.core5.http.NameValuePair; import org.hamcrest.BaseMatcher; import org.hamcrest.Description; import org.hamcrest.Matcher; public class NameValuePairMatcher extends BaseMatcher { private final String name; private final String value; public NameValuePairMatcher(final String name, final String value) { this.name = name; this.value = value; } @Override public boolean matches(final Object item) { if (item instanceof NameValuePair) { final NameValuePair nvp = (NameValuePair) item; return Objects.equals(nvp.getName(), name) && Objects.equals(nvp.getValue(), value); } return false; } @Override public void describeTo(final Description description) { description.appendText("equals ").appendValue(name).appendText("=").appendValue(value); } public static Matcher equals(final String name, final String value) { return new NameValuePairMatcher(name, value); } public static Matcher same(final String name, final String value) { return new NameValuePairMatcher(name, value); } } httpclient5/src/test/java/org/apache/hc/client5/http/validator/0040775 0000000 0000000 00000000000 14704162040 023453 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/validator/TestETag.java0100664 0000000 0000000 00000010442 14704162040 025774 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.validator; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestETag { @Test void testHashCodeEquals() { final ETag tag1 = new ETag("this"); final ETag tag2 = new ETag("this"); final ETag tag3 = new ETag("this", ValidatorType.WEAK); final ETag tag4 = new ETag("that", ValidatorType.WEAK); Assertions.assertEquals(tag1.hashCode(), tag2.hashCode()); Assertions.assertNotEquals(tag2.hashCode(), tag3.hashCode()); Assertions.assertNotEquals(tag3.hashCode(), tag4.hashCode()); Assertions.assertEquals(tag1, tag2); Assertions.assertNotEquals(tag2, tag3); Assertions.assertNotEquals(tag3, tag4); } @Test void testToString() { Assertions.assertEquals("\"blah\"", new ETag("blah").toString()); Assertions.assertEquals("W/\"blah\"", new ETag("blah", ValidatorType.WEAK).toString()); Assertions.assertEquals("\"\"", new ETag("").toString()); } @Test void testParse() { Assertions.assertEquals(new ETag("blah", ValidatorType.WEAK), ETag.parse(" W/\"blah\" ")); Assertions.assertEquals(new ETag(" huh?"), ETag.parse(" \" huh?\" ")); Assertions.assertEquals(new ETag(" ", ValidatorType.WEAK), ETag.parse("W/\" \"")); Assertions.assertEquals(new ETag(""), ETag.parse("\"\"")); Assertions.assertNull(ETag.parse("wrong")); Assertions.assertNull(ETag.parse("w/\"wrong\"")); Assertions.assertNull(ETag.parse("W /\"wrong\"")); Assertions.assertNull(ETag.parse("W/ \"wrong\"")); Assertions.assertNull(ETag.parse("W/wrong")); Assertions.assertNull(ETag.parse("\"cut")); Assertions.assertNull(ETag.parse(" \"")); Assertions.assertNull(ETag.parse("W/\"")); } @Test void testComparison() { Assertions.assertFalse(ETag.strongCompare(new ETag("1", ValidatorType.WEAK), new ETag("1", ValidatorType.WEAK))); Assertions.assertTrue(ETag.weakCompare(new ETag("1", ValidatorType.WEAK), new ETag("1", ValidatorType.WEAK))); Assertions.assertFalse(ETag.strongCompare(new ETag("1", ValidatorType.WEAK), new ETag("2", ValidatorType.WEAK))); Assertions.assertFalse(ETag.weakCompare(new ETag("1", ValidatorType.WEAK), new ETag("2", ValidatorType.WEAK))); Assertions.assertFalse(ETag.strongCompare(new ETag("1", ValidatorType.WEAK), new ETag("1"))); Assertions.assertTrue(ETag.weakCompare(new ETag("1", ValidatorType.WEAK), new ETag("1"))); Assertions.assertTrue(ETag.strongCompare(new ETag("1"), new ETag("1"))); Assertions.assertTrue(ETag.weakCompare(new ETag("1"), new ETag("1"))); Assertions.assertFalse(ETag.weakCompare(new ETag("1", ValidatorType.WEAK), null)); Assertions.assertFalse(ETag.weakCompare(null, new ETag("1", ValidatorType.WEAK))); Assertions.assertFalse(ETag.weakCompare(null, null)); Assertions.assertFalse(ETag.strongCompare(new ETag("1"), null)); Assertions.assertFalse(ETag.strongCompare(null, new ETag("1"))); Assertions.assertFalse(ETag.strongCompare(null, null)); } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/0040775 0000000 0000000 00000000000 15063503632 023007 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/entity/TestGZip.java0100664 0000000 0000000 00000011303 15063503632 025356 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.OutputStream; import java.nio.charset.StandardCharsets; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.io.entity.StringEntity; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.mockito.ArgumentMatchers; import org.mockito.Mockito; class TestGZip { @Test void testBasic() throws Exception { final String s = "some kind of text"; final StringEntity e = new StringEntity(s, ContentType.TEXT_PLAIN, false); try (final GzipCompressingEntity gzipe = new GzipCompressingEntity(e)) { Assertions.assertTrue(gzipe.isChunked()); Assertions.assertEquals(-1, gzipe.getContentLength()); Assertions.assertNotNull(gzipe.getContentEncoding()); Assertions.assertEquals("gzip", gzipe.getContentEncoding()); } } @Test void testCompressionDecompression() throws Exception { final StringEntity in = new StringEntity("some kind of text", ContentType.TEXT_PLAIN); try (final GzipCompressingEntity gzipe = new GzipCompressingEntity(in)) { final ByteArrayOutputStream buf = new ByteArrayOutputStream(); gzipe.writeTo(buf); final ByteArrayEntity out = new ByteArrayEntity(buf.toByteArray(), ContentType.APPLICATION_OCTET_STREAM); final GzipDecompressingEntity gunzipe = new GzipDecompressingEntity(out); Assertions.assertEquals("some kind of text", EntityUtils.toString(gunzipe, StandardCharsets.US_ASCII)); } } @Test void testCompressionIOExceptionLeavesOutputStreamOpen() throws Exception { final HttpEntity in = Mockito.mock(HttpEntity.class); Mockito.doThrow(new IOException("Ooopsie")).when(in).writeTo(ArgumentMatchers.any()); try (final GzipCompressingEntity gzipe = new GzipCompressingEntity(in)) { final OutputStream out = Mockito.mock(OutputStream.class); try { gzipe.writeTo(out); } catch (final IOException ex) { Mockito.verify(out, Mockito.never()).close(); } } } @Test void testDecompressionWithMultipleGZipStream() throws Exception { final int[] data = new int[] { 0x1f, 0x8b, 0x08, 0x08, 0x03, 0xf1, 0x55, 0x5a, 0x00, 0x03, 0x74, 0x65, 0x73, 0x74, 0x31, 0x00, 0x2b, 0x2e, 0x29, 0x4a, 0x4d, 0xcc, 0xd5, 0x35, 0xe4, 0x02, 0x00, 0x03, 0x61, 0xf0, 0x5f, 0x09, 0x00, 0x00, 0x00, 0x1f, 0x8b, 0x08, 0x08, 0x08, 0xf1, 0x55, 0x5a, 0x00, 0x03, 0x74, 0x65, 0x73, 0x74, 0x32, 0x00, 0x2b, 0x2e, 0x29, 0x4a, 0x4d, 0xcc, 0xd5, 0x35, 0xe2, 0x02, 0x00, 0xc0, 0x32, 0xdd, 0x74, 0x09, 0x00, 0x00, 0x00 }; final byte[] bytes = new byte[data.length]; for (int i = 0; i < data.length; i++) { bytes[i] = (byte) (data[i] & 0xff); } try (final GzipDecompressingEntity entity = new GzipDecompressingEntity(new InputStreamEntity(new ByteArrayInputStream(bytes), ContentType.APPLICATION_OCTET_STREAM))) { Assertions.assertEquals("stream-1\nstream-2\n", EntityUtils.toString(entity, StandardCharsets.US_ASCII)); } } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/TestEntityBuilder.java0100664 0000000 0000000 00000012210 15063503632 027266 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.File; import java.io.InputStream; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.mockito.Mockito; class TestEntityBuilder { @Test void testBuildEmptyEntity() { Assertions.assertThrows(IllegalStateException.class, () -> EntityBuilder.create().build()); } @Test void testBuildTextEntity() throws Exception { final HttpEntity entity = EntityBuilder.create().setText("stuff").build(); Assertions.assertNotNull(entity); Assertions.assertNotNull(entity.getContent()); Assertions.assertNotNull(entity.getContentType()); Assertions.assertEquals("text/plain; charset=UTF-8", entity.getContentType()); } @Test void testBuildBinaryEntity() throws Exception { final HttpEntity entity = EntityBuilder.create().setBinary(new byte[] {0, 1, 2}).build(); Assertions.assertNotNull(entity); Assertions.assertNotNull(entity.getContent()); Assertions.assertNotNull(entity.getContentType()); Assertions.assertEquals("application/octet-stream", entity.getContentType()); } @Test void testBuildStreamEntity() throws Exception { final InputStream in = Mockito.mock(InputStream.class); final HttpEntity entity = EntityBuilder.create().setStream(in).build(); Assertions.assertNotNull(entity); Assertions.assertNotNull(entity.getContent()); Assertions.assertNotNull(entity.getContentType()); Assertions.assertEquals(-1, entity.getContentLength()); Assertions.assertEquals("application/octet-stream", entity.getContentType()); } @Test void testBuildSerializableEntity() throws Exception { final HttpEntity entity = EntityBuilder.create().setSerializable(Boolean.TRUE).build(); Assertions.assertNotNull(entity); Assertions.assertNotNull(entity.getContent()); Assertions.assertNotNull(entity.getContentType()); Assertions.assertEquals("application/octet-stream", entity.getContentType()); } @Test void testBuildFileEntity() { final File file = new File("stuff"); final HttpEntity entity = EntityBuilder.create().setFile(file).build(); Assertions.assertNotNull(entity); Assertions.assertNotNull(entity.getContentType()); Assertions.assertEquals("application/octet-stream", entity.getContentType()); } @Test void testExplicitContentProperties() throws Exception { final HttpEntity entity = EntityBuilder.create() .setContentType(ContentType.APPLICATION_JSON) .setContentEncoding("identity") .setBinary(new byte[] {0, 1, 2}) .setText("{\"stuff\"}").build(); Assertions.assertNotNull(entity); Assertions.assertNotNull(entity.getContentType()); Assertions.assertEquals("application/json; charset=UTF-8", entity.getContentType()); Assertions.assertNotNull(entity.getContentEncoding()); Assertions.assertEquals("identity", entity.getContentEncoding()); Assertions.assertEquals("{\"stuff\"}", EntityUtils.toString(entity)); } @Test void testBuildChunked() { final HttpEntity entity = EntityBuilder.create().setText("stuff").chunked().build(); Assertions.assertNotNull(entity); Assertions.assertTrue(entity.isChunked()); } @Test void testBuildGZipped() { final HttpEntity entity = EntityBuilder.create().setText("stuff").gzipCompressed().build(); Assertions.assertNotNull(entity); Assertions.assertNotNull(entity.getContentType()); Assertions.assertEquals("text/plain; charset=UTF-8", entity.getContentType()); Assertions.assertNotNull(entity.getContentEncoding()); Assertions.assertEquals("gzip", entity.getContentEncoding()); } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/TestDecompressingEntity.java0100664 0000000 0000000 00000011560 15063503632 030511 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.InputStream; import java.nio.charset.StandardCharsets; import java.util.zip.CRC32; import java.util.zip.CheckedInputStream; import java.util.zip.Checksum; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.io.entity.StringEntity; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestDecompressingEntity { @Test void testNonStreaming() throws Exception { final CRC32 crc32 = new CRC32(); final StringEntity wrapped = new StringEntity("1234567890", StandardCharsets.US_ASCII); final ChecksumEntity entity = new ChecksumEntity(wrapped, crc32); Assertions.assertFalse(entity.isStreaming()); final String s = EntityUtils.toString(entity); Assertions.assertEquals("1234567890", s); Assertions.assertEquals(639479525L, crc32.getValue()); final InputStream in1 = entity.getContent(); final InputStream in2 = entity.getContent(); Assertions.assertNotSame(in1, in2); } @Test void testStreaming() throws Exception { final CRC32 crc32 = new CRC32(); final ByteArrayInputStream in = new ByteArrayInputStream("1234567890".getBytes(StandardCharsets.US_ASCII)); final InputStreamEntity wrapped = new InputStreamEntity(in, -1, ContentType.DEFAULT_TEXT); final ChecksumEntity entity = new ChecksumEntity(wrapped, crc32); Assertions.assertTrue(entity.isStreaming()); final String s = EntityUtils.toString(entity); Assertions.assertEquals("1234567890", s); Assertions.assertEquals(639479525L, crc32.getValue()); final InputStream in1 = entity.getContent(); final InputStream in2 = entity.getContent(); Assertions.assertSame(in1, in2); EntityUtils.consume(entity); EntityUtils.consume(entity); } @Test void testStreamingMarking() throws Exception { final CRC32 crc32 = new CRC32(); final ByteArrayInputStream in = new ByteArrayInputStream("1234567890".getBytes(StandardCharsets.US_ASCII)); final InputStreamEntity wrapped = new InputStreamEntity(in, -1, ContentType.DEFAULT_TEXT); final ChecksumEntity entity = new ChecksumEntity(wrapped, crc32); final InputStream in1 = entity.getContent(); Assertions.assertEquals('1', in1.read()); Assertions.assertEquals('2', in1.read()); in1.mark(1); Assertions.assertEquals('3', in1.read()); in1.reset(); Assertions.assertEquals('3', in1.read()); EntityUtils.consume(entity); } @Test void testWriteToStream() throws Exception { final CRC32 crc32 = new CRC32(); final StringEntity wrapped = new StringEntity("1234567890", StandardCharsets.US_ASCII); try (final ChecksumEntity entity = new ChecksumEntity(wrapped, crc32)) { Assertions.assertFalse(entity.isStreaming()); final ByteArrayOutputStream out = new ByteArrayOutputStream(); entity.writeTo(out); final String s = new String(out.toByteArray(), StandardCharsets.US_ASCII); Assertions.assertEquals("1234567890", s); Assertions.assertEquals(639479525L, crc32.getValue()); } } static class ChecksumEntity extends DecompressingEntity { public ChecksumEntity(final HttpEntity wrapped, final Checksum checksum) { super(wrapped, inStream -> new CheckedInputStream(inStream, checksum)); } } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/TestDeflate.java0100664 0000000 0000000 00000004335 15063503632 026060 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import java.nio.charset.StandardCharsets; import java.util.zip.Deflater; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestDeflate { @Test void testCompressDecompress() throws Exception { final String s = "some kind of text"; final byte[] input = s.getBytes(StandardCharsets.US_ASCII); // Compress the bytes final byte[] compressed = new byte[input.length * 2]; final Deflater compresser = new Deflater(); compresser.setInput(input); compresser.finish(); final int len = compresser.deflate(compressed); final HttpEntity entity = new DeflateDecompressingEntity(new ByteArrayEntity(compressed, 0, len, ContentType.APPLICATION_OCTET_STREAM)); Assertions.assertEquals(s, EntityUtils.toString(entity)); } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/0040775 0000000 0000000 00000000000 15063503632 023736 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/HttpRFC7578MultipartTest.java0100664 0000000 0000000 00000003731 14704162040 031144 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import static org.junit.jupiter.api.Assertions.assertEquals; import org.apache.hc.core5.net.PercentCodec; import org.junit.jupiter.api.Test; class HttpRFC7578MultipartTest { @Test void testPercentDecodingWithValidMessages() { final String[][] tests = new String[][] { {"test", "test"}, {"%20", " "}, {"a%20b", "a b"}, {"https%3A%2F%2Fhc.apache.org%2Fhttpcomponents-client-5.0.x%2Findex.html", "https://hc.apache.org/httpcomponents-client-5.0.x/index.html"}, {"%00", "\00"}, {"%0A", "\n"}, }; for (final String[] test : tests) { assertEquals(test[1], PercentCodec.RFC5987.decode(test[0])); } } }httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/TestMultipartContentBody.java0100664 0000000 0000000 00000006765 14704162040 031601 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.ByteArrayInputStream; import java.nio.charset.StandardCharsets; import org.apache.hc.core5.http.ContentType; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestMultipartContentBody { @Test void testStringBody() { final StringBody b1 = new StringBody("text", ContentType.DEFAULT_TEXT); Assertions.assertEquals(4, b1.getContentLength()); Assertions.assertEquals("UTF-8", b1.getCharset()); Assertions.assertNull(b1.getFilename()); Assertions.assertEquals("text/plain", b1.getMimeType()); Assertions.assertEquals("text", b1.getMediaType()); Assertions.assertEquals("plain", b1.getSubType()); final StringBody b2 = new StringBody("more text", ContentType.create("text/other", StandardCharsets.ISO_8859_1)); Assertions.assertEquals(9, b2.getContentLength()); Assertions.assertEquals(StandardCharsets.ISO_8859_1.name(), b2.getCharset()); Assertions.assertNull(b2.getFilename()); Assertions.assertEquals("text/other", b2.getMimeType()); Assertions.assertEquals("text", b2.getMediaType()); Assertions.assertEquals("other", b2.getSubType()); } @Test void testInputStreamBody() { final byte[] stuff = "Stuff".getBytes(StandardCharsets.US_ASCII); final InputStreamBody b1 = new InputStreamBody(new ByteArrayInputStream(stuff), "stuff"); Assertions.assertEquals(-1, b1.getContentLength()); Assertions.assertNull(b1.getCharset()); Assertions.assertEquals("stuff", b1.getFilename()); Assertions.assertEquals("application/octet-stream", b1.getMimeType()); Assertions.assertEquals("application", b1.getMediaType()); Assertions.assertEquals("octet-stream", b1.getSubType()); final InputStreamBody b2 = new InputStreamBody( new ByteArrayInputStream(stuff), ContentType.create("some/stuff"), "stuff"); Assertions.assertEquals(-1, b2.getContentLength()); Assertions.assertNull(b2.getCharset()); Assertions.assertEquals("stuff", b2.getFilename()); Assertions.assertEquals("some/stuff", b2.getMimeType()); Assertions.assertEquals("some", b2.getMediaType()); Assertions.assertEquals("stuff", b2.getSubType()); } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/TestMultipartForm.java0100664 0000000 0000000 00000041463 15005672035 030253 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.ByteArrayOutputStream; import java.io.File; import java.io.FileInputStream; import java.io.FileWriter; import java.io.Writer; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.util.Arrays; import org.apache.hc.core5.http.ContentType; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestMultipartForm { private File tmpfile; @AfterEach void cleanup() { if (tmpfile != null) { tmpfile.delete(); } } @Test void testMultipartFormStringParts() throws Exception { final FormBodyPart p1 = FormBodyPartBuilder.create( "field1", new StringBody("this stuff", ContentType.DEFAULT_TEXT)).build(); final FormBodyPart p2 = FormBodyPartBuilder.create( "field2", new StringBody("that stuff", ContentType.create( ContentType.TEXT_PLAIN.getMimeType(), StandardCharsets.ISO_8859_1))).build(); final FormBodyPart p3 = FormBodyPartBuilder.create( "field3", new StringBody("all kind of stuff", ContentType.DEFAULT_TEXT)).build(); final HttpStrictMultipart multipart = new HttpStrictMultipart(null, "foo", Arrays.asList(p1, p2, p3)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Disposition: form-data; name=\"field1\"\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + "this stuff\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field2\"\r\n" + "Content-Type: text/plain; charset=ISO-8859-1\r\n" + "\r\n" + "that stuff\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field3\"\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + "all kind of stuff\r\n" + "--foo--\r\n"; final String s = out.toString("US-ASCII"); Assertions.assertEquals(expected, s); Assertions.assertEquals(s.length(), multipart.getTotalLength()); } @Test void testMultipartFormCustomContentType() throws Exception { final FormBodyPart p1 = FormBodyPartBuilder.create( "field1", new StringBody("this stuff", ContentType.DEFAULT_TEXT)).build(); final FormBodyPart p2 = FormBodyPartBuilder.create( "field2", new StringBody("that stuff", ContentType.parse("stuff/plain; param=value"))).build(); final HttpStrictMultipart multipart = new HttpStrictMultipart(null, "foo", Arrays.asList(p1, p2)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Disposition: form-data; name=\"field1\"\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + "this stuff\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field2\"\r\n" + "Content-Type: stuff/plain; param=value\r\n" + "\r\n" + "that stuff\r\n" + "--foo--\r\n"; final String s = out.toString("US-ASCII"); Assertions.assertEquals(expected, s); Assertions.assertEquals(s.length(), multipart.getTotalLength()); } @Test void testMultipartFormBinaryParts() throws Exception { tmpfile = File.createTempFile("tmp", ".bin"); try (Writer writer = new FileWriter(tmpfile)) { writer.append("some random whatever"); } final FormBodyPart p1 = FormBodyPartBuilder.create( "field1", new FileBody(tmpfile)).build(); @SuppressWarnings("resource") final FormBodyPart p2 = FormBodyPartBuilder.create( "field2", new InputStreamBody(new FileInputStream(tmpfile), "file.tmp")).build(); final HttpStrictMultipart multipart = new HttpStrictMultipart(null, "foo", Arrays.asList(p1, p2)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Disposition: form-data; name=\"field1\"; " + "filename=\"" + tmpfile.getName() + "\"\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field2\"; " + "filename=\"file.tmp\"\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo--\r\n"; final String s = out.toString("US-ASCII"); Assertions.assertEquals(expected, s); Assertions.assertEquals(-1, multipart.getTotalLength()); } @Test void testMultipartFormStrict() throws Exception { tmpfile = File.createTempFile("tmp", ".bin"); try (Writer writer = new FileWriter(tmpfile)) { writer.append("some random whatever"); } final FormBodyPart p1 = FormBodyPartBuilder.create( "field1", new FileBody(tmpfile)).build(); final FormBodyPart p2 = FormBodyPartBuilder.create( "field2", new FileBody(tmpfile, ContentType.create("text/plain", "ANSI_X3.4-1968"), "test-file")).build(); @SuppressWarnings("resource") final FormBodyPart p3 = FormBodyPartBuilder.create( "field3", new InputStreamBody(new FileInputStream(tmpfile), "file.tmp")).build(); final HttpStrictMultipart multipart = new HttpStrictMultipart(null, "foo", Arrays.asList(p1, p2, p3)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Disposition: form-data; name=\"field1\"; " + "filename=\"" + tmpfile.getName() + "\"\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field2\"; " + "filename=\"test-file\"\r\n" + "Content-Type: text/plain; charset=US-ASCII\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field3\"; " + "filename=\"file.tmp\"\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo--\r\n"; final String s = out.toString("US-ASCII"); Assertions.assertEquals(expected, s); Assertions.assertEquals(-1, multipart.getTotalLength()); } @Test void testMultipartFormRFC6532() throws Exception { tmpfile = File.createTempFile("tmp", ".bin"); try (Writer writer = new FileWriter(tmpfile)) { writer.append("some random whatever"); } final FormBodyPart p1 = FormBodyPartBuilder.create( "field1\u0414", new FileBody(tmpfile)).build(); final FormBodyPart p2 = FormBodyPartBuilder.create( "field2", new FileBody(tmpfile, ContentType.create("text/plain", "ANSI_X3.4-1968"), "test-file")).build(); @SuppressWarnings("resource") final FormBodyPart p3 = FormBodyPartBuilder.create( "field3", new InputStreamBody(new FileInputStream(tmpfile), "file.tmp")).build(); final HttpRFC6532Multipart multipart = new HttpRFC6532Multipart(null, "foo", Arrays.asList(p1, p2, p3)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Disposition: form-data; name=\"field1\u0414\"; " + "filename=\"" + tmpfile.getName() + "\"\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field2\"; " + "filename=\"test-file\"\r\n" + "Content-Type: text/plain; charset=US-ASCII\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field3\"; " + "filename=\"file.tmp\"\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo--\r\n"; final String s = out.toString("UTF-8"); Assertions.assertEquals(expected, s); Assertions.assertEquals(-1, multipart.getTotalLength()); } private static final int SWISS_GERMAN_HELLO [] = { 0x47, 0x72, 0xFC, 0x65, 0x7A, 0x69, 0x5F, 0x7A, 0xE4, 0x6D, 0xE4 }; private static final int RUSSIAN_HELLO [] = { 0x412, 0x441, 0x435, 0x43C, 0x5F, 0x43F, 0x440, 0x438, 0x432, 0x435, 0x442 }; private static String constructString(final int [] unicodeChars) { final StringBuilder buffer = new StringBuilder(); if (unicodeChars != null) { for (final int unicodeChar : unicodeChars) { buffer.append((char)unicodeChar); } } return buffer.toString(); } @Test void testMultipartFormBrowserCompatibleNonASCIIHeaders() throws Exception { final String s1 = constructString(SWISS_GERMAN_HELLO); final String s2 = constructString(RUSSIAN_HELLO); tmpfile = File.createTempFile("tmp", ".bin"); try (Writer writer = new FileWriter(tmpfile)) { writer.append("some random whatever"); } @SuppressWarnings("resource") final FormBodyPart p1 = FormBodyPartBuilder.create( "field1", new InputStreamBody(new FileInputStream(tmpfile), s1 + ".tmp"), HttpMultipartMode.LEGACY).build(); @SuppressWarnings("resource") final FormBodyPart p2 = FormBodyPartBuilder.create( "field2", new InputStreamBody(new FileInputStream(tmpfile), s2 + ".tmp"), HttpMultipartMode.LEGACY).build(); final LegacyMultipart multipart = new LegacyMultipart( StandardCharsets.UTF_8, "foo", Arrays.asList(p1, p2)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Disposition: form-data; name=\"field1\"; " + "filename=\"" + s1 + ".tmp\"\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field2\"; " + "filename=\"" + s2 + ".tmp\"\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo--\r\n"; final String s = out.toString("UTF-8"); Assertions.assertEquals(expected, s); Assertions.assertEquals(-1, multipart.getTotalLength()); } @Test void testMultipartFormStringPartsMultiCharsets() throws Exception { final String s1 = constructString(SWISS_GERMAN_HELLO); final String s2 = constructString(RUSSIAN_HELLO); final FormBodyPart p1 = FormBodyPartBuilder.create( "field1", new StringBody(s1, ContentType.create("text/plain", StandardCharsets.ISO_8859_1))).build(); final FormBodyPart p2 = FormBodyPartBuilder.create( "field2", new StringBody(s2, ContentType.create("text/plain", Charset.forName("KOI8-R")))).build(); final HttpStrictMultipart multipart = new HttpStrictMultipart(null, "foo", Arrays.asList(p1, p2)); final ByteArrayOutputStream out1 = new ByteArrayOutputStream(); multipart.writeTo(out1); out1.close(); final ByteArrayOutputStream out2 = new ByteArrayOutputStream(); out2.write(( "--foo\r\n" + "Content-Disposition: form-data; name=\"field1\"\r\n" + "Content-Type: text/plain; charset=ISO-8859-1\r\n" + "\r\n").getBytes(StandardCharsets.US_ASCII)); out2.write(s1.getBytes(StandardCharsets.ISO_8859_1)); out2.write(("\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field2\"\r\n" + "Content-Type: text/plain; charset=KOI8-R\r\n" + "\r\n").getBytes(StandardCharsets.US_ASCII)); out2.write(s2.getBytes(Charset.forName("KOI8-R"))); out2.write(("\r\n" + "--foo--\r\n").getBytes(StandardCharsets.US_ASCII)); out2.close(); final byte[] actual = out1.toByteArray(); final byte[] expected = out2.toByteArray(); Assertions.assertEquals(expected.length, actual.length); for (int i = 0; i < actual.length; i++) { Assertions.assertEquals(expected[i], actual[i]); } Assertions.assertEquals(expected.length, multipart.getTotalLength()); } @Test void testMultipartFormBinaryPartsPreamblEpilogue() throws Exception { tmpfile = File.createTempFile("tmp", ".bin"); try (Writer writer = new FileWriter(tmpfile)) { writer.append("some random whatever"); } final FormBodyPart p1 = FormBodyPartBuilder.create( "field1", new FileBody(tmpfile)).build(); @SuppressWarnings("resource") final FormBodyPart p2 = FormBodyPartBuilder.create( "field2", new InputStreamBody(new FileInputStream(tmpfile), "file.tmp")).build(); final HttpStrictMultipart multipart = new HttpStrictMultipart(null, "foo", Arrays.asList(p1, p2), "This is the preamble", "This is the epilogue"); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "This is the preamble\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field1\"; " + "filename=\"" + tmpfile.getName() + "\"\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Disposition: form-data; name=\"field2\"; " + "filename=\"file.tmp\"\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo--\r\n" + "This is the epilogue\r\n"; final String s = out.toString("US-ASCII"); Assertions.assertEquals(expected, s); Assertions.assertEquals(-1, multipart.getTotalLength()); } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/TestMultipartEntityBuilder.java0100664 0000000 0000000 00000043720 15063503632 032131 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.File; import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.List; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicHeaderValueParser; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.apache.hc.core5.http.message.ParserCursor; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestMultipartEntityBuilder { @Test void testBasics() { final MultipartFormEntity entity = MultipartEntityBuilder.create().buildEntity(); Assertions.assertNotNull(entity); Assertions.assertTrue(entity.getMultipart() instanceof HttpStrictMultipart); Assertions.assertEquals(0, entity.getMultipart().getParts().size()); } @Test void testMultipartOptions() { final MultipartFormEntity entity = MultipartEntityBuilder.create() .setBoundary("blah-blah") .setCharset(StandardCharsets.UTF_8) .setLaxMode() .buildEntity(); Assertions.assertNotNull(entity); Assertions.assertTrue(entity.getMultipart() instanceof LegacyMultipart); Assertions.assertEquals("blah-blah", entity.getMultipart().boundary); Assertions.assertEquals(StandardCharsets.UTF_8, entity.getMultipart().charset); } @Test void testAddBodyParts() { final MultipartFormEntity entity = MultipartEntityBuilder.create() .addTextBody("p1", "stuff") .addBinaryBody("p2", new File("stuff")) .addBinaryBody("p3", new byte[]{}) .addBinaryBody("p4", new ByteArrayInputStream(new byte[]{})) .addBinaryBody("p5", new ByteArrayInputStream(new byte[]{}), ContentType.DEFAULT_BINARY, "filename") .buildEntity(); Assertions.assertNotNull(entity); final List bodyParts = entity.getMultipart().getParts(); Assertions.assertNotNull(bodyParts); Assertions.assertEquals(5, bodyParts.size()); } @Test void testMultipartCustomContentType() { final MultipartFormEntity entity = MultipartEntityBuilder.create() .setContentType(ContentType.APPLICATION_XML) .setBoundary("blah-blah") .setCharset(StandardCharsets.UTF_8) .setLaxMode() .buildEntity(); Assertions.assertNotNull(entity); Assertions.assertEquals("application/xml; charset=UTF-8; boundary=blah-blah", entity.getContentType()); } @Test void testMultipartContentTypeParameter() { final MultipartFormEntity entity = MultipartEntityBuilder.create() .setContentType(ContentType.MULTIPART_FORM_DATA.withParameters( new BasicNameValuePair("boundary", "yada-yada"), new BasicNameValuePair("charset", "ascii"))) .buildEntity(); Assertions.assertNotNull(entity); Assertions.assertEquals("multipart/form-data; boundary=yada-yada; charset=ascii", entity.getContentType()); Assertions.assertEquals("yada-yada", entity.getMultipart().boundary); Assertions.assertEquals(StandardCharsets.US_ASCII, entity.getMultipart().charset); } @Test void testMultipartDefaultContentTypeOmitsCharset() { final MultipartFormEntity entity = MultipartEntityBuilder.create() .setCharset(StandardCharsets.UTF_8) .setBoundary("yada-yada") .buildEntity(); Assertions.assertNotNull(entity); Assertions.assertEquals("multipart/mixed; boundary=yada-yada", entity.getContentType()); Assertions.assertEquals("yada-yada", entity.getMultipart().boundary); } @Test void testMultipartFormDataContentTypeOmitsCharset() { // Note: org.apache.hc.core5.http.ContentType.MULTIPART_FORM_DATA uses StandardCharsets.ISO_8859_1, // so we create a custom ContentType here final MultipartFormEntity entity = MultipartEntityBuilder.create() .setContentType(ContentType.create("multipart/form-data")) .setCharset(StandardCharsets.UTF_8) .setBoundary("yada-yada") .buildEntity(); Assertions.assertNotNull(entity); Assertions.assertEquals("multipart/form-data; boundary=yada-yada", entity.getContentType()); Assertions.assertEquals("yada-yada", entity.getMultipart().boundary); } @Test void testMultipartCustomContentTypeParameterOverrides() { final MultipartFormEntity entity = MultipartEntityBuilder.create() .setContentType(ContentType.MULTIPART_FORM_DATA.withParameters( new BasicNameValuePair("boundary", "yada-yada"), new BasicNameValuePair("charset", "ascii"), new BasicNameValuePair("my", "stuff"))) .setBoundary("blah-blah") .setCharset(StandardCharsets.UTF_8) .setLaxMode() .buildEntity(); Assertions.assertNotNull(entity); Assertions.assertEquals("multipart/form-data; boundary=blah-blah; charset=ascii; my=stuff", entity.getContentType()); } @Test void testMultipartCustomContentTypeUsingAddParameter() { final MultipartEntityBuilder eb = MultipartEntityBuilder.create(); eb.setMimeSubtype("related"); eb.addParameter(new BasicNameValuePair("boundary", "yada-yada")); eb.addParameter(new BasicNameValuePair("charset", "ascii")); eb.addParameter(new BasicNameValuePair("my", "stuff")); eb.buildEntity(); final MultipartFormEntity entity = eb.buildEntity(); Assertions.assertNotNull(entity); Assertions.assertEquals("multipart/related; boundary=yada-yada; charset=ascii; my=stuff", entity.getContentType()); } @Test void testMultipartWriteTo() throws Exception { final String helloWorld = "hello world"; final List parameters = new ArrayList<>(); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_NAME, "test")); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_FILENAME, helloWorld)); final MultipartFormEntity entity = MultipartEntityBuilder.create() .setStrictMode() .setBoundary("xxxxxxxxxxxxxxxxxxxxxxxx") .addPart(new FormBodyPartBuilder() .setName("test") .setBody(new StringBody("hello world", ContentType.TEXT_PLAIN)) .addField("Content-Disposition", "multipart/form-data", parameters) .build()) .buildEntity(); final ByteArrayOutputStream out = new ByteArrayOutputStream(); entity.writeTo(out); out.close(); Assertions.assertEquals("--xxxxxxxxxxxxxxxxxxxxxxxx\r\n" + "Content-Disposition: multipart/form-data; name=\"test\"; filename=\"hello world\"\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + helloWorld + "\r\n" + "--xxxxxxxxxxxxxxxxxxxxxxxx--\r\n", out.toString(StandardCharsets.US_ASCII.name())); } @Test void testMultipartWriteToRFC7578Mode() throws Exception { final String helloWorld = "hello \u03BA\u03CC\u03C3\u03BC\u03B5!%"; final List parameters = new ArrayList<>(); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_NAME, "test")); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_FILENAME, helloWorld)); final MultipartFormEntity entity = MultipartEntityBuilder.create() .setMode(HttpMultipartMode.EXTENDED) .setBoundary("xxxxxxxxxxxxxxxxxxxxxxxx") .addPart(new FormBodyPartBuilder() .setName("test") .setBody(new StringBody(helloWorld, ContentType.TEXT_PLAIN.withCharset(StandardCharsets.UTF_8))) .addField("Content-Disposition", "multipart/form-data", parameters) .build()) .buildEntity(); final ByteArrayOutputStream out = new ByteArrayOutputStream(); entity.writeTo(out); out.close(); Assertions.assertEquals("--xxxxxxxxxxxxxxxxxxxxxxxx\r\n" + "Content-Disposition: multipart/form-data; name=\"test\"; filename=\"hello%20%CE%BA%CF%8C%CF%83%CE%BC%CE%B5!%25\"\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + "hello \u00ce\u00ba\u00cf\u008c\u00cf\u0083\u00ce\u00bc\u00ce\u00b5!%\r\n" + "--xxxxxxxxxxxxxxxxxxxxxxxx--\r\n", out.toString(StandardCharsets.ISO_8859_1.name())); } @Test void testMultipartWriteToRFC6532Mode() throws Exception { final String helloWorld = "hello \u03BA\u03CC\u03C3\u03BC\u03B5!%"; final List parameters = new ArrayList<>(); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_NAME, "test")); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_FILENAME, helloWorld)); final MultipartFormEntity entity = MultipartEntityBuilder.create() .setMode(HttpMultipartMode.EXTENDED) .setContentType(ContentType.create("multipart/other")) .setBoundary("xxxxxxxxxxxxxxxxxxxxxxxx") .addPart(new FormBodyPartBuilder() .setName("test") .setBody(new StringBody(helloWorld, ContentType.TEXT_PLAIN.withCharset(StandardCharsets.UTF_8))) .addField("Content-Disposition", "multipart/form-data", parameters) .build()) .buildEntity(); final ByteArrayOutputStream out = new ByteArrayOutputStream(); entity.writeTo(out); out.close(); Assertions.assertEquals("--xxxxxxxxxxxxxxxxxxxxxxxx\r\n" + "Content-Disposition: multipart/form-data; name=\"test\"; " + "filename=\"hello \u00ce\u00ba\u00cf\u008c\u00cf\u0083\u00ce\u00bc\u00ce\u00b5!%\"\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + "hello \u00ce\u00ba\u00cf\u008c\u00cf\u0083\u00ce\u00bc\u00ce\u00b5!%\r\n" + "--xxxxxxxxxxxxxxxxxxxxxxxx--\r\n", out.toString(StandardCharsets.ISO_8859_1.name())); } @Test void testMultipartWriteToWithPreambleAndEpilogue() throws Exception { final String helloWorld = "hello \u03BA\u03CC\u03C3\u03BC\u03B5!%"; final List parameters = new ArrayList<>(); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_NAME, "test")); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_FILENAME, helloWorld)); final MultipartFormEntity entity = MultipartEntityBuilder.create() .setMode(HttpMultipartMode.EXTENDED) .setContentType(ContentType.create("multipart/other")) .setBoundary("xxxxxxxxxxxxxxxxxxxxxxxx") .addPart(new FormBodyPartBuilder() .setName("test") .setBody(new StringBody(helloWorld, ContentType.TEXT_PLAIN.withCharset(StandardCharsets.UTF_8))) .addField("Content-Disposition", "multipart/form-data", parameters) .build()) .addPreamble("This is the preamble.") .addEpilogue("This is the epilogue.") .buildEntity(); final ByteArrayOutputStream out = new ByteArrayOutputStream(); entity.writeTo(out); out.close(); Assertions.assertEquals("This is the preamble.\r\n" + "--xxxxxxxxxxxxxxxxxxxxxxxx\r\n" + "Content-Disposition: multipart/form-data; name=\"test\"; " + "filename=\"hello \u00ce\u00ba\u00cf\u008c\u00cf\u0083\u00ce\u00bc\u00ce\u00b5!%\"\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + "hello \u00ce\u00ba\u00cf\u008c\u00cf\u0083\u00ce\u00bc\u00ce\u00b5!%\r\n" + "--xxxxxxxxxxxxxxxxxxxxxxxx--\r\n" + "This is the epilogue.\r\n", out.toString(StandardCharsets.ISO_8859_1.name())); } @Test void testMultipartWriteToRFC7578ModeWithFilenameStar() throws Exception { final String helloWorld = "hello \u03BA\u03CC\u03C3\u03BC\u03B5!%"; final List parameters = new ArrayList<>(); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_NAME, "test")); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_FILENAME_START, helloWorld)); final MultipartFormEntity entity = MultipartEntityBuilder.create() .setMode(HttpMultipartMode.EXTENDED) .setBoundary("xxxxxxxxxxxxxxxxxxxxxxxx") .addPart(new FormBodyPartBuilder() .setName("test") .setBody(new StringBody(helloWorld, ContentType.TEXT_PLAIN.withCharset(StandardCharsets.UTF_8))) .addField("Content-Disposition", "multipart/form-data", parameters) .build()) .buildEntity(); final ByteArrayOutputStream out = new ByteArrayOutputStream(); entity.writeTo(out); out.close(); Assertions.assertEquals("--xxxxxxxxxxxxxxxxxxxxxxxx\r\n" + "Content-Disposition: multipart/form-data; name=\"test\"; filename*=\"UTF-8''hello%20%CE%BA%CF%8C%CF%83%CE%BC%CE%B5!%25\"\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + "hello \u00ce\u00ba\u00cf\u008c\u00cf\u0083\u00ce\u00bc\u00ce\u00b5!%\r\n" + "--xxxxxxxxxxxxxxxxxxxxxxxx--\r\n", out.toString(StandardCharsets.ISO_8859_1.name())); } @Test void testRandomBoundary() { final MultipartFormEntity entity = MultipartEntityBuilder.create() .buildEntity(); final NameValuePair boundaryParam = extractBoundary(entity.getContentType(), "multipart/mixed"); final String boundary = boundaryParam.getValue(); Assertions.assertNotNull(boundary); Assertions.assertEquals(56, boundary.length()); Assertions.assertTrue(boundary.startsWith("httpclient_boundary_")); Assertions.assertTrue(boundary.substring(20).matches("[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}")); } @Test void testRandomBoundaryWriteTo() throws Exception { final String helloWorld = "hello world"; final List parameters = new ArrayList<>(); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_NAME, "test")); parameters.add(new BasicNameValuePair(MimeConsts.FIELD_PARAM_FILENAME, helloWorld)); final MultipartFormEntity entity = MultipartEntityBuilder.create() .setStrictMode() .addPart(new FormBodyPartBuilder() .setName("test") .setBody(new StringBody("hello world", ContentType.TEXT_PLAIN)) .addField("Content-Disposition", "multipart/form-data", parameters) .build()) .buildEntity(); final NameValuePair boundaryParam = extractBoundary(entity.getContentType(), "multipart/form-data"); final String boundary = boundaryParam.getValue(); Assertions.assertNotNull(boundary); Assertions.assertEquals(56, boundary.length()); Assertions.assertTrue(boundary.startsWith("httpclient_boundary_")); Assertions.assertTrue(boundary.substring(20).matches("[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}")); final ByteArrayOutputStream out = new ByteArrayOutputStream(); entity.writeTo(out); out.close(); Assertions.assertEquals("--" + boundary + "\r\n" + "Content-Disposition: multipart/form-data; name=\"test\"; filename=\"hello world\"\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + helloWorld + "\r\n" + "--" + boundary + "--\r\n", out.toString(StandardCharsets.US_ASCII.name())); } private NameValuePair extractBoundary(final String contentType, final String expectedName) { final BasicHeaderValueParser parser = BasicHeaderValueParser.INSTANCE; final ParserCursor cursor = new ParserCursor(0, contentType.length()); final HeaderElement elem = parser.parseHeaderElement(contentType, cursor); Assertions.assertEquals(expectedName, elem.getName()); return elem.getParameterByName("boundary"); } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/TestFormBodyPartBuilder.java0100664 0000000 0000000 00000016255 14704162040 031321 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.File; import java.util.Arrays; import java.util.List; import org.apache.hc.core5.http.ContentType; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestFormBodyPartBuilder { @Test void testBuildBodyPartBasics() { final StringBody stringBody = new StringBody("stuff", ContentType.TEXT_PLAIN); final FormBodyPart bodyPart = FormBodyPartBuilder.create() .setName("blah") .setBody(stringBody) .build(); Assertions.assertNotNull(bodyPart); Assertions.assertEquals("blah", bodyPart.getName()); Assertions.assertEquals(stringBody, bodyPart.getBody()); final Header header = bodyPart.getHeader(); Assertions.assertNotNull(header); assertFields(Arrays.asList( new MimeField("Content-Disposition", "form-data; name=\"blah\""), new MimeField("Content-Type", "text/plain; charset=UTF-8")), header.getFields()); } @Test void testBuildBodyPartMultipleBuilds() { final StringBody stringBody = new StringBody("stuff", ContentType.TEXT_PLAIN); final FormBodyPartBuilder builder = FormBodyPartBuilder.create(); final FormBodyPart bodyPart1 = builder .setName("blah") .setBody(stringBody) .build(); Assertions.assertNotNull(bodyPart1); Assertions.assertEquals("blah", bodyPart1.getName()); Assertions.assertEquals(stringBody, bodyPart1.getBody()); final Header header1 = bodyPart1.getHeader(); Assertions.assertNotNull(header1); assertFields(Arrays.asList( new MimeField("Content-Disposition", "form-data; name=\"blah\""), new MimeField("Content-Type", "text/plain; charset=UTF-8")), header1.getFields()); final FileBody fileBody = new FileBody(new File("/path/stuff.bin"), ContentType.DEFAULT_BINARY); final FormBodyPart bodyPart2 = builder .setName("yada") .setBody(fileBody) .build(); Assertions.assertNotNull(bodyPart2); Assertions.assertEquals("yada", bodyPart2.getName()); Assertions.assertEquals(fileBody, bodyPart2.getBody()); final Header header2 = bodyPart2.getHeader(); Assertions.assertNotNull(header2); assertFields(Arrays.asList( new MimeField("Content-Disposition", "form-data; name=\"yada\"; filename=\"stuff.bin\""), new MimeField("Content-Type", "application/octet-stream")), header2.getFields()); } @Test void testBuildBodyPartCustomHeaders() { final StringBody stringBody = new StringBody("stuff", ContentType.TEXT_PLAIN); final FormBodyPartBuilder builder = FormBodyPartBuilder.create("blah", stringBody); final FormBodyPart bodyPart1 = builder .addField("header1", "blah") .addField("header3", "blah") .addField("header3", "blah") .addField("header3", "blah") .addField("header3", "blah") .addField("header3", "blah") .build(); Assertions.assertNotNull(bodyPart1); final Header header1 = bodyPart1.getHeader(); Assertions.assertNotNull(header1); assertFields(Arrays.asList( new MimeField("header1", "blah"), new MimeField("header3", "blah"), new MimeField("header3", "blah"), new MimeField("header3", "blah"), new MimeField("header3", "blah"), new MimeField("header3", "blah"), new MimeField("Content-Disposition", "form-data; name=\"blah\""), new MimeField("Content-Type", "text/plain; charset=UTF-8")), header1.getFields()); final FormBodyPart bodyPart2 = builder .setField("header2", "yada") .removeFields("header3") .build(); Assertions.assertNotNull(bodyPart2); final Header header2 = bodyPart2.getHeader(); Assertions.assertNotNull(header2); assertFields(Arrays.asList( new MimeField("header1", "blah"), new MimeField("header2", "yada"), new MimeField("Content-Disposition", "form-data; name=\"blah\""), new MimeField("Content-Type", "text/plain; charset=UTF-8")), header2.getFields()); final FormBodyPart bodyPart3 = builder .addField("Content-Disposition", "disposition stuff") .addField("Content-Type", "type stuff") .addField("Content-Transfer-Encoding", "encoding stuff") .build(); Assertions.assertNotNull(bodyPart3); final Header header3 = bodyPart3.getHeader(); Assertions.assertNotNull(header3); assertFields(Arrays.asList( new MimeField("header1", "blah"), new MimeField("header2", "yada"), new MimeField("Content-Disposition", "disposition stuff"), new MimeField("Content-Type", "type stuff"), new MimeField("Content-Transfer-Encoding", "encoding stuff")), header3.getFields()); } private static void assertFields(final List expected, final List result) { Assertions.assertNotNull(result); Assertions.assertEquals(expected.size(), result.size()); for (int i = 0; i < expected.size(); i++) { final MimeField expectedField = expected.get(i); final MimeField resultField = result.get(i); Assertions.assertNotNull(resultField); Assertions.assertEquals(expectedField.getName(), resultField.getName()); Assertions.assertEquals(expectedField.getBody(), resultField.getBody()); } } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/TestMultipartPartBuilder.java0100664 0000000 0000000 00000014644 14704162040 031561 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.File; import java.util.Arrays; import java.util.Collections; import java.util.List; import org.apache.hc.core5.http.ContentType; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestMultipartPartBuilder { @Test void testBuildBodyPartBasics() { final StringBody stringBody = new StringBody("stuff", ContentType.TEXT_PLAIN); final MultipartPart part = MultipartPartBuilder.create() .setBody(stringBody) .build(); Assertions.assertNotNull(part); Assertions.assertEquals(stringBody, part.getBody()); final Header header = part.getHeader(); Assertions.assertNotNull(header); assertFields(Collections.singletonList( new MimeField("Content-Type", "text/plain; charset=UTF-8")), header.getFields()); } @Test void testBuildBodyPartMultipleBuilds() { final StringBody stringBody = new StringBody("stuff", ContentType.TEXT_PLAIN); final MultipartPartBuilder builder = MultipartPartBuilder.create(); final MultipartPart part1 = builder .setBody(stringBody) .build(); Assertions.assertNotNull(part1); Assertions.assertEquals(stringBody, part1.getBody()); final Header header1 = part1.getHeader(); Assertions.assertNotNull(header1); assertFields(Collections.singletonList( new MimeField("Content-Type", "text/plain; charset=UTF-8")), header1.getFields()); final FileBody fileBody = new FileBody(new File("/path/stuff.bin"), ContentType.DEFAULT_BINARY); final MultipartPart part2 = builder .setBody(fileBody) .build(); Assertions.assertNotNull(part2); Assertions.assertEquals(fileBody, part2.getBody()); final Header header2 = part2.getHeader(); Assertions.assertNotNull(header2); assertFields(Collections.singletonList( new MimeField("Content-Type", "application/octet-stream")), header2.getFields()); } @Test void testBuildBodyPartCustomHeaders() { final StringBody stringBody = new StringBody("stuff", ContentType.TEXT_PLAIN); final MultipartPartBuilder builder = MultipartPartBuilder.create(stringBody); final MultipartPart part1 = builder .addHeader("header1", "blah") .addHeader("header3", "blah") .addHeader("header3", "blah") .addHeader("header3", "blah") .addHeader("header3", "blah") .addHeader("header3", "blah") .build(); Assertions.assertNotNull(part1); final Header header1 = part1.getHeader(); Assertions.assertNotNull(header1); assertFields(Arrays.asList( new MimeField("header1", "blah"), new MimeField("header3", "blah"), new MimeField("header3", "blah"), new MimeField("header3", "blah"), new MimeField("header3", "blah"), new MimeField("header3", "blah"), new MimeField("Content-Type", "text/plain; charset=UTF-8")), header1.getFields()); final MultipartPart part2 = builder .addHeader("header2", "yada") .removeHeaders("header3") .build(); Assertions.assertNotNull(part2); final Header header2 = part2.getHeader(); Assertions.assertNotNull(header2); assertFields(Arrays.asList( new MimeField("header1", "blah"), new MimeField("header2", "yada"), new MimeField("Content-Type", "text/plain; charset=UTF-8")), header2.getFields()); final MultipartPart part3 = builder .addHeader("Content-Disposition", "disposition stuff") .addHeader("Content-Type", "type stuff") .addHeader("Content-Transfer-Encoding", "encoding stuff") .build(); Assertions.assertNotNull(part3); final Header header3 = part3.getHeader(); Assertions.assertNotNull(header3); assertFields(Arrays.asList( new MimeField("header1", "blah"), new MimeField("header2", "yada"), new MimeField("Content-Disposition", "disposition stuff"), new MimeField("Content-Type", "type stuff"), new MimeField("Content-Transfer-Encoding", "encoding stuff")), header3.getFields()); } private static void assertFields(final List expected, final List result) { Assertions.assertNotNull(result); Assertions.assertEquals(expected.size(), result.size()); for (int i = 0; i < expected.size(); i++) { final MimeField expectedField = expected.get(i); final MimeField resultField = result.get(i); Assertions.assertNotNull(resultField); Assertions.assertEquals(expectedField.getName(), resultField.getName()); Assertions.assertEquals(expectedField.getBody(), resultField.getBody()); } } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/TestMimeField.java0100664 0000000 0000000 00000004037 14704162040 027270 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.util.Arrays; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestMimeField { @Test void testBasics() { final MimeField f1 = new MimeField("some-field", "some-value", Arrays.asList( new BasicNameValuePair("p1", "this"), new BasicNameValuePair("p2", "that"), new BasicNameValuePair("p3", "\"this \\and\\ that\""))); Assertions.assertEquals("some-field", f1.getName()); Assertions.assertEquals("some-value", f1.getValue()); Assertions.assertEquals("some-value; p1=\"this\"; p2=\"that\"; p3=\"\\\"this \\\\and\\\\ that\\\"\"", f1.getBody()); } }httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/TestMultipartMixed.java0100664 0000000 0000000 00000031524 15063503632 030413 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.ByteArrayOutputStream; import java.io.File; import java.io.FileInputStream; import java.io.FileWriter; import java.io.Writer; import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.util.Arrays; import org.apache.hc.core5.http.ContentType; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestMultipartMixed { private File tmpfile; @AfterEach void cleanup() { if (tmpfile != null) { tmpfile.delete(); } } @Test void testMultipartPartStringParts() throws Exception { final MultipartPart p1 = MultipartPartBuilder.create( new StringBody("this stuff", ContentType.DEFAULT_TEXT)).build(); final MultipartPart p2 = MultipartPartBuilder.create( new StringBody("that stuff", ContentType.create( ContentType.TEXT_PLAIN.getMimeType(), StandardCharsets.ISO_8859_1))).build(); final MultipartPart p3 = MultipartPartBuilder.create( new StringBody("all kind of stuff", ContentType.DEFAULT_TEXT)).build(); final HttpStrictMultipart multipart = new HttpStrictMultipart(null, "foo", Arrays.asList(p1, p2, p3)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + "this stuff\r\n" + "--foo\r\n" + "Content-Type: text/plain; charset=ISO-8859-1\r\n" + "\r\n" + "that stuff\r\n" + "--foo\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + "all kind of stuff\r\n" + "--foo--\r\n"; final String s = out.toString("US-ASCII"); Assertions.assertEquals(expected, s); Assertions.assertEquals(s.length(), multipart.getTotalLength()); } @Test void testMultipartPartCustomContentType() throws Exception { final MultipartPart p1 = MultipartPartBuilder.create( new StringBody("this stuff", ContentType.DEFAULT_TEXT)).build(); final MultipartPart p2 = MultipartPartBuilder.create( new StringBody("that stuff", ContentType.parse("stuff/plain; param=value"))).build(); final HttpStrictMultipart multipart = new HttpStrictMultipart(null, "foo", Arrays.asList(p1, p2)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Type: text/plain; charset=UTF-8\r\n" + "\r\n" + "this stuff\r\n" + "--foo\r\n" + "Content-Type: stuff/plain; param=value\r\n" + "\r\n" + "that stuff\r\n" + "--foo--\r\n"; final String s = out.toString("US-ASCII"); Assertions.assertEquals(expected, s); Assertions.assertEquals(s.length(), multipart.getTotalLength()); } @Test void testMultipartPartBinaryParts() throws Exception { tmpfile = File.createTempFile("tmp", ".bin"); try (Writer writer = new FileWriter(tmpfile)) { writer.append("some random whatever"); } final MultipartPart p1 = MultipartPartBuilder.create( new FileBody(tmpfile)).build(); @SuppressWarnings("resource") final MultipartPart p2 = MultipartPartBuilder.create( new InputStreamBody(new FileInputStream(tmpfile), "file.tmp")).build(); final HttpStrictMultipart multipart = new HttpStrictMultipart(null, "foo", Arrays.asList(p1, p2)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo--\r\n"; final String s = out.toString("US-ASCII"); Assertions.assertEquals(expected, s); Assertions.assertEquals(-1, multipart.getTotalLength()); } @Test void testMultipartPartStrict() throws Exception { tmpfile = File.createTempFile("tmp", ".bin"); try (Writer writer = new FileWriter(tmpfile)) { writer.append("some random whatever"); } final MultipartPart p1 = MultipartPartBuilder.create( new FileBody(tmpfile)).build(); final MultipartPart p2 = MultipartPartBuilder.create( new FileBody(tmpfile, ContentType.create("text/plain", "ANSI_X3.4-1968"), "test-file")).build(); @SuppressWarnings("resource") final MultipartPart p3 = MultipartPartBuilder.create( new InputStreamBody(new FileInputStream(tmpfile), "file.tmp")).build(); final HttpStrictMultipart multipart = new HttpStrictMultipart(null, "foo", Arrays.asList(p1, p2, p3)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Type: text/plain; charset=US-ASCII\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo--\r\n"; final String s = out.toString("US-ASCII"); Assertions.assertEquals(expected, s); Assertions.assertEquals(-1, multipart.getTotalLength()); } @Test void testMultipartPartRFC6532() throws Exception { tmpfile = File.createTempFile("tmp", ".bin"); try (Writer writer = new FileWriter(tmpfile)) { writer.append("some random whatever"); } final MultipartPart p1 = MultipartPartBuilder.create( new FileBody(tmpfile)).build(); final MultipartPart p2 = MultipartPartBuilder.create( new FileBody(tmpfile, ContentType.create("text/plain", "ANSI_X3.4-1968"), "test-file")).build(); @SuppressWarnings("resource") final MultipartPart p3 = MultipartPartBuilder.create( new InputStreamBody(new FileInputStream(tmpfile), "file.tmp")).build(); final HttpRFC6532Multipart multipart = new HttpRFC6532Multipart(null, "foo", Arrays.asList(p1, p2, p3)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Type: text/plain; charset=US-ASCII\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo--\r\n"; final String s = out.toString("UTF-8"); Assertions.assertEquals(expected, s); Assertions.assertEquals(-1, multipart.getTotalLength()); } private static final int SWISS_GERMAN_HELLO [] = { 0x47, 0x72, 0xFC, 0x65, 0x7A, 0x69, 0x5F, 0x7A, 0xE4, 0x6D, 0xE4 }; private static final int RUSSIAN_HELLO [] = { 0x412, 0x441, 0x435, 0x43C, 0x5F, 0x43F, 0x440, 0x438, 0x432, 0x435, 0x442 }; private static String constructString(final int [] unicodeChars) { final StringBuilder buffer = new StringBuilder(); if (unicodeChars != null) { for (final int unicodeChar : unicodeChars) { buffer.append((char)unicodeChar); } } return buffer.toString(); } @Test void testMultipartPartBrowserCompatibleNonASCIIHeaders() throws Exception { final String s1 = constructString(SWISS_GERMAN_HELLO); final String s2 = constructString(RUSSIAN_HELLO); tmpfile = File.createTempFile("tmp", ".bin"); try (Writer writer = new FileWriter(tmpfile)) { writer.append("some random whatever"); } @SuppressWarnings("resource") final MultipartPart p1 = MultipartPartBuilder.create( new InputStreamBody(new FileInputStream(tmpfile), s1 + ".tmp")).build(); @SuppressWarnings("resource") final MultipartPart p2 = MultipartPartBuilder.create( new InputStreamBody(new FileInputStream(tmpfile), s2 + ".tmp")).build(); final LegacyMultipart multipart = new LegacyMultipart( StandardCharsets.UTF_8, "foo", Arrays.asList(p1, p2)); final ByteArrayOutputStream out = new ByteArrayOutputStream(); multipart.writeTo(out); out.close(); final String expected = "--foo\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo\r\n" + "Content-Type: application/octet-stream\r\n" + "\r\n" + "some random whatever\r\n" + "--foo--\r\n"; final String s = out.toString("UTF-8"); Assertions.assertEquals(expected, s); Assertions.assertEquals(-1, multipart.getTotalLength()); } @Test void testMultipartPartStringPartsMultiCharsets() throws Exception { final String s1 = constructString(SWISS_GERMAN_HELLO); final String s2 = constructString(RUSSIAN_HELLO); final MultipartPart p1 = MultipartPartBuilder.create( new StringBody(s1, ContentType.create("text/plain", StandardCharsets.ISO_8859_1))).build(); final MultipartPart p2 = MultipartPartBuilder.create( new StringBody(s2, ContentType.create("text/plain", Charset.forName("KOI8-R")))).build(); final HttpStrictMultipart multipart = new HttpStrictMultipart(null, "foo", Arrays.asList(p1, p2)); final ByteArrayOutputStream out1 = new ByteArrayOutputStream(); multipart.writeTo(out1); out1.close(); final ByteArrayOutputStream out2 = new ByteArrayOutputStream(); out2.write(( "--foo\r\n" + "Content-Type: text/plain; charset=ISO-8859-1\r\n" + "\r\n").getBytes(StandardCharsets.US_ASCII)); out2.write(s1.getBytes(StandardCharsets.ISO_8859_1)); out2.write(("\r\n" + "--foo\r\n" + "Content-Type: text/plain; charset=KOI8-R\r\n" + "\r\n").getBytes(StandardCharsets.US_ASCII)); out2.write(s2.getBytes(Charset.forName("KOI8-R"))); out2.write(("\r\n" + "--foo--\r\n").getBytes(StandardCharsets.US_ASCII)); out2.close(); final byte[] actual = out1.toByteArray(); final byte[] expected = out2.toByteArray(); Assertions.assertEquals(expected.length, actual.length); for (int i = 0; i < actual.length; i++) { Assertions.assertEquals(expected[i], actual[i]); } Assertions.assertEquals(expected.length, multipart.getTotalLength()); } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/TestMultipartFormat.java0100664 0000000 0000000 00000004251 14704162040 030565 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestMultipartFormat { @Test void testLineBreak() { Assertions.assertTrue(AbstractMultipartFormat.isLineBreak('\r')); Assertions.assertTrue(AbstractMultipartFormat.isLineBreak('\n')); Assertions.assertTrue(AbstractMultipartFormat.isLineBreak('\f')); Assertions.assertTrue(AbstractMultipartFormat.isLineBreak((char) 11)); Assertions.assertFalse(AbstractMultipartFormat.isLineBreak(' ')); Assertions.assertFalse(AbstractMultipartFormat.isLineBreak('x')); } @Test void testLineBreakRewrite() { final String s = "blah blah blah"; Assertions.assertSame(s, AbstractMultipartFormat.stripLineBreaks(s)); Assertions.assertEquals("blah blah blah ", AbstractMultipartFormat.stripLineBreaks("blah\rblah\nblah\f")); Assertions.assertEquals(" f", AbstractMultipartFormat.stripLineBreaks("\r\n\r\nf")); } }httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/TestMultipartFormHttpEntity.java0100664 0000000 0000000 00000012636 15005672035 032310 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.nio.charset.StandardCharsets; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.message.BasicHeaderValueParser; import org.apache.hc.core5.http.message.ParserCursor; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestMultipartFormHttpEntity { @Test void testExplicitContractorParams() { final HttpEntity entity = MultipartEntityBuilder.create() .setLaxMode() .setBoundary("whatever") .setCharset(StandardCharsets.UTF_8) .build(); Assertions.assertNull(entity.getContentEncoding()); final String contentType = entity.getContentType(); final HeaderElement elem = BasicHeaderValueParser.INSTANCE.parseHeaderElement(contentType, new ParserCursor(0, contentType.length())); Assertions.assertEquals("multipart/mixed", elem.getName()); final NameValuePair p1 = elem.getParameterByName("boundary"); Assertions.assertNotNull(p1); Assertions.assertEquals("whatever", p1.getValue()); final NameValuePair p2 = elem.getParameterByName("charset"); Assertions.assertNull(p2, "RFC7578 does not mention charset parameter for Content-Type, " + "so no charset should be present for MultipartEntity.getContentType()"); } @Test void testImplicitContractorParams() { final HttpEntity entity = MultipartEntityBuilder.create().build(); Assertions.assertNull(entity.getContentEncoding()); final String contentType = entity.getContentType(); final HeaderElement elem = BasicHeaderValueParser.INSTANCE.parseHeaderElement(contentType, new ParserCursor(0, contentType.length())); Assertions.assertEquals("multipart/mixed", elem.getName()); final NameValuePair p1 = elem.getParameterByName("boundary"); Assertions.assertNotNull(p1); final String boundary = p1.getValue(); Assertions.assertNotNull(boundary); // "httpclient_boundary_" + UUID (32 characters + 4 dashes) + 56 characters Assertions.assertEquals(56, boundary.length()); final NameValuePair p2 = elem.getParameterByName("charset"); Assertions.assertNull(p2); } @Test void testRepeatable() throws Exception { final HttpEntity entity = MultipartEntityBuilder.create() .addTextBody("p1", "blah blah", ContentType.DEFAULT_TEXT) .addTextBody("p2", "yada yada", ContentType.DEFAULT_TEXT) .build(); Assertions.assertTrue(entity.isRepeatable()); Assertions.assertFalse(entity.isChunked()); Assertions.assertFalse(entity.isStreaming()); final long len = entity.getContentLength(); Assertions.assertEquals(len, entity.getContentLength()); ByteArrayOutputStream out = new ByteArrayOutputStream(); entity.writeTo(out); out.close(); byte[] bytes = out.toByteArray(); Assertions.assertNotNull(bytes); Assertions.assertEquals(bytes.length, len); Assertions.assertEquals(len, entity.getContentLength()); out = new ByteArrayOutputStream(); entity.writeTo(out); out.close(); bytes = out.toByteArray(); Assertions.assertNotNull(bytes); Assertions.assertEquals(bytes.length, len); } @Test void testNonRepeatable() { final HttpEntity entity = MultipartEntityBuilder.create() .addPart("p1", new InputStreamBody( new ByteArrayInputStream("blah blah".getBytes()), ContentType.DEFAULT_BINARY)) .addPart("p2", new InputStreamBody( new ByteArrayInputStream("yada yada".getBytes()), ContentType.DEFAULT_BINARY)) .build(); Assertions.assertFalse(entity.isRepeatable()); Assertions.assertTrue(entity.isChunked()); Assertions.assertTrue(entity.isStreaming()); Assertions.assertEquals(-1, entity.getContentLength()); } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/mime/FormBodyPartTest.java0100664 0000000 0000000 00000003266 15063503632 030015 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity.mime; import java.io.File; import org.apache.hc.core5.http.ContentType; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class FormBodyPartTest { @Test void testConstructorCompat() throws Exception { final File tmp = File.createTempFile("test", "test"); tmp.deleteOnExit(); final FileBody obj = new FileBody(tmp, ContentType.APPLICATION_OCTET_STREAM); Assertions.assertEquals(tmp.getName(), obj.getFilename()); } } httpclient5/src/test/java/org/apache/hc/client5/http/entity/TestBrotli.java0100664 0000000 0000000 00000003716 15063503632 025751 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.entity; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.ByteArrayEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestBrotli { /** * Brotli decompression test implemented by request with specified response encoding br * * @throws Exception */ @Test void testDecompressionWithBrotli() throws Exception { final byte[] bytes = new byte[] {33, 44, 0, 4, 116, 101, 115, 116, 32, 98, 114, 111, 116, 108, 105, 10, 3}; final HttpEntity entity = new BrotliDecompressingEntity(new ByteArrayEntity(bytes, null)); Assertions.assertEquals("test brotli\n", EntityUtils.toString(entity)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/0040775 0000000 0000000 00000000000 15063503632 022434 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/TestRequestSupport.java0100664 0000000 0000000 00000005400 14704162040 027153 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Simple tests for {@link RequestSupport}. */ class TestRequestSupport { @Test void testPathPrefixExtraction() { Assertions.assertEquals("/aaaa/", RequestSupport.extractPathPrefix(new BasicHttpRequest("GET", "/aaaa/bbbb"))); Assertions.assertEquals("/aaaa/", RequestSupport.extractPathPrefix(new BasicHttpRequest("GET", "/aaaa/"))); Assertions.assertEquals("/aaaa/", RequestSupport.extractPathPrefix(new BasicHttpRequest("GET", "/aaaa/../aaaa/"))); Assertions.assertEquals("/aaaa/bbbb/", RequestSupport.extractPathPrefix(new BasicHttpRequest("GET", "/aaaa/bbbb/cccc"))); Assertions.assertEquals("/aaaa/bbbb/", RequestSupport.extractPathPrefix(new BasicHttpRequest("GET", "/aaaa/bbbb/"))); Assertions.assertEquals("/aaaa/", RequestSupport.extractPathPrefix(new BasicHttpRequest("GET", "/aaaa/bbbb?////"))); Assertions.assertEquals("/aa%2Faa/", RequestSupport.extractPathPrefix(new BasicHttpRequest("GET", "/aa%2faa/bbbb"))); Assertions.assertEquals("/aa%2Faa/", RequestSupport.extractPathPrefix(new BasicHttpRequest("GET", "/a%61%2fa%61/bbbb"))); Assertions.assertEquals("/", RequestSupport.extractPathPrefix(new BasicHttpRequest("GET", "/"))); Assertions.assertEquals("/", RequestSupport.extractPathPrefix(new BasicHttpRequest("GET", "/aaaa"))); Assertions.assertEquals("/", RequestSupport.extractPathPrefix(new BasicHttpRequest("GET", ""))); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/0040775 0000000 0000000 00000000000 15063503637 023402 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/TestAuthenticationHandler.java0100664 0000000 0000000 00000060672 15005672016 031364 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.util.LinkedList; import java.util.Queue; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthStateCacheable; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.protocol.HttpContext; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Answers; import org.mockito.Mockito; class TestAuthenticationHandler { @AuthStateCacheable abstract class CacheableAuthState implements AuthScheme { @Override public String getName() { return StandardAuthScheme.BASIC; } } private AuthExchange authExchange; private CacheableAuthState authScheme; private HttpClientContext context; private HttpHost defaultHost; private CredentialsProvider credentialsProvider; private Lookup authSchemeRegistry; private AuthenticationHandler httpAuthenticator; @BeforeEach void setUp() { this.authExchange = new AuthExchange(); this.authScheme = Mockito.mock(CacheableAuthState.class, Mockito.withSettings() .defaultAnswer(Answers.CALLS_REAL_METHODS)); Mockito.when(this.authScheme.isChallengeComplete()).thenReturn(Boolean.TRUE); this.context = HttpClientContext.create(); this.defaultHost = new HttpHost("localhost", 80); this.credentialsProvider = Mockito.mock(CredentialsProvider.class); this.context.setCredentialsProvider(this.credentialsProvider); this.authSchemeRegistry = RegistryBuilder.create() .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE) .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE) .build(); this.context.setAuthSchemeRegistry(this.authSchemeRegistry); this.httpAuthenticator = new AuthenticationHandler(); } @Test void testUpdateAuthExchange() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.setHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=test"); Assertions.assertTrue(this.httpAuthenticator.isChallenged( this.defaultHost, ChallengeType.TARGET, response, this.authExchange, this.context)); } @Test void testAuthenticationRequestedAfterSuccess() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.setHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=test"); this.authExchange.select(this.authScheme); this.authExchange.setState(AuthExchange.State.SUCCESS); Assertions.assertTrue(this.httpAuthenticator.isChallenged( this.defaultHost, ChallengeType.TARGET, response, this.authExchange, this.context)); } @Test void testAuthenticationNotRequestedUnchallenged() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); Assertions.assertFalse(this.httpAuthenticator.isChallenged( this.defaultHost, ChallengeType.TARGET, response, this.authExchange, this.context)); Assertions.assertEquals(AuthExchange.State.UNCHALLENGED, this.authExchange.getState()); } @Test void testAuthenticationNotRequestedSuccess1() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); this.authExchange.select(this.authScheme); this.authExchange.setState(AuthExchange.State.CHALLENGED); Assertions.assertFalse(this.httpAuthenticator.isChallenged( this.defaultHost, ChallengeType.TARGET, response, this.authExchange, this.context)); Assertions.assertEquals(AuthExchange.State.SUCCESS, this.authExchange.getState()); } @Test void testAuthenticationNotRequestedSuccess2() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_OK, "OK"); this.authExchange.select(this.authScheme); this.authExchange.setState(AuthExchange.State.HANDSHAKE); Assertions.assertFalse(this.httpAuthenticator.isChallenged( this.defaultHost, ChallengeType.TARGET, response, this.authExchange, this.context)); Assertions.assertEquals(AuthExchange.State.SUCCESS, this.authExchange.getState()); } @Test void testAuthentication() throws AuthenticationException, MalformedChallengeException { final HttpHost host = new HttpHost("somehost", 80); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=\"test\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"1234\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, "whatever realm=\"realm1\", stuff=\"1234\"")); final Credentials credentials = new UsernamePasswordCredentials("user", "pass".toCharArray()); Mockito.when(this.credentialsProvider.getCredentials(Mockito.any(), Mockito.any())).thenReturn(credentials); final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); Assertions.assertTrue(this.httpAuthenticator.handleResponse(host, ChallengeType.TARGET, response, authStrategy, this.authExchange, this.context)); Assertions.assertEquals(AuthExchange.State.CHALLENGED, this.authExchange.getState()); final Queue options = this.authExchange.getAuthOptions(); Assertions.assertNotNull(options); final AuthScheme authScheme1 = options.poll(); Assertions.assertNotNull(authScheme1); Assertions.assertEquals(StandardAuthScheme.DIGEST, authScheme1.getName()); final AuthScheme authScheme2 = options.poll(); Assertions.assertNotNull(authScheme2); Assertions.assertEquals(StandardAuthScheme.BASIC, authScheme2.getName()); Assertions.assertNull(options.poll()); } @Test void testAuthenticationCredentialsForBasic() throws AuthenticationException, MalformedChallengeException { final HttpHost host = new HttpHost("somehost", 80); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=\"test\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"1234\"")); final Credentials credentials = new UsernamePasswordCredentials("user", "pass".toCharArray()); Mockito.when(this.credentialsProvider.getCredentials(Mockito.eq(new AuthScope(host, "test", StandardAuthScheme.BASIC)), Mockito.any())).thenReturn(credentials); final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); Assertions.assertTrue(this.httpAuthenticator.handleResponse(host, ChallengeType.TARGET, response, authStrategy, this.authExchange, this.context)); Assertions.assertEquals(AuthExchange.State.CHALLENGED, this.authExchange.getState()); final Queue options = this.authExchange.getAuthOptions(); Assertions.assertNotNull(options); final AuthScheme authScheme1 = options.poll(); Assertions.assertNotNull(authScheme1); Assertions.assertEquals(StandardAuthScheme.BASIC, authScheme1.getName()); Assertions.assertNull(options.poll()); } @Test void testAuthenticationNoChallenges() throws AuthenticationException, MalformedChallengeException { final HttpHost host = new HttpHost("somehost", 80); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); Assertions.assertFalse(this.httpAuthenticator.handleResponse( host, ChallengeType.TARGET, response, authStrategy, this.authExchange, this.context)); } @Test void testAuthenticationNoSupportedChallenges() throws AuthenticationException, MalformedChallengeException { final HttpHost host = new HttpHost("somehost", 80); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, "This realm=\"test\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, "That realm=\"realm1\", nonce=\"1234\"")); final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); Assertions.assertFalse(this.httpAuthenticator.handleResponse( host, ChallengeType.TARGET, response, authStrategy, this.authExchange, this.context)); } @Test void testAuthenticationNoCredentials() throws AuthenticationException, MalformedChallengeException { final HttpHost host = new HttpHost("somehost", 80); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=\"test\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"1234\"")); final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); Assertions.assertFalse(this.httpAuthenticator.handleResponse( host, ChallengeType.TARGET, response, authStrategy, this.authExchange, this.context)); } @Test void testAuthenticationFailed() throws AuthenticationException, MalformedChallengeException { final HttpHost host = new HttpHost("somehost", 80); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=\"test\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"1234\"")); this.authExchange.setState(AuthExchange.State.CHALLENGED); this.authExchange.select(this.authScheme); final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); Assertions.assertFalse(this.httpAuthenticator.handleResponse( host, ChallengeType.TARGET, response, authStrategy, this.authExchange, this.context)); Assertions.assertEquals(AuthExchange.State.FAILURE, this.authExchange.getState()); } @Test void testAuthenticationFailedPreviously() throws AuthenticationException, MalformedChallengeException { final HttpHost host = new HttpHost("somehost", 80); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=\"test\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"1234\"")); this.authExchange.setState(AuthExchange.State.FAILURE); final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); Assertions.assertFalse(this.httpAuthenticator.handleResponse( host, ChallengeType.TARGET, response, authStrategy, this.authExchange, this.context)); Assertions.assertEquals(AuthExchange.State.FAILURE, this.authExchange.getState()); } @Test void testAuthenticationFailure() throws AuthenticationException, MalformedChallengeException { final HttpHost host = new HttpHost("somehost", 80); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=\"test\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"1234\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, "whatever realm=\"realm1\", stuff=\"1234\"")); final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); this.authExchange.setState(AuthExchange.State.CHALLENGED); this.authExchange.select(new BasicScheme()); Assertions.assertFalse(this.httpAuthenticator.handleResponse( host, ChallengeType.TARGET, response, authStrategy, this.authExchange, this.context)); Assertions.assertEquals(AuthExchange.State.FAILURE, this.authExchange.getState()); } @Test void testAuthenticationHandshaking() throws AuthenticationException, MalformedChallengeException { final HttpHost host = new HttpHost("somehost", 80); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=\"test\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.DIGEST + " realm=\"realm1\", stale=true, nonce=\"1234\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, "whatever realm=\"realm1\", stuff=\"1234\"")); final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); this.authExchange.setState(AuthExchange.State.CHALLENGED); this.authExchange.select(new DigestScheme()); Assertions.assertTrue(this.httpAuthenticator.handleResponse( host, ChallengeType.TARGET, response, authStrategy, this.authExchange, this.context)); Assertions.assertEquals(AuthExchange.State.HANDSHAKE, this.authExchange.getState()); } @Test void testAuthenticationNoMatchingChallenge() throws AuthenticationException, MalformedChallengeException { final HttpHost host = new HttpHost("somehost", 80); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"1234\"")); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, "whatever realm=\"realm1\", stuff=\"1234\"")); final Credentials credentials = new UsernamePasswordCredentials("user", "pass".toCharArray()); Mockito.when(this.credentialsProvider.getCredentials(Mockito.eq(new AuthScope(host, "realm1", StandardAuthScheme.DIGEST)), Mockito.any())).thenReturn(credentials); final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); this.authExchange.setState(AuthExchange.State.CHALLENGED); this.authExchange.select(new BasicScheme()); Assertions.assertTrue(this.httpAuthenticator.handleResponse( host, ChallengeType.TARGET, response, authStrategy, this.authExchange, this.context)); Assertions.assertEquals(AuthExchange.State.CHALLENGED, this.authExchange.getState()); final Queue options = this.authExchange.getAuthOptions(); Assertions.assertNotNull(options); final AuthScheme authScheme1 = options.poll(); Assertions.assertNotNull(authScheme1); Assertions.assertEquals(StandardAuthScheme.DIGEST, authScheme1.getName()); Assertions.assertNull(options.poll()); } @Test void testAuthenticationException() throws AuthenticationException, MalformedChallengeException { final HttpHost host = new HttpHost("somehost", 80); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_UNAUTHORIZED, "UNAUTHORIZED"); response.addHeader(new BasicHeader(HttpHeaders.WWW_AUTHENTICATE, "blah blah blah")); this.authExchange.setState(AuthExchange.State.CHALLENGED); final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); Assertions.assertFalse(this.httpAuthenticator.handleResponse( host, ChallengeType.TARGET, response, authStrategy, this.authExchange, this.context)); Assertions.assertEquals(AuthExchange.State.UNCHALLENGED, this.authExchange.getState()); Assertions.assertNull(this.authExchange.getAuthScheme()); } @Test void testAuthFailureState() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); this.authExchange.setState(AuthExchange.State.FAILURE); this.authExchange.select(this.authScheme); this.httpAuthenticator.addAuthResponse(defaultHost, ChallengeType.TARGET, request, authExchange, context); Assertions.assertFalse(request.containsHeader(HttpHeaders.AUTHORIZATION)); Mockito.verify(this.authScheme, Mockito.never()).generateAuthResponse( Mockito.eq(defaultHost), Mockito.any(HttpRequest.class), Mockito.any(HttpContext.class)); } @Test void testAuthChallengeStateNoOption() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); this.authExchange.setState(AuthExchange.State.CHALLENGED); this.authExchange.select(this.authScheme); Mockito.when(this.authScheme.generateAuthResponse( Mockito.eq(defaultHost), Mockito.any(HttpRequest.class), Mockito.any(HttpContext.class))).thenReturn("stuff"); this.httpAuthenticator.addAuthResponse(defaultHost, ChallengeType.TARGET, request, authExchange, context); Assertions.assertTrue(request.containsHeader(HttpHeaders.AUTHORIZATION)); } @Test void testAuthChallengeStateOneOptions() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); this.authExchange.setState(AuthExchange.State.CHALLENGED); final LinkedList authOptions = new LinkedList<>(); authOptions.add(this.authScheme); this.authExchange.setOptions(authOptions); Mockito.when(this.authScheme.generateAuthResponse( Mockito.eq(defaultHost), Mockito.any(HttpRequest.class), Mockito.any(HttpContext.class))).thenReturn("stuff"); this.httpAuthenticator.addAuthResponse(defaultHost, ChallengeType.TARGET, request, authExchange, context); Assertions.assertSame(this.authScheme, this.authExchange.getAuthScheme()); Assertions.assertNull(this.authExchange.getAuthOptions()); Assertions.assertTrue(request.containsHeader(HttpHeaders.AUTHORIZATION)); } @Test void testAuthChallengeStateMultipleOption() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); this.authExchange.setState(AuthExchange.State.CHALLENGED); final LinkedList authOptions = new LinkedList<>(); final AuthScheme authScheme1 = Mockito.mock(AuthScheme.class); Mockito.doThrow(new AuthenticationException()).when(authScheme1).generateAuthResponse( Mockito.eq(defaultHost), Mockito.any(HttpRequest.class), Mockito.any(HttpContext.class)); final AuthScheme authScheme2 = Mockito.mock(AuthScheme.class); Mockito.when(authScheme2.generateAuthResponse( Mockito.eq(defaultHost), Mockito.any(HttpRequest.class), Mockito.any(HttpContext.class))).thenReturn("stuff"); authOptions.add(authScheme1); authOptions.add(authScheme2); this.authExchange.setOptions(authOptions); this.httpAuthenticator.addAuthResponse(defaultHost, ChallengeType.TARGET, request, authExchange, context); Assertions.assertSame(authScheme2, this.authExchange.getAuthScheme()); Assertions.assertNull(this.authExchange.getAuthOptions()); Assertions.assertTrue(request.containsHeader(HttpHeaders.AUTHORIZATION)); } @Test void testAuthSuccess() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); this.authExchange.setState(AuthExchange.State.SUCCESS); this.authExchange.select(this.authScheme); Mockito.when(this.authScheme.isConnectionBased()).thenReturn(Boolean.FALSE); Mockito.when(this.authScheme.generateAuthResponse( Mockito.eq(defaultHost), Mockito.any(HttpRequest.class), Mockito.any(HttpContext.class))).thenReturn("stuff"); this.httpAuthenticator.addAuthResponse(defaultHost, ChallengeType.TARGET, request, authExchange, context); Assertions.assertSame(this.authScheme, this.authExchange.getAuthScheme()); Assertions.assertNull(this.authExchange.getAuthOptions()); Assertions.assertTrue(request.containsHeader(HttpHeaders.AUTHORIZATION)); } @Test void testAuthSuccessConnectionBased() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); this.authExchange.setState(AuthExchange.State.SUCCESS); this.authExchange.select(this.authScheme); Mockito.when(this.authScheme.isConnectionBased()).thenReturn(Boolean.TRUE); Mockito.when(this.authScheme.generateAuthResponse( Mockito.eq(defaultHost), Mockito.any(HttpRequest.class), Mockito.any(HttpContext.class))).thenReturn("stuff"); this.httpAuthenticator.addAuthResponse(defaultHost, ChallengeType.TARGET, request, authExchange, context); Assertions.assertFalse(request.containsHeader(HttpHeaders.AUTHORIZATION)); Mockito.verify(this.authScheme, Mockito.never()).generateAuthResponse( Mockito.eq(defaultHost), Mockito.any(HttpRequest.class), Mockito.any(HttpContext.class)); } } ././@LongLink0100644 0000000 0000000 00000000151 14704162040 011626 Lustar 0000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/TestSystemDefaultCredentialsProvider.javahttpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/TestSystemDefaultCredentialsProvider.0100664 0000000 0000000 00000015044 14704162040 032714 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.net.Authenticator; import java.net.Authenticator.RequestorType; import java.net.InetAddress; import java.net.PasswordAuthentication; import java.net.URL; import java.util.Locale; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.mockito.ArgumentMatchers; import org.mockito.Mockito; /** * Simple tests for {@link SystemDefaultCredentialsProvider}. */ class TestSystemDefaultCredentialsProvider { private final static String PROXY_PROTOCOL1 = "http"; private final static String PROXY_HOST1 = "proxyhost1"; private final static int PROXY_PORT1 = 3128; private final static String PROMPT1 = "HttpClient authentication test prompt"; private final static String TARGET_SCHEME1 = "https"; private final static String TARGET_HOST1 = "targethost1"; private final static int TARGET_PORT1 = 80; private final static PasswordAuthentication AUTH1 = new PasswordAuthentication("testUser", "testPassword".toCharArray()); // It's not possible to mock static Authenticator methods. So we mock a delegate private final static class DelegatedAuthenticator extends Authenticator { private final AuthenticatorDelegate authenticatorDelegate; private DelegatedAuthenticator(final AuthenticatorDelegate authenticatorDelegate) { this.authenticatorDelegate = authenticatorDelegate; } @Override protected PasswordAuthentication getPasswordAuthentication() { return authenticatorDelegate.getPasswordAuthentication(getRequestingHost(), getRequestingSite(), getRequestingPort(), getRequestingProtocol(), getRequestingPrompt(), getRequestingScheme(), getRequestingURL(), getRequestorType()); } } private interface AuthenticatorDelegate { PasswordAuthentication getPasswordAuthentication( String host, InetAddress addr, int port, String protocol, String prompt, String scheme, URL url, RequestorType reqType); } @Test void testSystemCredentialsProviderCredentials() throws Exception { final AuthenticatorDelegate authenticatorDelegate = installAuthenticator(AUTH1); final URL httpRequestUrl = new URL(TARGET_SCHEME1, TARGET_HOST1, TARGET_PORT1, "/"); final AuthScope authScope = new AuthScope(PROXY_PROTOCOL1, PROXY_HOST1, PROXY_PORT1, PROMPT1, StandardAuthScheme.BASIC); final HttpClientContext context = HttpClientContext.create(); context.setRequest(new HttpGet(httpRequestUrl.toURI())); final Credentials receivedCredentials = new SystemDefaultCredentialsProvider().getCredentials(authScope, context); Mockito.verify(authenticatorDelegate).getPasswordAuthentication( PROXY_HOST1, null, PROXY_PORT1, PROXY_PROTOCOL1, PROMPT1, StandardAuthScheme.BASIC.toUpperCase(Locale.ROOT), httpRequestUrl, RequestorType.SERVER); Assertions.assertNotNull(receivedCredentials); Assertions.assertEquals(AUTH1.getUserName(), receivedCredentials.getUserPrincipal().getName()); } @Test void testSystemCredentialsProviderNoContext() { final AuthenticatorDelegate authenticatorDelegate = installAuthenticator(AUTH1); final AuthScope authScope = new AuthScope(PROXY_PROTOCOL1, PROXY_HOST1, PROXY_PORT1, PROMPT1, StandardAuthScheme.BASIC); final Credentials receivedCredentials = new SystemDefaultCredentialsProvider().getCredentials(authScope, null); Mockito.verify(authenticatorDelegate).getPasswordAuthentication( PROXY_HOST1, null, PROXY_PORT1, PROXY_PROTOCOL1, PROMPT1, StandardAuthScheme.BASIC.toUpperCase(Locale.ROOT), null, RequestorType.SERVER); Assertions.assertNotNull(receivedCredentials); Assertions.assertEquals(AUTH1.getUserName(), receivedCredentials.getUserPrincipal().getName()); } private AuthenticatorDelegate installAuthenticator(final PasswordAuthentication returedAuthentication) { final AuthenticatorDelegate authenticatorDelegate = Mockito.mock(AuthenticatorDelegate.class); Mockito.when(authenticatorDelegate.getPasswordAuthentication(ArgumentMatchers.anyString(), ArgumentMatchers.any(), ArgumentMatchers.anyInt(), ArgumentMatchers.anyString(), ArgumentMatchers.anyString(), ArgumentMatchers.anyString(), ArgumentMatchers.any(), ArgumentMatchers.any())).thenReturn(returedAuthentication); Authenticator.setDefault(new DelegatedAuthenticator(authenticatorDelegate)); return authenticatorDelegate; } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/TestBasicScheme.java0100664 0000000 0000000 00000023224 15005672016 027245 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.nio.charset.StandardCharsets; import java.util.Base64; import java.util.List; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.util.CharArrayBuffer; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Basic authentication test cases. */ class TestBasicScheme { private static final Base64.Encoder BASE64_ENC = Base64.getEncoder(); private static AuthChallenge parse(final String s) throws ParseException { final CharArrayBuffer buffer = new CharArrayBuffer(s.length()); buffer.append(s); final ParserCursor cursor = new ParserCursor(0, buffer.length()); final List authChallenges = AuthChallengeParser.INSTANCE.parse(ChallengeType.TARGET, buffer, cursor); Assertions.assertEquals(1, authChallenges.size()); return authChallenges.get(0); } @Test void testBasicAuthenticationEmptyChallenge() throws Exception { final String challenge = StandardAuthScheme.BASIC; final AuthChallenge authChallenge = parse(challenge); final AuthScheme authscheme = new BasicScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertNull(authscheme.getRealm()); } @Test void testBasicAuthentication() throws Exception { final AuthChallenge authChallenge = parse("Basic realm=\"test\""); final BasicScheme authscheme = new BasicScheme(); authscheme.processChallenge(authChallenge, null); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "test", null), "testuser", "testpass".toCharArray()) .build(); final HttpRequest request = new BasicHttpRequest("GET", "/"); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); final byte[] testCreds = "testuser:testpass".getBytes(StandardCharsets.US_ASCII); final String expected = "Basic " + BASE64_ENC.encodeToString(testCreds); Assertions.assertEquals(expected, authResponse); Assertions.assertEquals("test", authscheme.getRealm()); Assertions.assertTrue(authscheme.isChallengeComplete()); Assertions.assertFalse(authscheme.isConnectionBased()); } static final String TEST_UTF8_PASSWORD = "123\u00A3"; @Test void testBasicAuthenticationDefaultCharset() throws Exception { final HttpHost host = new HttpHost("somehost", 80); final UsernamePasswordCredentials creds = new UsernamePasswordCredentials("test", TEST_UTF8_PASSWORD.toCharArray()); final BasicScheme authscheme = new BasicScheme(); final HttpRequest request = new BasicHttpRequest("GET", "/"); authscheme.initPreemptive(creds); final String authResponse = authscheme.generateAuthResponse(host, request, null); Assertions.assertEquals("Basic dGVzdDoxMjPCow==", authResponse); } @Test void testBasicAuthenticationDefaultCharsetUTF8() throws Exception { final HttpHost host = new HttpHost("somehost", 80); final UsernamePasswordCredentials creds = new UsernamePasswordCredentials("test", TEST_UTF8_PASSWORD.toCharArray()); final BasicScheme authscheme = new BasicScheme(); final HttpRequest request = new BasicHttpRequest("GET", "/"); authscheme.initPreemptive(creds); final String authResponse = authscheme.generateAuthResponse(host, request, null); Assertions.assertEquals("Basic dGVzdDoxMjPCow==", authResponse); } @Test void testBasicAuthenticationWithCharset() throws Exception { final AuthChallenge authChallenge = parse("Basic realm=\"test\", charset=\"utf-8\""); final BasicScheme authscheme = new BasicScheme(); authscheme.processChallenge(authChallenge, null); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "test", null), "test", TEST_UTF8_PASSWORD.toCharArray()) .build(); final HttpRequest request = new BasicHttpRequest("GET", "/"); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); Assertions.assertEquals("Basic dGVzdDoxMjPCow==", authResponse); Assertions.assertEquals("test", authscheme.getRealm()); Assertions.assertTrue(authscheme.isChallengeComplete()); Assertions.assertFalse(authscheme.isConnectionBased()); } @Test void testSerialization() throws Exception { final AuthChallenge authChallenge = parse("Basic realm=\"test\""); final BasicScheme basicScheme = new BasicScheme(); basicScheme.processChallenge(authChallenge, null); final BasicScheme.State state = basicScheme.store(); final BasicScheme cached = new BasicScheme(); cached.restore(state); Assertions.assertEquals(basicScheme.getName(), cached.getName()); Assertions.assertEquals(basicScheme.getRealm(), cached.getRealm()); Assertions.assertEquals(basicScheme.isChallengeComplete(), cached.isChallengeComplete()); } @Test void testBasicAuthenticationUserCredentialsMissing() { final BasicScheme authscheme = new BasicScheme(); final HttpHost host = new HttpHost("somehost", 80); final HttpRequest request = new BasicHttpRequest("GET", "/"); Assertions.assertThrows(AuthenticationException.class, () -> authscheme.generateAuthResponse(host, request, null)); } @Test void testBasicAuthenticationUsernameWithBlank() throws Exception { final BasicScheme authscheme = new BasicScheme(); final HttpHost host = new HttpHost("somehost", 80); final HttpRequest request = new BasicHttpRequest("GET", "/"); authscheme.initPreemptive(new UsernamePasswordCredentials("blah blah", null)); authscheme.generateAuthResponse(host, request, null); } @Test void testBasicAuthenticationUsernameWithTab() { final BasicScheme authscheme = new BasicScheme(); final HttpHost host = new HttpHost("somehost", 80); final HttpRequest request = new BasicHttpRequest("GET", "/"); authscheme.initPreemptive(new UsernamePasswordCredentials("blah\tblah", null)); Assertions.assertThrows(AuthenticationException.class, () -> authscheme.generateAuthResponse(host, request, null)); } @Test void testBasicAuthenticationUsernameWithColon() { final BasicScheme authscheme = new BasicScheme(); final HttpHost host = new HttpHost("somehost", 80); final HttpRequest request = new BasicHttpRequest("GET", "/"); authscheme.initPreemptive(new UsernamePasswordCredentials("blah:blah", null)); Assertions.assertThrows(AuthenticationException.class, () -> authscheme.generateAuthResponse(host, request, null)); } @Test void testBasicAuthenticationPasswordWithControlCharacters() { final BasicScheme authscheme = new BasicScheme(); final HttpHost host = new HttpHost("somehost", 80); final HttpRequest request = new BasicHttpRequest("GET", "/"); // Creating a password with a control character (ASCII code 0-31 or 127) final char[] password = new char[]{'p', 'a', 's', 's', 0x1F, 'w', 'o', 'r', 'd'}; authscheme.initPreemptive(new UsernamePasswordCredentials("username", password)); // Expecting an AuthenticationException due to control character in password Assertions.assertThrows(AuthenticationException.class, () -> authscheme.generateAuthResponse(host, request, null)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/TestBasicAuthCache.java0100664 0000000 0000000 00000005074 14704162040 027665 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.core5.http.HttpHost; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Unit tests for {@link BasicAuthCache}. */ @SuppressWarnings("boxing") // test code class TestBasicAuthCache { @Test void testBasicStoreRestore() { final BasicAuthCache cache = new BasicAuthCache(); final AuthScheme authScheme = new BasicScheme(); cache.put(new HttpHost("localhost", 80), authScheme); Assertions.assertNotNull(cache.get(new HttpHost("localhost", 80))); cache.remove(new HttpHost("localhost", 80)); Assertions.assertNull(cache.get(new HttpHost("localhost", 80))); cache.put(new HttpHost("localhost", 80), authScheme); cache.clear(); Assertions.assertNull(cache.get(new HttpHost("localhost", 80))); } @Test void testNullKey() { final BasicAuthCache cache = new BasicAuthCache(); final AuthScheme authScheme = new BasicScheme(); Assertions.assertThrows(NullPointerException.class, () -> cache.put(null, authScheme)); } @Test void testNullAuthScheme() { final BasicAuthCache cache = new BasicAuthCache(); cache.put(new HttpHost("localhost", 80), null); Assertions.assertNull(cache.get(new HttpHost("localhost", 80))); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/TestBearerScheme.java0100664 0000000 0000000 00000007732 15005672016 027432 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.BearerToken; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Bearer authentication test cases. */ class TestBearerScheme { @Test void testBearerAuthenticationEmptyChallenge() throws Exception { final AuthChallenge authChallenge = new AuthChallenge(ChallengeType.TARGET, "BEARER"); final AuthScheme authscheme = new BearerScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertNull(authscheme.getRealm()); } @Test void testBearerAuthentication() throws Exception { final AuthChallenge authChallenge = new AuthChallenge(ChallengeType.TARGET, "Bearer", new BasicNameValuePair("realm", "test")); final AuthScheme authscheme = new BearerScheme(); authscheme.processChallenge(authChallenge, null); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "test", null), new BearerToken("some token")) .build(); final HttpRequest request = new BasicHttpRequest("GET", "/"); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); authscheme.generateAuthResponse(host, request, null); Assertions.assertEquals("test", authscheme.getRealm()); Assertions.assertTrue(authscheme.isChallengeComplete()); Assertions.assertFalse(authscheme.isConnectionBased()); } @Test void testStateStorage() throws Exception { final AuthChallenge authChallenge = new AuthChallenge(ChallengeType.TARGET, "Bearer", new BasicNameValuePair("realm", "test"), new BasicNameValuePair("code", "read")); final BearerScheme authscheme = new BearerScheme(); authscheme.processChallenge(authChallenge, null); final BearerScheme.State state = authscheme.store(); final BearerScheme cached = new BearerScheme(); cached.restore(state); Assertions.assertEquals(cached.getName(), cached.getName()); Assertions.assertEquals(cached.getRealm(), cached.getRealm()); Assertions.assertEquals(cached.isChallengeComplete(), cached.isChallengeComplete()); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/TestNTLMEngineImpl.java0100664 0000000 0000000 00000036141 15005672016 027623 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.ByteArrayInputStream; import java.nio.charset.StandardCharsets; import java.security.cert.Certificate; import java.security.cert.CertificateFactory; import java.util.Random; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; @SuppressWarnings("deprecation") class TestNTLMEngineImpl { @Test void testMD4() throws Exception { checkMD4("", "31d6cfe0d16ae931b73c59d7e0c089c0"); checkMD4("a", "bde52cb31de33e46245e05fbdbd6fb24"); checkMD4("abc", "a448017aaf21d8525fc10ae87aa6729d"); checkMD4("message digest", "d9130a8164549fe818874806e1c7014b"); checkMD4("abcdefghijklmnopqrstuvwxyz", "d79e1c308aa5bbcdeea8ed63df412da9"); checkMD4("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789", "043f8582f241db351ce627e153e7f0e4"); checkMD4( "12345678901234567890123456789012345678901234567890123456789012345678901234567890", "e33b4ddc9c38f2199c3e7b164fcc0536"); } /* Test suite helper */ static byte toNibble(final char c) { if (c >= 'a' && c <= 'f') { return (byte) (c - 'a' + 0x0a); } if (c >= 'A' && c <= 'F') { return (byte) (c - 'A' + 0x0a); } return (byte) (c - '0'); } /* Test suite helper */ static byte[] toBytes(final String hex) { final byte[] rval = new byte[hex.length() / 2]; int i = 0; while (i < rval.length) { rval[i] = (byte) ((toNibble(hex.charAt(i * 2)) << 4) | (toNibble(hex .charAt(i * 2 + 1)))); i++; } return rval; } /* Test suite MD4 helper */ static void checkMD4(final String input, final String hexOutput) throws Exception { final NTLMEngineImpl.MD4 md4; md4 = new NTLMEngineImpl.MD4(); md4.update(input.getBytes(StandardCharsets.US_ASCII)); final byte[] answer = md4.getOutput(); final byte[] correctAnswer = toBytes(hexOutput); if (answer.length != correctAnswer.length) { throw new Exception("Answer length disagrees for MD4('" + input + "')"); } int i = 0; while (i < answer.length) { if (answer[i] != correctAnswer[i]) { throw new Exception("Answer value for MD4('" + input + "') disagrees at position " + i); } i++; } } @Test void testLMResponse() throws Exception { final NTLMEngineImpl.CipherGen gen = new NTLMEngineImpl.CipherGen( new Random(1234), 1234L, null, null, "SecREt01".toCharArray(), toBytes("0123456789abcdef"), null, null, null, null, null, null); checkArraysMatch(toBytes("c337cd5cbd44fc9782a667af6d427c6de67c20c2d3e77c56"), gen.getLMResponse()); } @Test void testNTLMResponse() throws Exception { final NTLMEngineImpl.CipherGen gen = new NTLMEngineImpl.CipherGen( new Random(1234), 1234L, null, null, "SecREt01".toCharArray(), toBytes("0123456789abcdef"), null, null, null, null, null, null); checkArraysMatch(toBytes("25a98c1c31e81847466b29b2df4680f39958fb8c213a9cc6"), gen.getNTLMResponse()); } @Test void testLMv2Response() throws Exception { final NTLMEngineImpl.CipherGen gen = new NTLMEngineImpl.CipherGen( new Random(1234), 1234L, "DOMAIN", "user", "SecREt01".toCharArray(), toBytes("0123456789abcdef"), "DOMAIN", null, toBytes("ffffff0011223344"), toBytes("ffffff0011223344"), null, null); checkArraysMatch(toBytes("d6e6152ea25d03b7c6ba6629c2d6aaf0ffffff0011223344"), gen.getLMv2Response()); } @Test void testNTLMv2Response() throws Exception { final NTLMEngineImpl.CipherGen gen = new NTLMEngineImpl.CipherGen( new Random(1234), 1234L, "DOMAIN", "user", "SecREt01".toCharArray(), toBytes("0123456789abcdef"), "DOMAIN", toBytes("02000c0044004f004d00410049004e0001000c005300450052005600450052000400140064006f006d00610069006e002e0063006f006d00030022007300650072007600650072002e0064006f006d00610069006e002e0063006f006d0000000000"), toBytes("ffffff0011223344"), toBytes("ffffff0011223344"), null, toBytes("0090d336b734c301")); checkArraysMatch(toBytes("01010000000000000090d336b734c301ffffff00112233440000000002000c0044004f004d00410049004e0001000c005300450052005600450052000400140064006f006d00610069006e002e0063006f006d00030022007300650072007600650072002e0064006f006d00610069006e002e0063006f006d000000000000000000"), gen.getNTLMv2Blob()); checkArraysMatch(toBytes("cbabbca713eb795d04c97abc01ee498301010000000000000090d336b734c301ffffff00112233440000000002000c0044004f004d00410049004e0001000c005300450052005600450052000400140064006f006d00610069006e002e0063006f006d00030022007300650072007600650072002e0064006f006d00610069006e002e0063006f006d000000000000000000"), gen.getNTLMv2Response()); } @Test void testLM2SessionResponse() { final NTLMEngineImpl.CipherGen gen = new NTLMEngineImpl.CipherGen( new Random(1234), 1234L, "DOMAIN", "user", "SecREt01".toCharArray(), toBytes("0123456789abcdef"), "DOMAIN", toBytes("02000c0044004f004d00410049004e0001000c005300450052005600450052000400140064006f006d00610069006e002e0063006f006d00030022007300650072007600650072002e0064006f006d00610069006e002e0063006f006d0000000000"), toBytes("ffffff0011223344"), toBytes("ffffff0011223344"), null, toBytes("0090d336b734c301")); checkArraysMatch(toBytes("ffffff001122334400000000000000000000000000000000"), gen.getLM2SessionResponse()); } @Test void testNTLM2SessionResponse() throws Exception { final NTLMEngineImpl.CipherGen gen = new NTLMEngineImpl.CipherGen( new Random(1234), 1234L, "DOMAIN", "user", "SecREt01".toCharArray(), toBytes("0123456789abcdef"), "DOMAIN", toBytes("02000c0044004f004d00410049004e0001000c005300450052005600450052000400140064006f006d00610069006e002e0063006f006d00030022007300650072007600650072002e0064006f006d00610069006e002e0063006f006d0000000000"), toBytes("ffffff0011223344"), toBytes("ffffff0011223344"), null, toBytes("0090d336b734c301")); checkArraysMatch(toBytes("10d550832d12b2ccb79d5ad1f4eed3df82aca4c3681dd455"), gen.getNTLM2SessionResponse()); } @Test void testNTLMUserSessionKey() throws Exception { final NTLMEngineImpl.CipherGen gen = new NTLMEngineImpl.CipherGen( new Random(1234), 1234L, "DOMAIN", "user", "SecREt01".toCharArray(), toBytes("0123456789abcdef"), "DOMAIN", toBytes("02000c0044004f004d00410049004e0001000c005300450052005600450052000400140064006f006d00610069006e002e0063006f006d00030022007300650072007600650072002e0064006f006d00610069006e002e0063006f006d0000000000"), toBytes("ffffff0011223344"), toBytes("ffffff0011223344"), null, toBytes("0090d336b734c301")); checkArraysMatch(toBytes("3f373ea8e4af954f14faa506f8eebdc4"), gen.getNTLMUserSessionKey()); } @Test void testType1Message() { final byte[] bytes = new NTLMEngineImpl.Type1Message("myhost", "mydomain").getBytes(); final byte[] bytes2 = toBytes("4E544C4D5353500001000000018208A20C000C003800000010001000280000000501280A0000000F6D00790064006F006D00610069006E004D00590048004F0053005400"); checkArraysMatch(bytes2, bytes); } @Test void testType3Message() throws Exception { final byte[] bytes = new NTLMEngineImpl.Type3Message( new Random(1234), 1234L, "me", "mypassword", "myhost", "mydomain".toCharArray(), toBytes("0001020304050607"), 0xffffffff, null, null).getBytes(); checkArraysMatch(toBytes("4E544C4D53535000030000001800180048000000180018006000000004000400780000000C000C007C0000001400140088000000100010009C000000FFFFFFFF0501280A0000000FA86886A5D297814200000000000000000000000000000000EEC7568E00798491244959B9C942F4F367C5CBABEEF546F74D0045006D00790068006F00730074006D007900700061007300730077006F007200640094DDAB1EBB82C9A1AB914CAE6F199644"), bytes); final byte[] bytes2 = new NTLMEngineImpl.Type3Message( new Random(1234), 1234L, "me", "mypassword", "myhost", "mydomain".toCharArray(), toBytes("0001020304050607"), 0xffffffff, "mytarget", toBytes("02000c0044004f004d00410049004e0001000c005300450052005600450052000400140064006f006d00610069006e002e0063006f006d00030022007300650072007600650072002e0064006f006d00610069006e002e0063006f006d0000000000")).getBytes(); checkArraysMatch(toBytes("4E544C4D53535000030000001800180048000000920092006000000004000400F20000000C000C00F600000014001400020100001000100016010000FFFFFFFF0501280A0000000F3695F1EA7B164788A437892FA7504320DA2D8CF378EBC83CE856A8FB985BF7783545828A91A13AE8010100000000000020CBFAD5DEB19D01A86886A5D29781420000000002000C0044004F004D00410049004E0001000C005300450052005600450052000400140064006F006D00610069006E002E0063006F006D00030022007300650072007600650072002E0064006F006D00610069006E002E0063006F006D0000000000000000004D0045006D00790068006F00730074006D007900700061007300730077006F0072006400BB1AAD36F11631CC7CBC8800CEEE1C99"), bytes2); } private static final String cannedCert = "-----BEGIN CERTIFICATE-----\n" + "MIIDIDCCAgigAwIBAgIEOqKaWTANBgkqhkiG9w0BAQsFADBSMQswCQYDVQQGEwJVUzEQMA4GA1UEBxMH\n" + "TXkgQ2l0eTEYMBYGA1UEChMPTXkgT3JnYW5pemF0aW9uMRcwFQYDVQQDEw5NeSBBcHBsaWNhdGlvbjAe\n" + "Fw0xNzAzMTcxNDAyMzRaFw0yNzAzMTUxNDAyMzRaMFIxCzAJBgNVBAYTAlVTMRAwDgYDVQQHEwdNeSBD\n" + "aXR5MRgwFgYDVQQKEw9NeSBPcmdhbml6YXRpb24xFzAVBgNVBAMTDk15IEFwcGxpY2F0aW9uMIIBIjAN\n" + "BgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArc+mbViBaHeRSt82KrJ5IF+62b/Qob95Lca4DJIislTY\n" + "vLPIo0R1faBV8BkEeUQwo01srkf3RaGLCHNZnFal4KEzbtiUy6W+n08G5E9w9YG+WSwW2dmjvEI7k2a2\n" + "xqlaM4NdMKL4ONPXcxfZsMDqxDgpdkaNPKpZ10NDq6rmBTkQw/OSG0z1KLtwLkF1ZQ/3mXdjVzvP83V2\n" + "g17AqBazb0Z1YHsVKmkGjPqnq3niJH/6Oke4N+5k/1cE5lSJcQNGP0nqeGdJfvqQZ+gk6gH/sOngZL9X\n" + "hPVkpseAwHa+xuPneDSjibLgLmMt3XGDK6jGfjdp5FWqFvAD5E3LHbW9gwIDAQABMA0GCSqGSIb3DQEB\n" + "CwUAA4IBAQCpUXUHhl5LyMSO5Q0OktEc9AaFjZtVfknpPde6Zeh35Pqd2354ErvJSBWgzFAphda0oh2s\n" + "OIAFkM6LJQEnVDTbXDXN+YY8e3gb9ryfh85hkhC0XI9qp17WPSkmw8XgDfvRd6YQgKm1AnLxjOCwG2jg\n" + "i09iZBIWkW3ZeRAMvWPHHjvq44iZB5ZrEl0apgumS6MxpUzKOr5Pcq0jxJDw2UCj5YloFMNl+UINv2vV\n" + "aL/DR6ivc61dOfN1E/VNBGkkCk/AogNyucGiFMCq9hd25Y9EbkBBqObYTH1XMX+ufsJh+6hG7KDQ1e/F\n" + "nRrlhKwM2uRe+aSH0D6/erjDBT7tXvwn\n" + "-----END CERTIFICATE-----"; @Test void testType3MessageWithCert() throws Exception { final ByteArrayInputStream fis = new ByteArrayInputStream(cannedCert.getBytes(StandardCharsets.US_ASCII)); final CertificateFactory cf = CertificateFactory.getInstance("X.509"); final Certificate cert = cf.generateCertificate(fis); final byte[] bytes = new NTLMEngineImpl.Type3Message( new Random(1234), 1234L, "me", "mypassword", "myhost", "mydomain".toCharArray(), toBytes("0001020304050607"), 0xffffffff, "mytarget", toBytes("02000c0044004f004d00410049004e0001000c005300450052005600450052000400140064006f006d00610069006e002e0063006f006d00030022007300650072007600650072002e0064006f006d00610069006e002e0063006f006d0000000000"), cert, toBytes("4E544C4D5353500001000000018208A20C000C003800000010001000280000000501280A0000000F6D00790064006F006D00610069006E004D00590048004F0053005400"), toBytes("4E544C4D5353500001000000018208A20C000C003800000010001000280000000501280A0000000F6D00790064006F006D00610069006E004D00590048004F0053005400FFFEFDFCFBFA")).getBytes(); checkArraysMatch(toBytes("4E544C4D53535000030000001800180058000000AE00AE0070000000040004001E0100000C000C0022010000140014002E0100001000100042010000FFFFFFFF0501280A0000000FEEFCCE4187D6CDF1F91C686C4E571D943695F1EA7B164788A437892FA7504320DA2D8CF378EBC83C59D7A3B2951929079B66621D7CF4326B010100000000000020CBFAD5DEB19D01A86886A5D29781420000000002000C0044004F004D00410049004E0001000C005300450052005600450052000400140064006F006D00610069006E002E0063006F006D00030022007300650072007600650072002E0064006F006D00610069006E002E0063006F006D0006000400020000000A00100038EDC0B7EF8D8FE9E1E6A83F6DFEB8FF00000000000000004D0045006D00790068006F00730074006D007900700061007300730077006F0072006400BB1AAD36F11631CC7CBC8800CEEE1C99"), bytes); } @Test void testRC4() throws Exception { checkArraysMatch(toBytes("e37f97f2544f4d7e"), NTLMEngineImpl.RC4(toBytes("0a003602317a759a"), toBytes("2785f595293f3e2813439d73a223810d"))); } /* Byte array check helper */ static void checkArraysMatch(final byte[] a1, final byte[] a2) { Assertions.assertEquals(a1.length, a2.length); for (int i = 0; i < a1.length; i++) { Assertions.assertEquals(a1[i], a2[i]); } } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/TestAuthChallengeParser.java0100664 0000000 0000000 00000041202 14704162040 030750 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import static org.hamcrest.MatcherAssert.assertThat; import java.util.List; import org.apache.hc.client5.http.NameValuePairMatcher; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.core5.http.NameValuePair; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.util.CharArrayBuffer; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestAuthChallengeParser { private AuthChallengeParser parser; @BeforeEach void setUp() { this.parser = new AuthChallengeParser(); } @Test void testParseTokenTerminatedByBlank() { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("aaabbbbccc "); final ParserCursor cursor = new ParserCursor(0, buffer.length()); assertThat(parser.parseToken(buffer, cursor), CoreMatchers.equalTo("aaabbbbccc")); } @Test void testParseTokenTerminatedByComma() { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("aaabbbbccc, "); final ParserCursor cursor = new ParserCursor(0, buffer.length()); assertThat(parser.parseToken(buffer, cursor), CoreMatchers.equalTo("aaabbbbccc")); } @Test void testParseTokenTerminatedByEndOfStream() { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("aaabbbbccc"); final ParserCursor cursor = new ParserCursor(0, buffer.length()); assertThat(parser.parseToken(buffer, cursor), CoreMatchers.equalTo("aaabbbbccc")); } @Test void testParsePaddedToken68() { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("aaabbbbccc==== "); final ParserCursor cursor = new ParserCursor(0, buffer.length()); assertThat(parser.parseToken(buffer, cursor), CoreMatchers.equalTo("aaabbbbccc====")); assertThat(cursor.atEnd(), CoreMatchers.equalTo(false)); assertThat(buffer.charAt(cursor.getPos()), CoreMatchers.equalTo(' ')); } @Test void testParsePaddedToken68SingleEqual() { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("aaabbbbccc="); final ParserCursor cursor = new ParserCursor(0, buffer.length()); assertThat(parser.parseToken(buffer, cursor), CoreMatchers.equalTo("aaabbbbccc=")); assertThat(cursor.atEnd(), CoreMatchers.equalTo(true)); } @Test void testParsePaddedToken68MultipleEquals() { final CharArrayBuffer buffer = new CharArrayBuffer(16); buffer.append("aaabbbbccc======"); final ParserCursor cursor = new ParserCursor(0, buffer.length()); assertThat(parser.parseToken(buffer, cursor), CoreMatchers.equalTo("aaabbbbccc======")); assertThat(cursor.atEnd(), CoreMatchers.equalTo(true)); } @Test void testParsePaddedToken68TerminatedByComma() { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("aaabbbbccc====,"); final ParserCursor cursor = new ParserCursor(0, buffer.length()); assertThat(parser.parseToken(buffer, cursor), CoreMatchers.equalTo("aaabbbbccc====")); assertThat(cursor.atEnd(), CoreMatchers.equalTo(false)); assertThat(buffer.charAt(cursor.getPos()), CoreMatchers.equalTo(',')); } @Test void testParseTokenTerminatedByParameter() { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("aaabbbbccc=blah"); final ParserCursor cursor = new ParserCursor(0, buffer.length()); assertThat(parser.parseToken(buffer, cursor), CoreMatchers.equalTo("aaabbbbccc")); assertThat(cursor.atEnd(), CoreMatchers.equalTo(false)); assertThat(buffer.charAt(cursor.getPos()), CoreMatchers.equalTo('=')); } @Test void testParseBasicAuthChallenge() throws Exception { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append(StandardAuthScheme.BASIC + " realm=blah"); final ParserCursor cursor = new ParserCursor(0, buffer.length()); final List challenges = parser.parse(ChallengeType.TARGET, buffer, cursor); Assertions.assertNotNull(challenges); Assertions.assertEquals(1, challenges.size()); final AuthChallenge challenge1 = challenges.get(0); Assertions.assertEquals(StandardAuthScheme.BASIC, challenge1.getSchemeName()); Assertions.assertNull(challenge1.getValue()); final List params = challenge1.getParams(); Assertions.assertNotNull(params); Assertions.assertEquals(1, params.size()); assertThat(params.get(0), NameValuePairMatcher.equals("realm", "blah")); } @Test void testParseAuthChallengeWithBlanks() throws Exception { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append(" " + StandardAuthScheme.BASIC + " realm = blah "); final ParserCursor cursor = new ParserCursor(0, buffer.length()); final List challenges = parser.parse(ChallengeType.TARGET, buffer, cursor); Assertions.assertNotNull(challenges); Assertions.assertEquals(1, challenges.size()); final AuthChallenge challenge1 = challenges.get(0); Assertions.assertEquals(StandardAuthScheme.BASIC, challenge1.getSchemeName()); Assertions.assertNull(challenge1.getValue()); final List params = challenge1.getParams(); Assertions.assertNotNull(params); Assertions.assertEquals(1, params.size()); assertThat(params.get(0), NameValuePairMatcher.equals("realm", "blah")); } @Test void testParseMultipleAuthChallenge() throws Exception { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("This xxxxxxxxxxxxxxxxxxxxxx, " + "That yyyyyyyyyyyyyyyyyyyyyy "); final ParserCursor cursor = new ParserCursor(0, buffer.length()); final List challenges = parser.parse(ChallengeType.TARGET, buffer, cursor); Assertions.assertNotNull(challenges); Assertions.assertEquals(2, challenges.size()); final AuthChallenge challenge1 = challenges.get(0); Assertions.assertEquals("This", challenge1.getSchemeName()); Assertions.assertEquals("xxxxxxxxxxxxxxxxxxxxxx", challenge1.getValue()); Assertions.assertNull(challenge1.getParams()); final AuthChallenge challenge2 = challenges.get(1); Assertions.assertEquals("That", challenge2.getSchemeName()); Assertions.assertEquals("yyyyyyyyyyyyyyyyyyyyyy", challenge2.getValue()); Assertions.assertNull(challenge2.getParams()); } @Test void testParseMultipleAuthChallengeWithParams() throws Exception { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append(StandardAuthScheme.BASIC + " realm=blah, param1 = this, param2=that, " + StandardAuthScheme.BASIC + " realm=\"\\\"yada\\\"\", this, that=,this-and-that "); final ParserCursor cursor = new ParserCursor(0, buffer.length()); final List challenges = parser.parse(ChallengeType.TARGET, buffer, cursor); Assertions.assertNotNull(challenges); Assertions.assertEquals(2, challenges.size()); final AuthChallenge challenge1 = challenges.get(0); Assertions.assertEquals(StandardAuthScheme.BASIC, challenge1.getSchemeName()); Assertions.assertNull(challenge1.getValue()); final List params1 = challenge1.getParams(); Assertions.assertNotNull(params1); Assertions.assertEquals(3, params1.size()); assertThat(params1.get(0), NameValuePairMatcher.equals("realm", "blah")); assertThat(params1.get(1), NameValuePairMatcher.equals("param1", "this")); assertThat(params1.get(2), NameValuePairMatcher.equals("param2", "that")); final AuthChallenge challenge2 = challenges.get(1); Assertions.assertEquals(StandardAuthScheme.BASIC, challenge2.getSchemeName()); Assertions.assertNull(challenge2.getValue()); final List params2 = challenge2.getParams(); Assertions.assertNotNull(params2); Assertions.assertEquals(4, params2.size()); assertThat(params2.get(0), NameValuePairMatcher.equals("realm", "\"yada\"")); assertThat(params2.get(1), NameValuePairMatcher.equals("this", null)); assertThat(params2.get(2), NameValuePairMatcher.equals("that", "")); assertThat(params2.get(3), NameValuePairMatcher.equals("this-and-that", null)); } @Test void testParseMultipleAuthChallengeWithParamsContainingComma() throws Exception { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append(StandardAuthScheme.BASIC + " realm=blah, param1 = \"this, param2=that\", " + StandardAuthScheme.BASIC + " realm=\"\\\"yada,,,,\\\"\""); final ParserCursor cursor = new ParserCursor(0, buffer.length()); final List challenges = parser.parse(ChallengeType.TARGET, buffer, cursor); Assertions.assertNotNull(challenges); Assertions.assertEquals(2, challenges.size()); final AuthChallenge challenge1 = challenges.get(0); Assertions.assertEquals(StandardAuthScheme.BASIC, challenge1.getSchemeName()); Assertions.assertNull(challenge1.getValue()); final List params1 = challenge1.getParams(); Assertions.assertNotNull(params1); Assertions.assertEquals(2, params1.size()); assertThat(params1.get(0), NameValuePairMatcher.equals("realm", "blah")); assertThat(params1.get(1), NameValuePairMatcher.equals("param1", "this, param2=that")); final AuthChallenge challenge2 = challenges.get(1); Assertions.assertEquals(StandardAuthScheme.BASIC, challenge2.getSchemeName()); Assertions.assertNull(challenge2.getValue()); final List params2 = challenge2.getParams(); Assertions.assertNotNull(params2); Assertions.assertEquals(1, params2.size()); assertThat(params2.get(0), NameValuePairMatcher.equals("realm", "\"yada,,,,\"")); } @Test void testParseEmptyAuthChallenge1() throws Exception { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("This"); final ParserCursor cursor = new ParserCursor(0, buffer.length()); final List challenges = parser.parse(ChallengeType.TARGET, buffer, cursor); Assertions.assertNotNull(challenges); Assertions.assertEquals(1, challenges.size()); final AuthChallenge challenge1 = challenges.get(0); Assertions.assertEquals("This", challenge1.getSchemeName()); Assertions.assertNull(challenge1.getValue()); Assertions.assertNull(challenge1.getParams()); } @Test void testParseMalformedAuthChallenge1() { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("This , "); final ParserCursor cursor = new ParserCursor(0, buffer.length()); Assertions.assertThrows(ParseException.class, () -> parser.parse(ChallengeType.TARGET, buffer, cursor)); } @Test void testParseMalformedAuthChallenge2() { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("This = that"); final ParserCursor cursor = new ParserCursor(0, buffer.length()); Assertions.assertThrows(ParseException.class, () -> parser.parse(ChallengeType.TARGET, buffer, cursor)); } @Test void testParseMalformedAuthChallenge3() { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("blah blah blah"); final ParserCursor cursor = new ParserCursor(0, buffer.length()); Assertions.assertThrows(ParseException.class, () -> parser.parse(ChallengeType.TARGET, buffer, cursor)); } @Test void testParseValidAuthChallenge1() throws Exception { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("blah blah"); final ParserCursor cursor = new ParserCursor(0, buffer.length()); final List challenges = parser.parse(ChallengeType.TARGET, buffer, cursor); Assertions.assertNotNull(challenges); Assertions.assertEquals(1, challenges.size()); final AuthChallenge challenge1 = challenges.get(0); Assertions.assertEquals("blah", challenge1.getSchemeName()); Assertions.assertEquals("blah", challenge1.getValue()); Assertions.assertNull(challenge1.getParams()); } @Test void testParseValidAuthChallenge2() throws Exception { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("blah blah, blah"); final ParserCursor cursor = new ParserCursor(0, buffer.length()); final List challenges = parser.parse(ChallengeType.TARGET, buffer, cursor); Assertions.assertNotNull(challenges); Assertions.assertEquals(1, challenges.size()); final AuthChallenge challenge1 = challenges.get(0); Assertions.assertEquals("blah", challenge1.getSchemeName()); Assertions.assertNull(challenge1.getValue()); final List params1 = challenge1.getParams(); Assertions.assertNotNull(params1); Assertions.assertEquals(2, params1.size()); assertThat(params1.get(0), NameValuePairMatcher.equals("blah", null)); assertThat(params1.get(1), NameValuePairMatcher.equals("blah", null)); } @Test void testParseParameterAndToken68AuthChallengeMix() throws Exception { final CharArrayBuffer buffer = new CharArrayBuffer(64); buffer.append("scheme1 aaaa , scheme2 aaaa==, scheme3 aaaa=aaaa, scheme4 aaaa="); final ParserCursor cursor = new ParserCursor(0, buffer.length()); final List challenges = parser.parse(ChallengeType.TARGET, buffer, cursor); Assertions.assertNotNull(challenges); Assertions.assertEquals(4, challenges.size()); final AuthChallenge challenge1 = challenges.get(0); assertThat(challenge1.getSchemeName(), CoreMatchers.equalTo("scheme1")); assertThat(challenge1.getValue(), CoreMatchers.equalTo("aaaa")); assertThat(challenge1.getParams(), CoreMatchers.nullValue()); final AuthChallenge challenge2 = challenges.get(1); assertThat(challenge2.getSchemeName(), CoreMatchers.equalTo("scheme2")); assertThat(challenge2.getValue(), CoreMatchers.equalTo("aaaa==")); assertThat(challenge2.getParams(), CoreMatchers.nullValue()); final AuthChallenge challenge3 = challenges.get(2); assertThat(challenge3.getSchemeName(), CoreMatchers.equalTo("scheme3")); assertThat(challenge3.getValue(), CoreMatchers.nullValue()); assertThat(challenge3.getParams(), CoreMatchers.notNullValue()); assertThat(challenge3.getParams().size(), CoreMatchers.equalTo(1)); assertThat(challenge3.getParams().get(0), NameValuePairMatcher.equals("aaaa", "aaaa")); final AuthChallenge challenge4 = challenges.get(3); assertThat(challenge4.getSchemeName(), CoreMatchers.equalTo("scheme4")); assertThat(challenge4.getValue(), CoreMatchers.equalTo("aaaa=")); assertThat(challenge4.getParams(), CoreMatchers.nullValue()); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/TestNTLMScheme.java0100664 0000000 0000000 00000004500 14704162040 026766 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Unit tests for {@link NTLMScheme}. */ @SuppressWarnings("deprecation") class TestNTLMScheme { @Test void testNTLMAuthenticationEmptyProxyChallenge() throws Exception { final AuthChallenge authChallenge = new AuthChallenge(ChallengeType.PROXY, StandardAuthScheme.NTLM); final AuthScheme authScheme = new NTLMScheme(); authScheme.processChallenge(authChallenge, null); Assertions.assertFalse(authScheme.isChallengeComplete(), "Challenge with an empty value received from NTML proxy must not interrupt authentication process."); Assertions.assertTrue(authScheme.toString().contains(NTLMScheme.State.CHALLENGE_RECEIVED.toString()), "Challenge with an empty value received from NTML proxy must transit status of NTLMScheme to CHALLENGE_RECEIVED."); } }httpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/TestDigestScheme.java0100664 0000000 0000000 00000166505 15063503637 027463 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.nio.charset.StandardCharsets; import java.security.MessageDigest; import java.util.HashMap; import java.util.List; import java.util.Map; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.AuthenticationException; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.MalformedChallengeException; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ContentType; import org.apache.hc.core5.http.HeaderElement; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.ParseException; import org.apache.hc.core5.http.io.entity.InputStreamEntity; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.message.BasicHeaderValueParser; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.message.ParserCursor; import org.apache.hc.core5.util.CharArrayBuffer; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Test Methods for DigestScheme Authentication. */ class TestDigestScheme { private static AuthChallenge parse(final String s) throws ParseException { final CharArrayBuffer buffer = new CharArrayBuffer(s.length()); buffer.append(s); final ParserCursor cursor = new ParserCursor(0, buffer.length()); final List authChallenges = AuthChallengeParser.INSTANCE.parse(ChallengeType.TARGET, buffer, cursor); Assertions.assertEquals(1, authChallenges.size()); return authChallenges.get(0); } @Test void testDigestAuthenticationEmptyChallenge1() throws Exception { final AuthChallenge authChallenge = parse(StandardAuthScheme.DIGEST); final AuthScheme authscheme = new DigestScheme(); Assertions.assertThrows(MalformedChallengeException.class, () -> authscheme.processChallenge(authChallenge, null)); } @Test void testDigestAuthenticationEmptyChallenge2() throws Exception { final AuthChallenge authChallenge = parse(StandardAuthScheme.DIGEST + " "); final AuthScheme authscheme = new DigestScheme(); Assertions.assertThrows(MalformedChallengeException.class, () -> authscheme.processChallenge(authChallenge, null)); } @Test void testDigestAuthenticationWithDefaultCreds() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); Assertions.assertTrue(authscheme.isChallengeComplete()); Assertions.assertFalse(authscheme.isConnectionBased()); final Map table = parseAuthResponse(authResponse); Assertions.assertEquals("username", table.get("username")); Assertions.assertEquals("realm1", table.get("realm")); Assertions.assertEquals("/", table.get("uri")); Assertions.assertEquals("f2a3f18799759d4f1a1c068b92b573cb", table.get("nonce")); Assertions.assertEquals("e95a7ddf37c2eab009568b1ed134f89a", table.get("response")); } @Test void testDigestAuthentication() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); final Map table = parseAuthResponse(authResponse); Assertions.assertEquals("username", table.get("username")); Assertions.assertEquals("realm1", table.get("realm")); Assertions.assertEquals("/", table.get("uri")); Assertions.assertEquals("f2a3f18799759d4f1a1c068b92b573cb", table.get("nonce")); Assertions.assertEquals("e95a7ddf37c2eab009568b1ed134f89a", table.get("response")); } @Test void testDigestAuthenticationInvalidInput() throws Exception { final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertThrows(NullPointerException.class, () -> authscheme.isResponseReady(null, credentialsProvider, null)); Assertions.assertThrows(NullPointerException.class, () -> authscheme.isResponseReady(host, null, null)); Assertions.assertThrows(NullPointerException.class, () -> authscheme.generateAuthResponse(host, null, null)); } @Test void testDigestAuthenticationWithSHA() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", " + "nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", " + "algorithm=SHA"; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); Assertions.assertThrows(AuthenticationException.class, () -> authscheme.generateAuthResponse(host, request, null), "Expected UnsupportedDigestAlgorithmException for unsupported 'SHA' algorithm"); } @Test void testDigestAuthenticationWithQueryStringInDigestURI() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/?param=value"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); final Map table = parseAuthResponse(authResponse); Assertions.assertEquals("username", table.get("username")); Assertions.assertEquals("realm1", table.get("realm")); Assertions.assertEquals("/?param=value", table.get("uri")); Assertions.assertEquals("f2a3f18799759d4f1a1c068b92b573cb", table.get("nonce")); Assertions.assertEquals("a847f58f5fef0bc087bcb9c3eb30e042", table.get("response")); } @Test void testDigestAuthenticationNoRealm() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " no-realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); Assertions.assertThrows(AuthenticationException.class, () -> authscheme.generateAuthResponse(host, request, null)); } @Test void testDigestAuthenticationNoNonce() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", no-nonce=\"f2a3f18799759d4f1a1c068b92b573cb\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); Assertions.assertThrows(AuthenticationException.class, () -> authscheme.generateAuthResponse(host, request, null)); } @Test void testDigestAuthenticationNoAlgorithm() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); final Map table = parseAuthResponse(authResponse); Assertions.assertNull(table.get("algorithm")); } @Test void testDigestAuthenticationMD5Algorithm() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\"" + ", algorithm=MD5"; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); final Map table = parseAuthResponse(authResponse); Assertions.assertEquals("MD5", table.get("algorithm")); } /** * Test digest authentication using the MD5-sess algorithm. */ @Test void testDigestAuthenticationMD5Sess() throws Exception { // Example using Digest auth with MD5-sess final String realm = "realm"; final String username = "username"; final String password = "password"; final String nonce = "e273f1776275974f1a120d8b92c5b3cb"; final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, realm, null), username, password.toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"" + realm + "\", " + "nonce=\"" + nonce + "\", " + "opaque=\"SomeString\", " + "stale=false, " + "algorithm=MD5-sess, " + "qop=\"auth,auth-int\""; // we pass both but expect auth to be used final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); Assertions.assertTrue(authResponse.indexOf("nc=00000001") > 0); // test for quotes Assertions.assertTrue(authResponse.indexOf("qop=auth") > 0); // test for quotes final Map table = parseAuthResponse(authResponse); Assertions.assertEquals(username, table.get("username")); Assertions.assertEquals(realm, table.get("realm")); Assertions.assertEquals("MD5-sess", table.get("algorithm")); Assertions.assertEquals("/", table.get("uri")); Assertions.assertEquals(nonce, table.get("nonce")); Assertions.assertEquals(1, Integer.parseInt(table.get("nc"), 16)); Assertions.assertNotNull(table.get("cnonce")); Assertions.assertEquals("SomeString", table.get("opaque")); Assertions.assertEquals("auth", table.get("qop")); //@TODO: add better check Assertions.assertNotNull(table.get("response")); } /** * Test digest authentication using the MD5-sess algorithm. */ @Test void testDigestAuthenticationMD5SessNoQop() throws Exception { // Example using Digest auth with MD5-sess final String realm = "realm"; final String username = "username"; final String password = "password"; final String nonce = "e273f1776275974f1a120d8b92c5b3cb"; final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, realm, null), username, password.toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"" + realm + "\", " + "nonce=\"" + nonce + "\", " + "opaque=\"SomeString\", " + "stale=false, " + "algorithm=MD5-sess"; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); final Map table = parseAuthResponse(authResponse); Assertions.assertEquals(username, table.get("username")); Assertions.assertEquals(realm, table.get("realm")); Assertions.assertEquals("MD5-sess", table.get("algorithm")); Assertions.assertEquals("/", table.get("uri")); Assertions.assertEquals(nonce, table.get("nonce")); Assertions.assertNull(table.get("nc")); Assertions.assertEquals("SomeString", table.get("opaque")); Assertions.assertNull(table.get("qop")); //@TODO: add better check Assertions.assertNotNull(table.get("response")); } /** * Test digest authentication with unknown qop value */ @Test void testDigestAuthenticationMD5SessUnknownQop() throws Exception { // Example using Digest auth with MD5-sess final String realm = "realm"; final String username = "username"; final String password = "password"; final String nonce = "e273f1776275974f1a120d8b92c5b3cb"; final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, realm, null), username, password.toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"" + realm + "\", " + "nonce=\"" + nonce + "\", " + "opaque=\"SomeString\", " + "stale=false, " + "algorithm=MD5-sess, " + "qop=\"stuff\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); Assertions.assertThrows(AuthenticationException.class, () -> authscheme.generateAuthResponse(host, request, null)); } /** * Test digest authentication with unknown qop value */ @Test void testDigestAuthenticationUnknownAlgo() throws Exception { // Example using Digest auth with MD5-sess final String realm = "realm"; final String username = "username"; final String password = "password"; final String nonce = "e273f1776275974f1a120d8b92c5b3cb"; final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, realm, null), username, password.toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"" + realm + "\", " + "nonce=\"" + nonce + "\", " + "opaque=\"SomeString\", " + "stale=false, " + "algorithm=stuff, " + "qop=\"auth\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); Assertions.assertThrows(AuthenticationException.class, () -> authscheme.generateAuthResponse(host, request, null)); } @Test void testDigestAuthenticationWithStaleNonce() throws Exception { final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", " + "nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", stale=\"true\""; final AuthChallenge authChallenge = parse(challenge); final AuthScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertFalse(authscheme.isChallengeComplete()); } private static Map parseAuthResponse(final String authResponse) { if (!authResponse.startsWith(StandardAuthScheme.DIGEST + " ")) { return null; } final String s = authResponse.substring(7); final ParserCursor cursor = new ParserCursor(0, s.length()); final HeaderElement[] elements = BasicHeaderValueParser.INSTANCE.parseElements(s, cursor); final Map map = new HashMap<>(elements.length); for (final HeaderElement element : elements) { map.put(element.getName(), element.getValue()); } return map; } @Test void testDigestNouceCount() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge1 = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", qop=auth"; final AuthChallenge authChallenge1 = parse(challenge1); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge1, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse1 = authscheme.generateAuthResponse(host, request, null); final Map table1 = parseAuthResponse(authResponse1); Assertions.assertEquals("00000001", table1.get("nc")); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse2 = authscheme.generateAuthResponse(host, request, null); final Map table2 = parseAuthResponse(authResponse2); Assertions.assertEquals("00000002", table2.get("nc")); final String challenge2 = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", qop=auth"; final AuthChallenge authChallenge2 = parse(challenge2); authscheme.processChallenge(authChallenge2, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse3 = authscheme.generateAuthResponse(host, request, null); final Map table3 = parseAuthResponse(authResponse3); Assertions.assertEquals("00000003", table3.get("nc")); final String challenge3 = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"e273f1776275974f1a120d8b92c5b3cb\", qop=auth"; final AuthChallenge authChallenge3 = parse(challenge3); authscheme.processChallenge(authChallenge3, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse4 = authscheme.generateAuthResponse(host, request, null); final Map table4 = parseAuthResponse(authResponse4); Assertions.assertEquals("00000001", table4.get("nc")); } @Test void testDigestMD5SessA1AndCnonceConsistency() throws Exception { final HttpHost host = new HttpHost("somehost", 80); final HttpRequest request = new BasicHttpRequest("GET", "/"); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "subnet.domain.com", null), "username", "password".toCharArray()) .build(); final String challenge1 = StandardAuthScheme.DIGEST + " qop=\"auth\", algorithm=MD5-sess, nonce=\"1234567890abcdef\", " + "charset=utf-8, realm=\"subnet.domain.com\""; final AuthChallenge authChallenge1 = parse(challenge1); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge1, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse1 = authscheme.generateAuthResponse(host, request, null); final Map table1 = parseAuthResponse(authResponse1); Assertions.assertEquals("00000001", table1.get("nc")); final String cnonce1 = authscheme.getCnonce(); final String sessionKey1 = authscheme.getA1(); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse2 = authscheme.generateAuthResponse(host, request, null); final Map table2 = parseAuthResponse(authResponse2); Assertions.assertEquals("00000002", table2.get("nc")); final String cnonce2 = authscheme.getCnonce(); final String sessionKey2 = authscheme.getA1(); Assertions.assertEquals(cnonce1, cnonce2); Assertions.assertEquals(sessionKey1, sessionKey2); final String challenge2 = StandardAuthScheme.DIGEST + " qop=\"auth\", algorithm=MD5-sess, nonce=\"1234567890abcdef\", " + "charset=utf-8, realm=\"subnet.domain.com\""; final AuthChallenge authChallenge2 = parse(challenge2); authscheme.processChallenge(authChallenge2, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse3 = authscheme.generateAuthResponse(host, request, null); final Map table3 = parseAuthResponse(authResponse3); Assertions.assertEquals("00000003", table3.get("nc")); final String cnonce3 = authscheme.getCnonce(); final String sessionKey3 = authscheme.getA1(); Assertions.assertEquals(cnonce1, cnonce3); Assertions.assertEquals(sessionKey1, sessionKey3); final String challenge3 = StandardAuthScheme.DIGEST + " qop=\"auth\", algorithm=MD5-sess, nonce=\"fedcba0987654321\", " + "charset=utf-8, realm=\"subnet.domain.com\""; final AuthChallenge authChallenge3 = parse(challenge3); authscheme.processChallenge(authChallenge3, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse4 = authscheme.generateAuthResponse(host, request, null); final Map table4 = parseAuthResponse(authResponse4); Assertions.assertEquals("00000001", table4.get("nc")); final String cnonce4 = authscheme.getCnonce(); final String sessionKey4 = authscheme.getA1(); Assertions.assertNotEquals(cnonce1, cnonce4); Assertions.assertNotEquals(sessionKey1, sessionKey4); } @Test void testHttpEntityDigest() throws Exception { final HttpEntityDigester digester = new HttpEntityDigester(MessageDigest.getInstance("MD5")); Assertions.assertNull(digester.getDigest()); digester.write('a'); digester.write('b'); digester.write('c'); digester.write(0xe4); digester.write(0xf6); digester.write(0xfc); digester.write(new byte[]{'a', 'b', 'c'}); Assertions.assertNull(digester.getDigest()); digester.close(); Assertions.assertEquals("acd2b59cd01c7737d8069015584c6cac", DigestScheme.formatHex(digester.getDigest())); Assertions.assertThrows(IOException.class, () -> digester.write('a')); Assertions.assertThrows(IOException.class, () -> digester.write(new byte[]{'a', 'b', 'c'})); } @Test void testDigestAuthenticationQopAuthInt() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest("Post", "/"); request.setEntity(new StringEntity("abc\u00e4\u00f6\u00fcabc", StandardCharsets.ISO_8859_1)); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", " + "qop=\"auth,auth-int\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); Assertions.assertEquals("Post:/:acd2b59cd01c7737d8069015584c6cac", authscheme.getA2()); final Map table = parseAuthResponse(authResponse); Assertions.assertEquals("username", table.get("username")); Assertions.assertEquals("realm1", table.get("realm")); Assertions.assertEquals("/", table.get("uri")); Assertions.assertEquals("auth-int", table.get("qop")); Assertions.assertEquals("f2a3f18799759d4f1a1c068b92b573cb", table.get("nonce")); } @Test void testDigestAuthenticationQopAuthIntNullEntity() throws Exception { final HttpRequest request = new BasicHttpRequest("Post", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", " + "qop=\"auth-int\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); Assertions.assertEquals("Post:/:d41d8cd98f00b204e9800998ecf8427e", authscheme.getA2()); final Map table = parseAuthResponse(authResponse); Assertions.assertEquals("username", table.get("username")); Assertions.assertEquals("realm1", table.get("realm")); Assertions.assertEquals("/", table.get("uri")); Assertions.assertEquals("auth-int", table.get("qop")); Assertions.assertEquals("f2a3f18799759d4f1a1c068b92b573cb", table.get("nonce")); } @Test void testDigestAuthenticationQopAuthOrAuthIntNonRepeatableEntity() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest("Post", "/"); request.setEntity(new InputStreamEntity(new ByteArrayInputStream(new byte[]{'a'}), -1, ContentType.DEFAULT_TEXT)); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", " + "qop=\"auth,auth-int\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); Assertions.assertEquals("Post:/", authscheme.getA2()); final Map table = parseAuthResponse(authResponse); Assertions.assertEquals("username", table.get("username")); Assertions.assertEquals("realm1", table.get("realm")); Assertions.assertEquals("/", table.get("uri")); Assertions.assertEquals("auth", table.get("qop")); Assertions.assertEquals("f2a3f18799759d4f1a1c068b92b573cb", table.get("nonce")); } @Test void testParameterCaseSensitivity() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "-", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " Realm=\"-\", " + "nonce=\"YjYuNGYyYmJhMzUuY2I5ZDhlZDE5M2ZlZDM 1Mjk3NGJkNTIyYjgyNTcwMjQ=\", " + "opaque=\"98700A3D9CE17065E2246B41035C6609\", qop=\"auth\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertEquals("-", authscheme.getRealm()); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); authscheme.generateAuthResponse(host, request, null); } @Test void testDigestAuthenticationQopIntOnlyNonRepeatableEntity() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest("Post", "/"); request.setEntity(new InputStreamEntity(new ByteArrayInputStream(new byte[]{'a'}), -1, ContentType.DEFAULT_TEXT)); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", " + "qop=\"auth-int\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); Assertions.assertThrows(AuthenticationException.class, () -> authscheme.generateAuthResponse(host, request, null)); } @Test void testSerialization() throws Exception { final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", " + "qop=\"auth,auth-int\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme digestScheme = new DigestScheme(); digestScheme.processChallenge(authChallenge, null); final ByteArrayOutputStream buffer = new ByteArrayOutputStream(); final ObjectOutputStream out = new ObjectOutputStream(buffer); out.writeObject(digestScheme); out.flush(); final byte[] raw = buffer.toByteArray(); final ObjectInputStream in = new ObjectInputStream(new ByteArrayInputStream(raw)); final DigestScheme authScheme = (DigestScheme) in.readObject(); Assertions.assertEquals(digestScheme.getName(), authScheme.getName()); Assertions.assertEquals(digestScheme.getRealm(), authScheme.getRealm()); Assertions.assertEquals(digestScheme.isChallengeComplete(), authScheme.isChallengeComplete()); Assertions.assertEquals(digestScheme.getA1(), authScheme.getA1()); Assertions.assertEquals(digestScheme.getA2(), authScheme.getA2()); Assertions.assertEquals(digestScheme.getCnonce(), authScheme.getCnonce()); } @Test void testDigestAuthenticationWithUserHash() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); // Include userhash in the challenge final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", userhash=true"; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); final Map table = parseAuthResponse(authResponse); // Generate expected userhash final MessageDigest md = MessageDigest.getInstance("MD5"); md.update("username:realm1".getBytes(StandardCharsets.UTF_8)); final String expectedUserhash = bytesToHex(md.digest()); Assertions.assertEquals(expectedUserhash, table.get("username")); Assertions.assertEquals("realm1", table.get("realm")); Assertions.assertEquals("/", table.get("uri")); Assertions.assertEquals("f2a3f18799759d4f1a1c068b92b573cb", table.get("nonce")); Assertions.assertEquals("3b6561ceb73e5ffe9314a695179f23f9", table.get("response")); } private static String bytesToHex(final byte[] bytes) { final StringBuilder hexString = new StringBuilder(); for (final byte b : bytes) { final String hex = Integer.toHexString(0xff & b); if (hex.length() == 1) { hexString.append('0'); } hexString.append(hex); } return hexString.toString(); } @Test void testDigestAuthenticationWithQuotedStringsAndWhitespace() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "\"myhost@example.com\"", null), "\"Mufasa\"", "\"Circle Of Life\"".toCharArray()) .build(); // Include userhash in the challenge final String challenge = StandardAuthScheme.DIGEST + " realm=\"\\\"myhost@example.com\\\"\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", userhash=true"; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); final Map table = parseAuthResponse(authResponse); // Generate expected A1 hash final MessageDigest md = MessageDigest.getInstance("MD5"); final String a1 = "Mufasa:myhost@example.com:Circle Of Life"; // Note: quotes removed and internal whitespace preserved md.update(a1.getBytes(StandardCharsets.UTF_8)); // Extract the response and validate the A1 hash final String response = table.get("response"); Assertions.assertNotNull(response); } @Test void testDigestAuthenticationWithInvalidUsernameAndValidUsernameStar() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest("POST", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "invalid\"username", "password".toCharArray()) .build(); final String encodedUsername = "UTF-8''J%C3%A4s%C3%B8n%20Doe"; final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", " + "qop=\"auth-int\", username*=\"" + encodedUsername + "\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); Assertions.assertNotNull(authResponse); } @Test void testDigestAuthenticationWithHighAsciiCharInUsername() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest("POST", "/"); final HttpHost host = new HttpHost("somehost", 80); // Using a username with a high ASCII character final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "high\u007Fchar", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", qop=\"auth-int\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); // Optionally, verify that 'username*' is used in the response Assertions.assertTrue(authResponse.contains("username*")); } @Test void testDigestAuthenticationWithExtendedAsciiCharInUsername() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest("POST", "/"); final HttpHost host = new HttpHost("somehost", 80); // Using an extended ASCII character (e.g., 0x80) in the username final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username\u0080", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", qop=\"auth-int\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); Assertions.assertTrue(authResponse.contains("username*")); } @Test void testDigestAuthenticationWithNonAsciiUsername() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest("POST", "/"); final HttpHost host = new HttpHost("somehost", 80); // Using a username with non-ASCII characters final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "Jäsøn Doe", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", qop=\"auth-int\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); // Optionally, verify that 'username*' is used in the response Assertions.assertTrue(authResponse.contains("username*")); } @Test void testRspAuthFieldNotPresentClient() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest("POST", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); // Challenge with qop set to "auth-int" to trigger rspauth field final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", qop=\"auth-int\""; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); final Map table = parseAuthResponse(authResponse); Assertions.assertNotNull(table); Assertions.assertNull(table.get("rspauth")); } @Test void testNextNonceUsageFromContext() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final HttpClientContext context = HttpClientContext.create(); context.setNextNonce("sampleNextNonce"); // Set `nextNonce` in the context final DigestScheme authscheme = new DigestScheme(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"initialNonce\""; final AuthChallenge authChallenge = parse(challenge); authscheme.processChallenge(authChallenge, context); // Simulate credentials validation and generate auth response authscheme.isResponseReady(host, credentialsProvider, context); final String authResponse = authscheme.generateAuthResponse(host, request, context); // Validate that `sampleNextNonce` (from context) is used in place of the initial nonce final Map paramMap = parseAuthResponse(authResponse); Assertions.assertEquals("sampleNextNonce", paramMap.get("nonce"), "The nonce should match 'auth-nextnonce' from the context."); // Verify that `auth-nextnonce` was removed from context after use Assertions.assertNull(context.getAttribute("auth-nextnonce"), "The next nonce should be removed from the context after use."); } @Test void testNoNextNonceUsageFromContext() throws Exception { final HttpRequest request = new BasicHttpRequest("GET", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final HttpClientContext context = HttpClientContext.create(); // Initialize DigestScheme without setting any `nextNonce` final DigestScheme authscheme = new DigestScheme(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"initialNonce\""; final AuthChallenge authChallenge = parse(challenge); authscheme.processChallenge(authChallenge, context); // Simulate credentials validation and generate auth response authscheme.isResponseReady(host, credentialsProvider, context); final String authResponse = authscheme.generateAuthResponse(host, request, context); // Validate that the nonce in the response matches the initial nonce, not a nextNonce final Map paramMap = parseAuthResponse(authResponse); Assertions.assertEquals("initialNonce", paramMap.get("nonce"), "The nonce should match the initial nonce provided in the challenge."); // Verify that the context does not contain any `nextNonce` value set Assertions.assertNull(context.getAttribute("auth-nextnonce"), "The context should not contain a nextNonce attribute."); } @Test void testDigestAuthenticationWithSHA256() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", algorithm=SHA-256"; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); final Map table = parseAuthResponse(authResponse); Assertions.assertEquals("username", table.get("username")); Assertions.assertEquals("realm1", table.get("realm")); Assertions.assertEquals("/", table.get("uri")); Assertions.assertEquals("f2a3f18799759d4f1a1c068b92b573cb", table.get("nonce")); Assertions.assertEquals("SHA-256", table.get("algorithm")); Assertions.assertNotNull(table.get("response")); } @Test void testDigestAuthenticationWithSHA512_256() throws Exception { final HttpRequest request = new BasicHttpRequest("Simple", "/"); final HttpHost host = new HttpHost("somehost", 80); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "realm1", null), "username", "password".toCharArray()) .build(); final String challenge = StandardAuthScheme.DIGEST + " realm=\"realm1\", nonce=\"f2a3f18799759d4f1a1c068b92b573cb\", algorithm=SHA-512-256"; final AuthChallenge authChallenge = parse(challenge); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse = authscheme.generateAuthResponse(host, request, null); final Map table = parseAuthResponse(authResponse); Assertions.assertEquals("username", table.get("username")); Assertions.assertEquals("realm1", table.get("realm")); Assertions.assertEquals("/", table.get("uri")); Assertions.assertEquals("f2a3f18799759d4f1a1c068b92b573cb", table.get("nonce")); Assertions.assertEquals("SHA-512-256", table.get("algorithm")); Assertions.assertNotNull(table.get("response")); } @Test void testDigestSHA256SessA1AndCnonceConsistency() throws Exception { final HttpHost host = new HttpHost("somehost", 80); final HttpRequest request = new BasicHttpRequest("GET", "/"); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "subnet.domain.com", null), "username", "password".toCharArray()) .build(); final String challenge1 = StandardAuthScheme.DIGEST + " qop=\"auth\", algorithm=SHA-256-sess, nonce=\"1234567890abcdef\", " + "charset=utf-8, realm=\"subnet.domain.com\""; final AuthChallenge authChallenge1 = parse(challenge1); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge1, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse1 = authscheme.generateAuthResponse(host, request, null); final Map table1 = parseAuthResponse(authResponse1); Assertions.assertEquals("00000001", table1.get("nc")); final String cnonce1 = authscheme.getCnonce(); final String sessionKey1 = authscheme.getA1(); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse2 = authscheme.generateAuthResponse(host, request, null); final Map table2 = parseAuthResponse(authResponse2); Assertions.assertEquals("00000002", table2.get("nc")); final String cnonce2 = authscheme.getCnonce(); final String sessionKey2 = authscheme.getA1(); Assertions.assertEquals(cnonce1, cnonce2); Assertions.assertEquals(sessionKey1, sessionKey2); final String challenge2 = StandardAuthScheme.DIGEST + " qop=\"auth\", algorithm=SHA-256-sess, nonce=\"1234567890abcdef\", " + "charset=utf-8, realm=\"subnet.domain.com\""; final AuthChallenge authChallenge2 = parse(challenge2); authscheme.processChallenge(authChallenge2, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse3 = authscheme.generateAuthResponse(host, request, null); final Map table3 = parseAuthResponse(authResponse3); Assertions.assertEquals("00000003", table3.get("nc")); final String cnonce3 = authscheme.getCnonce(); final String sessionKey3 = authscheme.getA1(); Assertions.assertEquals(cnonce1, cnonce3); Assertions.assertEquals(sessionKey1, sessionKey3); final String challenge3 = StandardAuthScheme.DIGEST + " qop=\"auth\", algorithm=SHA-256-sess, nonce=\"fedcba0987654321\", " + "charset=utf-8, realm=\"subnet.domain.com\""; final AuthChallenge authChallenge3 = parse(challenge3); authscheme.processChallenge(authChallenge3, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse4 = authscheme.generateAuthResponse(host, request, null); final Map table4 = parseAuthResponse(authResponse4); Assertions.assertEquals("00000001", table4.get("nc")); final String cnonce4 = authscheme.getCnonce(); final String sessionKey4 = authscheme.getA1(); Assertions.assertNotEquals(cnonce1, cnonce4); Assertions.assertNotEquals(sessionKey1, sessionKey4); } @Test void testDigestSHA512256SessA1AndCnonceConsistency() throws Exception { final HttpHost host = new HttpHost("somehost", 80); final HttpRequest request = new BasicHttpRequest("GET", "/"); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(host, "subnet.domain.com", null), "username", "password".toCharArray()) .build(); final String challenge1 = StandardAuthScheme.DIGEST + " qop=\"auth\", algorithm=SHA-512-256-sess, nonce=\"1234567890abcdef\", " + "charset=utf-8, realm=\"subnet.domain.com\""; final AuthChallenge authChallenge1 = parse(challenge1); final DigestScheme authscheme = new DigestScheme(); authscheme.processChallenge(authChallenge1, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse1 = authscheme.generateAuthResponse(host, request, null); final Map table1 = parseAuthResponse(authResponse1); Assertions.assertEquals("00000001", table1.get("nc")); final String cnonce1 = authscheme.getCnonce(); final String sessionKey1 = authscheme.getA1(); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse2 = authscheme.generateAuthResponse(host, request, null); final Map table2 = parseAuthResponse(authResponse2); Assertions.assertEquals("00000002", table2.get("nc")); final String cnonce2 = authscheme.getCnonce(); final String sessionKey2 = authscheme.getA1(); Assertions.assertEquals(cnonce1, cnonce2); Assertions.assertEquals(sessionKey1, sessionKey2); final String challenge2 = StandardAuthScheme.DIGEST + " qop=\"auth\", algorithm=SHA-512-256-sess, nonce=\"1234567890abcdef\", " + "charset=utf-8, realm=\"subnet.domain.com\""; final AuthChallenge authChallenge2 = parse(challenge2); authscheme.processChallenge(authChallenge2, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse3 = authscheme.generateAuthResponse(host, request, null); final Map table3 = parseAuthResponse(authResponse3); Assertions.assertEquals("00000003", table3.get("nc")); final String cnonce3 = authscheme.getCnonce(); final String sessionKey3 = authscheme.getA1(); Assertions.assertEquals(cnonce1, cnonce3); Assertions.assertEquals(sessionKey1, sessionKey3); final String challenge3 = StandardAuthScheme.DIGEST + " qop=\"auth\", algorithm=SHA-512-256-sess, nonce=\"fedcba0987654321\", " + "charset=utf-8, realm=\"subnet.domain.com\""; final AuthChallenge authChallenge3 = parse(challenge3); authscheme.processChallenge(authChallenge3, null); Assertions.assertTrue(authscheme.isResponseReady(host, credentialsProvider, null)); final String authResponse4 = authscheme.generateAuthResponse(host, request, null); final Map table4 = parseAuthResponse(authResponse4); Assertions.assertEquals("00000001", table4.get("nc")); final String cnonce4 = authscheme.getCnonce(); final String sessionKey4 = authscheme.getA1(); Assertions.assertNotEquals(cnonce1, cnonce4); Assertions.assertNotEquals(sessionKey1, sessionKey4); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/auth/TestCredentialsProviders.java0100664 0000000 0000000 00000021275 14704162040 031232 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.auth; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.core5.http.HttpHost; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Tests for {@link org.apache.hc.client5.http.auth.CredentialsProvider} implementations. */ class TestCredentialsProviders { public final static Credentials CREDS1 = new UsernamePasswordCredentials("user1", "pass1".toCharArray()); public final static Credentials CREDS2 = new UsernamePasswordCredentials("user2", "pass2".toCharArray()); public final static AuthScope SCOPE1 = new AuthScope(null, null, -1, "realm1", null); public final static AuthScope SCOPE2 = new AuthScope(null, null, -1, "realm2", null); public final static AuthScope BOGUS = new AuthScope(null, null, -1, "bogus", null); public final static AuthScope DEFSCOPE = new AuthScope(null, "host", -1, "realm", null); @Test void testBasicCredentialsProviderCredentials() { final BasicCredentialsProvider state = new BasicCredentialsProvider(); state.setCredentials(SCOPE1, CREDS1); state.setCredentials(SCOPE2, CREDS2); Assertions.assertEquals(CREDS1, state.getCredentials(SCOPE1, null)); Assertions.assertEquals(CREDS2, state.getCredentials(SCOPE2, null)); } @Test void testBasicCredentialsProviderNoCredentials() { final BasicCredentialsProvider state = new BasicCredentialsProvider(); Assertions.assertNull(state.getCredentials(BOGUS, null)); } @Test void testBasicCredentialsProviderDefaultCredentials() { final BasicCredentialsProvider state = new BasicCredentialsProvider(); state.setCredentials(new AuthScope(null, null, -1, null ,null), CREDS1); state.setCredentials(SCOPE2, CREDS2); Assertions.assertEquals(CREDS1, state.getCredentials(BOGUS, null)); } @Test void testDefaultCredentials() { final BasicCredentialsProvider state = new BasicCredentialsProvider(); final Credentials expected = new UsernamePasswordCredentials("name", "pass".toCharArray()); state.setCredentials(new AuthScope(null, null, -1, null ,null), expected); final Credentials got = state.getCredentials(DEFSCOPE, null); Assertions.assertEquals(got, expected); } @Test void testRealmCredentials() { final BasicCredentialsProvider state = new BasicCredentialsProvider(); final Credentials expected = new UsernamePasswordCredentials("name", "pass".toCharArray()); state.setCredentials(DEFSCOPE, expected); final Credentials got = state.getCredentials(DEFSCOPE, null); Assertions.assertEquals(expected, got); } @Test void testHostCredentials() { final BasicCredentialsProvider state = new BasicCredentialsProvider(); final Credentials expected = new UsernamePasswordCredentials("name", "pass".toCharArray()); state.setCredentials(new AuthScope(null, "host", -1, null, null), expected); final Credentials got = state.getCredentials(DEFSCOPE, null); Assertions.assertEquals(expected, got); } @Test void testWrongHostCredentials() { final BasicCredentialsProvider state = new BasicCredentialsProvider(); final Credentials expected = new UsernamePasswordCredentials("name", "pass".toCharArray()); state.setCredentials(new AuthScope(null, "host1", -1, "realm", null), expected); final Credentials got = state.getCredentials(new AuthScope(null, "host2", -1, "realm", null), null); Assertions.assertNotSame(expected, got); } @Test void testWrongRealmCredentials() { final BasicCredentialsProvider state = new BasicCredentialsProvider(); final Credentials cred = new UsernamePasswordCredentials("name", "pass".toCharArray()); state.setCredentials(new AuthScope(null, "host", -1, "realm1", null), cred); final Credentials got = state.getCredentials(new AuthScope(null, "host", -1, "realm2", null), null); Assertions.assertNotSame(cred, got); } @Test void testMixedCaseHostname() { final HttpHost httpHost = new HttpHost("hOsT", 80); final BasicCredentialsProvider state = new BasicCredentialsProvider(); final Credentials expected = new UsernamePasswordCredentials("name", "pass".toCharArray()); state.setCredentials(new AuthScope(httpHost), expected); final Credentials got = state.getCredentials(DEFSCOPE, null); Assertions.assertEquals(expected, got); } @Test void testCredentialsMatching() { final Credentials creds1 = new UsernamePasswordCredentials("name1", "pass1".toCharArray()); final Credentials creds2 = new UsernamePasswordCredentials("name2", "pass2".toCharArray()); final Credentials creds3 = new UsernamePasswordCredentials("name3", "pass3".toCharArray()); final AuthScope scope1 = new AuthScope(null, null, -1, null, null); final AuthScope scope2 = new AuthScope(null, null, -1, "somerealm", null); final AuthScope scope3 = new AuthScope(null, "somehost", -1, null, null); final BasicCredentialsProvider state = new BasicCredentialsProvider(); state.setCredentials(scope1, creds1); state.setCredentials(scope2, creds2); state.setCredentials(scope3, creds3); Credentials got = state.getCredentials(new AuthScope("http", "someotherhost", 80, "someotherrealm", StandardAuthScheme.BASIC), null); Credentials expected = creds1; Assertions.assertEquals(expected, got); got = state.getCredentials(new AuthScope("http", "someotherhost", 80, "somerealm", StandardAuthScheme.BASIC), null); expected = creds2; Assertions.assertEquals(expected, got); got = state.getCredentials(new AuthScope("http", "somehost", 80, "someotherrealm", StandardAuthScheme.BASIC), null); expected = creds3; Assertions.assertEquals(expected, got); } @Test void testSingleCredentialsProvider() { final Credentials creds1 = new UsernamePasswordCredentials("name1", "pass1".toCharArray()); final CredentialsProvider credentialsProvider1 = new SingleCredentialsProvider(new AuthScope(null, null, -1, null, null), creds1); Assertions.assertEquals(creds1, credentialsProvider1.getCredentials(new AuthScope(null, null, -1, null, null), null)); Assertions.assertEquals(creds1, credentialsProvider1.getCredentials(new AuthScope("http", "someotherhost", 80, "somerealm", StandardAuthScheme.BASIC), null)); final CredentialsProvider credentialsProvider2 = new SingleCredentialsProvider(new AuthScope(null, "somehost", 80, null, null), creds1); Assertions.assertEquals(creds1, credentialsProvider2.getCredentials(new AuthScope(null, null, -1, null, null), null)); Assertions.assertEquals(creds1, credentialsProvider2.getCredentials(new AuthScope(null, "somehost", 80, null, null), null)); Assertions.assertEquals(creds1, credentialsProvider2.getCredentials(new AuthScope("http", "somehost", 80, "somerealm", StandardAuthScheme.BASIC), null)); Assertions.assertNull(credentialsProvider2.getCredentials(new AuthScope(null, "someotherhost", 80, null, null), null)); Assertions.assertNull(credentialsProvider2.getCredentials(new AuthScope(null, "somehost", 8080, null, null), null)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/routing/0040775 0000000 0000000 00000000000 15005672016 024122 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/routing/TestDefaultRoutePlanner.java0100664 0000000 0000000 00000013432 14704162040 031544 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.http.protocol.HttpContext; import org.apache.hc.core5.net.URIAuthority; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mockito; /** * Tests for {@link DefaultRoutePlanner}. */ class TestDefaultRoutePlanner { private SchemePortResolver schemePortResolver; private DefaultRoutePlanner routePlanner; @BeforeEach void setup() { schemePortResolver = Mockito.mock(SchemePortResolver.class); routePlanner = new DefaultRoutePlanner(schemePortResolver); } @Test void testDirect() throws Exception { final HttpHost target = new HttpHost("http", "somehost", 80); final HttpContext context = HttpClientContext.create(); final HttpRoute route = routePlanner.determineRoute(target, context); Assertions.assertEquals(target, route.getTargetHost()); Assertions.assertEquals(1, route.getHopCount()); Assertions.assertFalse(route.isSecure()); Mockito.verify(schemePortResolver, Mockito.never()).resolve(Mockito.any()); } @Test void testDirectDefaultPort() throws Exception { final HttpHost target = new HttpHost("https", "somehost", -1); Mockito.when(schemePortResolver.resolve(target)).thenReturn(443); final HttpContext context = HttpClientContext.create(); final HttpRoute route = routePlanner.determineRoute(target, context); Assertions.assertEquals(new HttpHost("https", "somehost", 443), route.getTargetHost()); Assertions.assertEquals(1, route.getHopCount()); Assertions.assertTrue(route.isSecure()); } @Test @SuppressWarnings("deprecation") void testViaProxy() throws Exception { final HttpHost target = new HttpHost("http", "somehost", 80); final HttpHost proxy = new HttpHost("proxy", 8080); final HttpClientContext context = HttpClientContext.create(); context.setRequestConfig(RequestConfig.custom().setProxy(proxy).build()); final HttpRoute route = routePlanner.determineRoute(target, context); Assertions.assertEquals(target, route.getTargetHost()); Assertions.assertEquals(proxy, route.getProxyHost()); Assertions.assertEquals(2, route.getHopCount()); Assertions.assertFalse(route.isSecure()); Mockito.verify(schemePortResolver, Mockito.never()).resolve(Mockito.any()); } @Test void testNullTarget() { final HttpContext context = HttpClientContext.create(); Assertions.assertThrows(ProtocolException.class, () -> routePlanner.determineRoute(null, context)); } @Test void testVirtualSecureHost() throws Exception { final HttpHost target = new HttpHost("https", "somehost", 443); final URIAuthority virtualHost = new URIAuthority("someotherhost", 443); final HttpRequest request = new BasicHttpRequest("https", "GET", virtualHost, "/"); final HttpContext context = HttpClientContext.create(); final HttpRoute route = routePlanner.determineRoute(target, request, context); Assertions.assertEquals(target, route.getTargetHost()); Assertions.assertEquals(virtualHost, route.getTargetName()); Assertions.assertEquals(1, route.getHopCount()); Assertions.assertTrue(route.isSecure()); Mockito.verify(schemePortResolver, Mockito.never()).resolve(Mockito.any()); } @Test void testVirtualInsecureHost() throws Exception { final HttpHost target = new HttpHost("http", "somehost", 80); final URIAuthority virtualHost = new URIAuthority("someotherhost", 80); final HttpRequest request = new BasicHttpRequest("http", "GET", virtualHost, "/"); final HttpContext context = HttpClientContext.create(); final HttpRoute route = routePlanner.determineRoute(target, request, context); Assertions.assertEquals(target, route.getTargetHost()); Assertions.assertNull(route.getTargetName()); Assertions.assertEquals(1, route.getHopCount()); Assertions.assertFalse(route.isSecure()); Mockito.verify(schemePortResolver, Mockito.never()).resolve(Mockito.any()); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/routing/TestRouteDirector.java0100664 0000000 0000000 00000044255 15005672016 030426 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import java.net.InetAddress; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteInfo.LayerType; import org.apache.hc.client5.http.RouteInfo.TunnelType; import org.apache.hc.client5.http.routing.HttpRouteDirector; import org.apache.hc.core5.http.HttpHost; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Tests for {@link BasicRouteDirector}. */ class TestRouteDirector { // a selection of constants for generating routes public final static HttpHost TARGET1 = new HttpHost("target1.test.invalid", 80); public final static HttpHost TARGET2 = new HttpHost("target2.test.invalid", 8080); // It is not necessary to have extra targets for https. // The 'layered' and 'secure' flags are specified explicitly // for routes, they will not be determined from the scheme. public final static HttpHost PROXY1 = new HttpHost("proxy1.test.invalid", 80); public final static HttpHost PROXY2 = new HttpHost("proxy2.test.invalid", 1080); public final static HttpHost PROXY3 = new HttpHost("proxy3.test.invalid", 88); public final static InetAddress LOCAL41; public final static InetAddress LOCAL42; public final static InetAddress LOCAL61; public final static InetAddress LOCAL62; // need static initializer to deal with exceptions static { try { LOCAL41 = InetAddress.getByAddress(new byte[]{127, 0, 0, 1}); LOCAL42 = InetAddress.getByAddress(new byte[]{127, 0, 0, 2}); LOCAL61 = InetAddress.getByAddress(new byte[]{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 }); LOCAL62 = InetAddress.getByAddress(new byte[]{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2 }); } catch (final Exception x) { throw new ExceptionInInitializerError(x); } } @Test void testIllegal() { final HttpRouteDirector rowdy = BasicRouteDirector.INSTANCE; final HttpRoute route = new HttpRoute(TARGET1); Assertions.assertThrows(NullPointerException.class, () -> rowdy.nextStep(null, route)); } @Test void testDirect() { final HttpRouteDirector rowdy = BasicRouteDirector.INSTANCE; final HttpRoute route1 = new HttpRoute(TARGET1); final HttpRoute route2 = new HttpRoute(TARGET2); final HttpRoute route1p1 = new HttpRoute(TARGET1, null, PROXY1, false); int step = rowdy.nextStep(route1, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_TARGET, step, "wrong step to route1"); step = rowdy.nextStep(route2, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_TARGET, step, "wrong step to route2"); step = rowdy.nextStep(route1, route1); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1 not detected"); step = rowdy.nextStep(route2, route2); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route2 not detected"); step = rowdy.nextStep(route1, route2); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable target not detected"); step = rowdy.nextStep(route1, route1p1); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "invalid proxy not detected"); } @Test void testProxy() { final HttpRouteDirector rowdy = BasicRouteDirector.INSTANCE; final HttpRoute route1p1 = new HttpRoute(TARGET1, null, PROXY1, false); final HttpRoute route1p2 = new HttpRoute(TARGET1, null, PROXY2, false); final HttpRoute route2p1 = new HttpRoute(TARGET2, null, PROXY1, false); final HttpRoute route0 = new HttpRoute(PROXY1); final HttpRoute route1 = new HttpRoute(TARGET1); int step = rowdy.nextStep(route1p1, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1p1"); step = rowdy.nextStep(route1p2, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1p2"); step = rowdy.nextStep(route1p1, route1p1); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1p1 not detected"); step = rowdy.nextStep(route1p2, route1p2); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1p2 not detected"); step = rowdy.nextStep(route2p1, route2p1); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route2p1 not detected"); step = rowdy.nextStep(route1p1, route1p2); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1p1 via route1p2 not detected"); step = rowdy.nextStep(route1p1, route2p1); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1p1 via route2p1 not detected"); step = rowdy.nextStep(route1p1, route0); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1p1 via route0 not detected"); step = rowdy.nextStep(route1p1, route1); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1p1 via route1 not detected"); } @Test void testProxyChain() { final HttpHost[] chainA = {PROXY1}; final HttpHost[] chainB = {PROXY1, PROXY2}; final HttpHost[] chainC = {PROXY2, PROXY1}; final HttpRouteDirector rowdy = BasicRouteDirector.INSTANCE; final HttpRoute route1cA = new HttpRoute(TARGET1, null, chainA, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route1cB = new HttpRoute(TARGET1, null, chainB, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route1cC = new HttpRoute(TARGET1, null, chainC, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route1cD = new HttpRoute(TARGET1, null, chainC, false, TunnelType.PLAIN, LayerType.PLAIN); int step = rowdy.nextStep(route1cA, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1cA"); step = rowdy.nextStep(route1cB, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1cB"); step = rowdy.nextStep(route1cC, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1cC"); step = rowdy.nextStep(route1cD, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1cD"); step = rowdy.nextStep(route1cB, route1cA); Assertions.assertEquals(HttpRouteDirector.TUNNEL_PROXY, step, "wrong step to route 1cB from 1cA"); step = rowdy.nextStep(route1cB, route1cB); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route 1cB not detected"); step = rowdy.nextStep(route1cB, route1cC); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route 1cB from 1cC not detected"); step = rowdy.nextStep(route1cB, route1cD); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route 1cB from 1cD not detected"); step = rowdy.nextStep(route1cA, route1cB); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route 1cA from 1cB not detected"); } @Test void testLocalDirect() { final HttpRouteDirector rowdy = BasicRouteDirector.INSTANCE; final HttpRoute route1l41 = new HttpRoute(TARGET1, LOCAL41, false); final HttpRoute route1l42 = new HttpRoute(TARGET1, LOCAL42, false); final HttpRoute route1l61 = new HttpRoute(TARGET1, LOCAL61, false); final HttpRoute route1l00 = new HttpRoute(TARGET1, null, false); int step = rowdy.nextStep(route1l41, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_TARGET, step, "wrong step to route1l41"); step = rowdy.nextStep(route1l42, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_TARGET, step, "wrong step to route1l42"); step = rowdy.nextStep(route1l61, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_TARGET, step, "wrong step to route1l61"); step = rowdy.nextStep(route1l00, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_TARGET, step, "wrong step to route1l00"); step = rowdy.nextStep(route1l41, route1l41); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1l41 not detected"); step = rowdy.nextStep(route1l42, route1l42); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1l42 not detected"); step = rowdy.nextStep(route1l61, route1l61); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1l61 not detected"); step = rowdy.nextStep(route1l00, route1l00); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1l00 not detected"); step = rowdy.nextStep(route1l41, route1l42); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1l41 via route1l42 not detected"); step = rowdy.nextStep(route1l41, route1l61); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1l41 via route1l61 not detected"); step = rowdy.nextStep(route1l41, route1l00); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1l41 via route1l00 not detected"); step = rowdy.nextStep(route1l00, route1l41); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1l00 as route1l41 not detected"); step = rowdy.nextStep(route1l00, route1l42); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1l00 as route1l42 not detected"); step = rowdy.nextStep(route1l00, route1l61); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1l00 as route1l61 not detected"); } @Test void testDirectSecure() { final HttpRouteDirector rowdy = BasicRouteDirector.INSTANCE; final HttpRoute route1u = new HttpRoute(TARGET1, null, false); final HttpRoute route1s = new HttpRoute(TARGET1, null, true); final HttpRoute route1p1u = new HttpRoute(TARGET1, null, PROXY1, false); final HttpRoute route1p1s = new HttpRoute(TARGET1, null, PROXY1, true); int step = rowdy.nextStep(route1u, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_TARGET, step, "wrong step to route1u"); step = rowdy.nextStep(route1s, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_TARGET, step, "wrong step to route1s"); // unrequested security is currently not tolerated step = rowdy.nextStep(route1u, route1s); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route 1u from 1s not detected"); // secure layering of direct connections is currently not supported step = rowdy.nextStep(route1s, route1u); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route 1s from 1u not detected"); step = rowdy.nextStep(route1s, route1p1u); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route 1s from 1p1u not detected"); step = rowdy.nextStep(route1s, route1p1s); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route 1s from 1p1s not detected"); } @Test void testProxyTLS() { final HttpRouteDirector rowdy = BasicRouteDirector.INSTANCE; final HttpRoute route1 = new HttpRoute (TARGET1, null, PROXY1, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route1t = new HttpRoute (TARGET1, null, PROXY1, false, TunnelType.TUNNELLED, LayerType.PLAIN); final HttpRoute route1tl = new HttpRoute (TARGET1, null, PROXY1, false, TunnelType.TUNNELLED, LayerType.LAYERED); final HttpRoute route1s = new HttpRoute (TARGET1, null, PROXY1, true, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route1ts = new HttpRoute (TARGET1, null, PROXY1, true, TunnelType.TUNNELLED, LayerType.PLAIN); final HttpRoute route1tls = new HttpRoute (TARGET1, null, PROXY1, true, TunnelType.TUNNELLED, LayerType.LAYERED); // we don't consider a route that is layered but not tunnelled int step = rowdy.nextStep(route1, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1"); step = rowdy.nextStep(route1t, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1t"); step = rowdy.nextStep(route1tl, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1tl"); step = rowdy.nextStep(route1s, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1s"); step = rowdy.nextStep(route1ts, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1ts"); step = rowdy.nextStep(route1tls, null); Assertions.assertEquals(HttpRouteDirector.CONNECT_PROXY, step, "wrong step to route1tls"); step = rowdy.nextStep(route1, route1); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1 not detected"); step = rowdy.nextStep(route1t, route1t); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1t not detected"); step = rowdy.nextStep(route1tl, route1tl); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1tl not detected"); step = rowdy.nextStep(route1s, route1s); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1s not detected"); step = rowdy.nextStep(route1ts, route1ts); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1ts not detected"); step = rowdy.nextStep(route1tls, route1tls); Assertions.assertEquals(HttpRouteDirector.COMPLETE, step, "complete route1tls not detected"); step = rowdy.nextStep(route1, route1t); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1 from 1t not detected"); step = rowdy.nextStep(route1, route1tl); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1 from 1tl not detected"); // unrequested security is currently not tolerated step = rowdy.nextStep(route1, route1s); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1 from 1s not detected"); step = rowdy.nextStep(route1, route1ts); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1 from 1ts not detected"); step = rowdy.nextStep(route1, route1tls); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1 from 1tls not detected"); // securing requires layering step = rowdy.nextStep(route1s, route1); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1s from 1 not detected"); // securing requires layering, and multiple layers are not supported step = rowdy.nextStep(route1tls, route1tl); Assertions.assertEquals(HttpRouteDirector.UNREACHABLE, step, "unreachable route1tls from 1tl not detected"); // cases where tunnelling to the target is required step = rowdy.nextStep(route1t, route1); Assertions.assertEquals(HttpRouteDirector.TUNNEL_TARGET, step, "wrong step to route1t from 1"); step = rowdy.nextStep(route1tl, route1); Assertions.assertEquals(HttpRouteDirector.TUNNEL_TARGET, step, "wrong step to route1tl from 1"); step = rowdy.nextStep(route1tls, route1); Assertions.assertEquals(HttpRouteDirector.TUNNEL_TARGET, step, "wrong step to route1tls from 1"); // cases where layering on the tunnel is required step = rowdy.nextStep(route1tl, route1t); Assertions.assertEquals(HttpRouteDirector.LAYER_PROTOCOL, step, "wrong step to route1tl from 1t"); step = rowdy.nextStep(route1tl, route1ts); Assertions.assertEquals(HttpRouteDirector.LAYER_PROTOCOL, step, "wrong step to route1tl from 1ts"); step = rowdy.nextStep(route1tls, route1t); Assertions.assertEquals(HttpRouteDirector.LAYER_PROTOCOL, step, "wrong step to route1tls from 1t"); step = rowdy.nextStep(route1tls, route1ts); Assertions.assertEquals(HttpRouteDirector.LAYER_PROTOCOL, step, "wrong step to route1tls from 1ts"); // There are some odd cases left over, like having a secure tunnel // that becomes unsecure by layering, or a secure connection to a // proxy that becomes unsecure by tunnelling to another proxy. } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/routing/TestRoutingSupport.java0100664 0000000 0000000 00000007250 14704162040 030646 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import static org.hamcrest.MatcherAssert.assertThat; import java.net.InetAddress; import java.net.URI; import org.apache.hc.client5.http.impl.DefaultSchemePortResolver; import org.apache.hc.client5.http.routing.RoutingSupport; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.message.BasicHttpRequest; import org.apache.hc.core5.net.URIAuthority; import org.hamcrest.CoreMatchers; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestRoutingSupport { @Test void testDetermineHost() throws Exception { final HttpRequest request1 = new BasicHttpRequest("GET", "/"); final HttpHost host1 = RoutingSupport.determineHost(request1); assertThat(host1, CoreMatchers.nullValue()); final HttpRequest request2 = new BasicHttpRequest("GET", new URI("https://somehost:8443/")); final HttpHost host2 = RoutingSupport.determineHost(request2); assertThat(host2, CoreMatchers.equalTo(new HttpHost("https", "somehost", 8443))); } @Test void testDetermineHostMissingScheme() { final HttpRequest request1 = new BasicHttpRequest("GET", "/"); request1.setAuthority(new URIAuthority("host")); Assertions.assertThrows(ProtocolException.class, () -> RoutingSupport.determineHost(request1)); } @Test void testNormalizeHost() throws Exception { Assertions.assertEquals(new HttpHost("http", "somehost", 80), RoutingSupport.normalize( new HttpHost("http", "somehost", -1), DefaultSchemePortResolver.INSTANCE)); Assertions.assertEquals(new HttpHost("https", "somehost", 443), RoutingSupport.normalize( new HttpHost("https", "somehost", -1), DefaultSchemePortResolver.INSTANCE)); Assertions.assertEquals(new HttpHost("http", InetAddress.getLocalHost(), "localhost", 80), RoutingSupport.normalize( new HttpHost("http", InetAddress.getLocalHost(), "localhost", -1), DefaultSchemePortResolver.INSTANCE)); Assertions.assertEquals(new HttpHost("http", "somehost", 8080), RoutingSupport.normalize( new HttpHost("http", "somehost", 8080), DefaultSchemePortResolver.INSTANCE)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/routing/TestRouteTracker.java0100664 0000000 0000000 00000061366 15005672016 030250 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import java.net.InetAddress; import java.util.HashSet; import java.util.Set; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteInfo.LayerType; import org.apache.hc.client5.http.RouteInfo.TunnelType; import org.apache.hc.client5.http.RouteTracker; import org.apache.hc.client5.http.routing.HttpRouteDirector; import org.apache.hc.core5.http.HttpHost; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Tests for {@link RouteTracker}. */ @SuppressWarnings("boxing") // test code class TestRouteTracker { // a selection of constants for generating routes public final static HttpHost TARGET1 = new HttpHost("target1.test.invalid", 80); public final static HttpHost TARGET2 = new HttpHost("target2.test.invalid", 8080); // It is not necessary to have extra targets for https. // The 'layered' and 'secure' flags are specified explicitly // for routes, they will not be determined from the scheme. public final static HttpHost PROXY1 = new HttpHost("proxy1.test.invalid", 80); public final static HttpHost PROXY2 = new HttpHost("proxy2.test.invalid", 1080); public final static HttpHost PROXY3 = new HttpHost("proxy3.test.invalid", 88); public final static InetAddress LOCAL41; public final static InetAddress LOCAL42; public final static InetAddress LOCAL61; public final static InetAddress LOCAL62; // need static initializer to deal with exceptions static { try { LOCAL41 = InetAddress.getByAddress(new byte[]{127, 0, 0, 1}); LOCAL42 = InetAddress.getByAddress(new byte[]{127, 0, 0, 2}); LOCAL61 = InetAddress.getByAddress(new byte[]{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 }); LOCAL62 = InetAddress.getByAddress(new byte[]{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2 }); } catch (final Exception x) { throw new ExceptionInInitializerError(x); } } @SuppressWarnings("unused") @Test void testCstrTargetLocal() { RouteTracker rt = new RouteTracker(TARGET1, null); Assertions.assertEquals(TARGET1, rt.getTargetHost(), "wrong target (target,null)"); Assertions.assertNull(rt.getLocalAddress(), "wrong local address (target,null)"); Assertions.assertEquals(0, rt.getHopCount(), "wrong hop count (target,null)"); Assertions.assertNull(rt.getProxyHost(), "wrong proxy (target,null)"); Assertions.assertNull(rt.toRoute(), "wrong route (target,null)"); checkCTLS(rt, false, false, false, false); rt = new RouteTracker(TARGET2, LOCAL61); Assertions.assertEquals(TARGET2, rt.getTargetHost(), "wrong target (target,local)"); Assertions.assertEquals(LOCAL61, rt.getLocalAddress(), "wrong local address (target,local)"); Assertions.assertEquals(0, rt.getHopCount(), "wrong hop count (target,local)"); Assertions.assertNull(rt.getProxyHost(), "wrong proxy (target,local)"); Assertions.assertNull(rt.toRoute(), "wrong route (target,local)"); checkCTLS(rt, false, false, false, false); Assertions.assertThrows(NullPointerException.class, () -> new RouteTracker(null, LOCAL41)); } @SuppressWarnings("unused") @Test void testCstrRoute() { HttpRoute r = new HttpRoute(TARGET1); RouteTracker rt = new RouteTracker(r); Assertions.assertEquals(TARGET1, rt.getTargetHost(), "wrong target (r1)"); Assertions.assertNull(rt.getLocalAddress(), "wrong local address (r1)"); Assertions.assertEquals(0, rt.getHopCount(), "wrong hop count (r1)"); Assertions.assertNull(rt.getProxyHost(), "wrong proxy (r1)"); Assertions.assertNull(rt.toRoute(), "wrong route (r1)"); checkCTLS(rt, false, false, false, false); r = new HttpRoute(TARGET2, LOCAL61, true); rt = new RouteTracker(r); Assertions.assertEquals(TARGET2, rt.getTargetHost(), "wrong target (r2)"); Assertions.assertEquals(LOCAL61, rt.getLocalAddress(), "wrong local address (r2)"); Assertions.assertEquals(0, rt.getHopCount(), "wrong hop count (r2)"); Assertions.assertNull(rt.getProxyHost(), "wrong proxy (r2)"); Assertions.assertNull(rt.toRoute(), "wrong route (r2)"); checkCTLS(rt, false, false, false, false); r = new HttpRoute(TARGET1, LOCAL42, PROXY3, true); rt = new RouteTracker(r); Assertions.assertEquals(TARGET1, rt.getTargetHost(), "wrong target (r3)"); Assertions.assertEquals(LOCAL42, rt.getLocalAddress(), "wrong local address (r3)"); Assertions.assertEquals(0, rt.getHopCount(), "wrong hop count (r3)"); Assertions.assertNull(rt.getProxyHost(), "wrong proxy (r3)"); Assertions.assertNull(rt.toRoute(), "wrong route (r3)"); checkCTLS(rt, false, false, false, false); Assertions.assertThrows(NullPointerException.class, () -> new RouteTracker(null)); } @Test void testIllegalArgs() { final RouteTracker rt = new RouteTracker(TARGET2, null); Assertions.assertThrows(NullPointerException.class, () -> rt.connectProxy(null, true)); Assertions.assertThrows(NullPointerException.class, () -> rt.connectProxy(null, false)); rt.connectProxy(PROXY1, false); Assertions.assertThrows(NullPointerException.class, () -> rt.tunnelProxy(null, false)); Assertions.assertThrows(NullPointerException.class, () -> rt.tunnelProxy(null, true)); Assertions.assertThrows(IllegalArgumentException.class, () -> rt.getHopTarget(-1)); Assertions.assertThrows(IllegalArgumentException.class, () -> rt.getHopTarget(2)); } @Test void testIllegalStates() { final RouteTracker rt = new RouteTracker(TARGET1, null); Assertions.assertThrows(IllegalStateException.class, () -> rt.tunnelTarget(false)); Assertions.assertThrows(IllegalStateException.class, () -> rt.tunnelProxy(PROXY1, false)); Assertions.assertThrows(IllegalStateException.class, () -> rt.layerProtocol(true)); // connect directly rt.connectTarget(false); Assertions.assertThrows(IllegalStateException.class, () -> rt.connectTarget(false)); Assertions.assertThrows(IllegalStateException.class, () -> rt.connectProxy(PROXY2, false)); Assertions.assertThrows(IllegalStateException.class, () -> rt.tunnelTarget(false)); Assertions.assertThrows(IllegalStateException.class, () -> rt.tunnelProxy(PROXY1, false)); } @Test void testDirectRoutes() { final HttpRouteDirector rd = BasicRouteDirector.INSTANCE; HttpRoute r = new HttpRoute(TARGET1, LOCAL41, false); RouteTracker rt = new RouteTracker(r); boolean complete = checkVia(rt, r, rd, 2); Assertions.assertTrue(complete, "incomplete route 1"); r = new HttpRoute(TARGET2, LOCAL62, true); rt = new RouteTracker(r); complete = checkVia(rt, r, rd, 2); Assertions.assertTrue(complete, "incomplete route 2"); } @Test void testProxyRoutes() { final HttpRouteDirector rd = BasicRouteDirector.INSTANCE; HttpRoute r = new HttpRoute(TARGET2, null, PROXY1, false); RouteTracker rt = new RouteTracker(r); boolean complete = checkVia(rt, r, rd, 2); Assertions.assertTrue(complete, "incomplete route 1"); // tunnelled, but neither secure nor layered r = new HttpRoute(TARGET1, LOCAL61, PROXY3, false, TunnelType.TUNNELLED, LayerType.PLAIN); rt = new RouteTracker(r); complete = checkVia(rt, r, rd, 3); Assertions.assertTrue(complete, "incomplete route 2"); // tunnelled, layered, but not secure r = new HttpRoute(TARGET1, LOCAL61, PROXY3, false, TunnelType.TUNNELLED, LayerType.LAYERED); rt = new RouteTracker(r); complete = checkVia(rt, r, rd, 4); Assertions.assertTrue(complete, "incomplete route 3"); // tunnelled, layered, secure r = new HttpRoute(TARGET1, LOCAL61, PROXY3, true); rt = new RouteTracker(r); complete = checkVia(rt, r, rd, 4); Assertions.assertTrue(complete, "incomplete route 4"); } @Test void testProxyChainRoutes() { final HttpRouteDirector rd = BasicRouteDirector.INSTANCE; HttpHost[] proxies = { PROXY1, PROXY2 }; HttpRoute r = new HttpRoute(TARGET2, LOCAL42, proxies, false, TunnelType.PLAIN, LayerType.PLAIN); RouteTracker rt = new RouteTracker(r); boolean complete = checkVia(rt, r, rd, 3); Assertions.assertTrue(complete, "incomplete route 1"); // tunnelled, but neither secure nor layered proxies = new HttpHost[]{PROXY3, PROXY2}; r = new HttpRoute(TARGET1, null, proxies, false, TunnelType.TUNNELLED, LayerType.PLAIN); rt = new RouteTracker(r); complete = checkVia(rt, r, rd, 4); Assertions.assertTrue(complete, "incomplete route 2"); // tunnelled, layered, but not secure proxies = new HttpHost[]{PROXY3, PROXY2, PROXY1}; r = new HttpRoute(TARGET2, LOCAL61, proxies, false, TunnelType.TUNNELLED, LayerType.LAYERED); rt = new RouteTracker(r); complete = checkVia(rt, r, rd, 6); Assertions.assertTrue(complete, "incomplete route 3"); // tunnelled, layered, secure proxies = new HttpHost[]{PROXY1, PROXY3}; r = new HttpRoute(TARGET1, LOCAL61, proxies, true, TunnelType.TUNNELLED, LayerType.LAYERED); rt = new RouteTracker(r); complete = checkVia(rt, r, rd, 5); Assertions.assertTrue(complete, "incomplete route 4"); } @Test void testEqualsHashcodeCloneToString() throws CloneNotSupportedException { final RouteTracker rt0 = new RouteTracker(TARGET1, null); final RouteTracker rt1 = new RouteTracker(TARGET2, null); final RouteTracker rt2 = new RouteTracker(TARGET1, null); final RouteTracker rt3 = new RouteTracker(TARGET1, null); final RouteTracker rt4 = new RouteTracker(TARGET1, LOCAL41); final RouteTracker rt6 = new RouteTracker(TARGET1, LOCAL62); Assertions.assertNotEquals(null, rt0, "rt0"); Assertions.assertEquals(rt0, rt0, "rt0"); Assertions.assertNotEquals("rt0", rt0, rt0.toString()); Assertions.assertNotEquals(rt0, rt4, "rt0 == rt4"); Assertions.assertNotEquals(rt0, rt1, "rt0 == rt1"); // Check host takes part in equals // Check that connection takes part in equals Assertions.assertEquals(rt0, rt2, "rt0 != rt2"); rt2.connectTarget(false); Assertions.assertNotEquals(rt0, rt2, "rt0 == rt2"); Assertions.assertEquals(rt0, rt3, "rt0 != rt3"); rt3.connectTarget(true); Assertions.assertNotEquals(rt0, rt3, "rt0 == rt3"); Assertions.assertNotEquals(rt2, rt3, "rt2 == rt3"); // Test secure takes part // TODO needs tests for tunnel and layered Assertions.assertNotEquals(rt4, rt0, "rt4 == rt0"); Assertions.assertNotEquals(rt0, rt6, "rt0 == rt6"); Assertions.assertNotEquals(rt6, rt0, "rt6 == rt0"); Assertions.assertNotEquals(rt4, rt6, "rt4 == rt6"); Assertions.assertNotEquals(rt6, rt4, "rt6 == rt4"); // it is likely but not guaranteed that the hashcodes are different Assertions.assertNotEquals(rt0.hashCode(), rt4.hashCode(), "rt0 == rt4 (hashcode)"); Assertions.assertNotEquals(rt0.hashCode(), rt6.hashCode(), "rt0 == rt6 (hashcode)"); Assertions.assertNotEquals(rt6.hashCode(), rt4.hashCode(), "rt6 == rt4 (hashcode)"); Assertions.assertEquals(rt0, rt0.clone(), "rt0 (clone)"); Assertions.assertEquals(rt4, rt4.clone(), "rt4 (clone)"); Assertions.assertEquals(rt6, rt6.clone(), "rt6 (clone)"); // we collect (clones of) the different tracked routes along the way // rt0 -> direct connection // rt1 -> via single proxy // rt2 -> via proxy chain final Set hs = new HashSet<>(); // we also collect hashcodes for the different paths // since we can't guarantee what influence the HttpHost hashcodes have, // we keep separate sets here final Set hc0 = new HashSet<>(); final Set hc4 = new HashSet<>(); final Set hc6 = new HashSet<>(); RouteTracker rt = null; Assertions.assertTrue(hs.add(rt0)); Assertions.assertTrue(hs.add(rt4)); Assertions.assertTrue(hs.add(rt6)); Assertions.assertTrue(hc0.add(rt0.hashCode())); Assertions.assertTrue(hc4.add(rt4.hashCode())); Assertions.assertTrue(hc6.add(rt6.hashCode())); rt = (RouteTracker) rt0.clone(); rt.connectTarget(false); Assertions.assertTrue(hs.add(rt)); Assertions.assertTrue(hc0.add(rt.hashCode())); rt = (RouteTracker) rt0.clone(); rt.connectTarget(true); Assertions.assertTrue(hs.add(rt)); Assertions.assertTrue(hc0.add(rt.hashCode())); // proxy (insecure) -> tunnel (insecure) -> layer (secure) rt = (RouteTracker) rt4.clone(); rt.connectProxy(PROXY1, false); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); // this is not guaranteed to be unique... Assertions.assertTrue(hc4.add(rt.hashCode())); rt.tunnelTarget(false); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); Assertions.assertTrue(hc4.add(rt.hashCode())); rt.layerProtocol(true); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); Assertions.assertTrue(hc4.add(rt.hashCode())); // proxy (secure) -> tunnel (secure) -> layer (insecure) rt = (RouteTracker) rt4.clone(); rt.connectProxy(PROXY1, true); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); // this is not guaranteed to be unique... Assertions.assertTrue(hc4.add(rt.hashCode())); rt.tunnelTarget(true); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); Assertions.assertTrue(hc4.add(rt.hashCode())); rt.layerProtocol(false); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); Assertions.assertTrue(hc4.add(rt.hashCode())); // PROXY1/i -> PROXY2/i -> tunnel/i -> layer/s rt = (RouteTracker) rt6.clone(); rt.connectProxy(PROXY1, false); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); // this is not guaranteed to be unique... Assertions.assertTrue(hc6.add(rt.hashCode())); rt.tunnelProxy(PROXY2, false); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); // this is not guaranteed to be unique... Assertions.assertTrue(hc6.add(rt.hashCode())); rt.tunnelTarget(false); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); Assertions.assertTrue(hc6.add(rt.hashCode())); rt.layerProtocol(true); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); Assertions.assertTrue(hc6.add(rt.hashCode())); // PROXY1/s -> PROXY2/s -> tunnel/s -> layer/i rt = (RouteTracker) rt6.clone(); rt.connectProxy(PROXY1, true); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); // this is not guaranteed to be unique... Assertions.assertTrue(hc6.add(rt.hashCode())); rt.tunnelProxy(PROXY2, true); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); // this is not guaranteed to be unique... Assertions.assertTrue(hc6.add(rt.hashCode())); rt.tunnelTarget(true); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); Assertions.assertTrue(hc6.add(rt.hashCode())); rt.layerProtocol(false); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); Assertions.assertTrue(hc6.add(rt.hashCode())); // PROXY2/i -> PROXY1/i -> tunnel/i -> layer/s rt = (RouteTracker) rt6.clone(); rt.connectProxy(PROXY2, false); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); // this is not guaranteed to be unique... Assertions.assertTrue(hc6.add(rt.hashCode())); rt.tunnelProxy(PROXY1, false); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); // proxy chain sequence does not affect hashcode, so duplicate: // Assertions.assertTrue(hc6.add(Integer.valueOf(rt.hashCode()))); rt.tunnelTarget(false); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); // proxy chain sequence does not affect hashcode, so duplicate: // Assertions.assertTrue(hc6.add(Integer.valueOf(rt.hashCode()))); rt.layerProtocol(true); Assertions.assertTrue(hs.add((RouteTracker) rt.clone())); // proxy chain sequence does not affect hashcode, so duplicate: // Assertions.assertTrue(hc6.add(Integer.valueOf(rt.hashCode()))); // check that all toString are OK and different final Set rtstrings = new HashSet<>(); for (final RouteTracker current : hs) { final String rts = checkToString(current); Assertions.assertTrue(rtstrings.add(rts), "duplicate toString: " + rts); } } /** Helper to check the status of the four flags. */ public final static void checkCTLS(final RouteTracker rt, final boolean c, final boolean t, final boolean l, final boolean s) { final String rts = rt.toString(); Assertions.assertEquals(c, rt.isConnected(), "wrong flag connected: " + rts); Assertions.assertEquals(t, rt.isTunnelled(), "wrong flag tunnelled: " + rts); Assertions.assertEquals(t ? TunnelType.TUNNELLED : TunnelType.PLAIN, rt.getTunnelType(), "wrong enum tunnelled: " + rts); Assertions.assertEquals(l, rt.isLayered(), "wrong flag layered: " + rts); Assertions.assertEquals(l ? LayerType.LAYERED : LayerType.PLAIN, rt.getLayerType(), "wrong enum layered: " + rts); Assertions.assertEquals(s, rt.isSecure(), "wrong flag secure: " + rts); } /** * Helper to check tracking of a route. * This uses a {@link HttpRouteDirector} to fake establishing the route, * checking the intermediate steps. * * @param rt the tracker to check with * @param r the route to establish * @param rd the director to check with * @param steps the step count for this invocation * * @return {@code true} iff the route is complete */ public final static boolean checkVia(final RouteTracker rt, final HttpRoute r, final HttpRouteDirector rd, final int steps) { final String msg = r + " @ " + rt; boolean complete = false; int n = steps; while (!complete && n > 0) { final int action = rd.nextStep(r, rt.toRoute()); switch (action) { case HttpRouteDirector.COMPLETE: complete = true; Assertions.assertEquals(r, rt.toRoute()); break; case HttpRouteDirector.CONNECT_TARGET: { final boolean sec = r.isSecure(); rt.connectTarget(sec); checkCTLS(rt, true, false, false, sec); Assertions.assertEquals(1, rt.getHopCount(), "wrong hop count " + msg); Assertions.assertEquals(r.getTargetHost(), rt.getHopTarget(0), "wrong hop0 " + msg); } break; case HttpRouteDirector.CONNECT_PROXY: { // we assume an insecure proxy connection final boolean sec = false; rt.connectProxy(r.getProxyHost(), sec); checkCTLS(rt, true, false, false, sec); Assertions.assertEquals(2, rt.getHopCount(), "wrong hop count " + msg); Assertions.assertEquals(r.getProxyHost(), rt.getHopTarget(0), "wrong hop0 " + msg); Assertions.assertEquals(r.getTargetHost(), rt.getHopTarget(1), "wrong hop1 " + msg); } break; case HttpRouteDirector.TUNNEL_TARGET: { final int hops = rt.getHopCount(); // we assume an insecure tunnel final boolean sec = false; rt.tunnelTarget(sec); checkCTLS(rt, true, true, false, sec); Assertions.assertEquals(hops, rt.getHopCount(), "wrong hop count " + msg); Assertions.assertEquals(r.getProxyHost(), rt.getHopTarget(0), "wrong hop0 " + msg); Assertions.assertEquals(r.getTargetHost(), rt.getHopTarget(hops - 1), "wrong hopN " + msg); } break; case HttpRouteDirector.TUNNEL_PROXY: { final int hops = rt.getHopCount(); // before tunnelling // we assume an insecure tunnel final boolean sec = false; final HttpHost pxy = r.getHopTarget(hops - 1); rt.tunnelProxy(pxy, sec); // Since we're tunnelling to a proxy and not the target, // the 'tunelling' flag is false: no end-to-end tunnel. checkCTLS(rt, true, false, false, sec); Assertions.assertEquals(hops + 1, rt.getHopCount(), "wrong hop count " + msg); Assertions.assertEquals(r.getProxyHost(), rt.getHopTarget(0), "wrong hop0 " + msg); Assertions.assertEquals(pxy, rt.getHopTarget(hops - 1), "wrong hop" + hops + " " + msg); Assertions.assertEquals(r.getTargetHost(), rt.getHopTarget(hops), "wrong hopN " + msg); } break; case HttpRouteDirector.LAYER_PROTOCOL: { final int hops = rt.getHopCount(); final boolean tun = rt.isTunnelled(); final boolean sec = r.isSecure(); rt.layerProtocol(sec); checkCTLS(rt, true, tun, true, sec); Assertions.assertEquals(hops, rt.getHopCount(), "wrong hop count " + msg); Assertions.assertEquals(r.getProxyHost(), rt.getProxyHost(), "wrong proxy " + msg); Assertions.assertEquals(r.getTargetHost(), rt.getTargetHost(), "wrong target " + msg); } break; // UNREACHABLE default: Assertions.fail("unexpected action " + action + " from director, " + msg); break; } // switch n--; } return complete; } // checkVia /** * Checks the output of {@code toString}. * * @param rt the tracker for which to check the output * * @return the result of {@code rt.toString()} */ public final static String checkToString(final RouteTracker rt) { if (rt == null) { return null; } final String rts = rt.toString(); if (rt.getLocalAddress() != null) { final String las = rt.getLocalAddress().toString(); Assertions.assertTrue(rts.contains(las), "no local address in toString(): " + rts); } for (int i = 0; i < rt.getHopCount(); i++) { final String hts = rt.getHopTarget(i).toString(); Assertions.assertTrue(rts.contains(hts), "hop " + i + " (" + hts + ") missing in toString(): " + rts); } return rts; } } ././@LongLink0100644 0000000 0000000 00000000145 14704162040 011631 Lustar 0000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/routing/TestSystemDefaultRoutePlanner.javahttpclient5/src/test/java/org/apache/hc/client5/http/impl/routing/TestSystemDefaultRoutePlanner.java0100664 0000000 0000000 00000010602 14704162040 032745 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.ProxySelector; import java.net.URI; import java.util.ArrayList; import java.util.List; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHost; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentMatchers; import org.mockito.Mockito; /** * Tests for {@link SystemDefaultRoutePlanner}. */ @SuppressWarnings("boxing") // test code class TestSystemDefaultRoutePlanner { private SchemePortResolver schemePortResolver; private ProxySelector proxySelector; private SystemDefaultRoutePlanner routePlanner; @BeforeEach void setup() { schemePortResolver = Mockito.mock(SchemePortResolver.class); proxySelector = Mockito.mock(ProxySelector.class); routePlanner = new SystemDefaultRoutePlanner(schemePortResolver, proxySelector); } @Test void testDirect() throws Exception { final HttpHost target = new HttpHost("http", "somehost", 80); final HttpClientContext context = HttpClientContext.create(); final HttpRoute route = routePlanner.determineRoute(target, context); Assertions.assertEquals(target, route.getTargetHost()); Assertions.assertEquals(1, route.getHopCount()); Assertions.assertFalse(route.isSecure()); Mockito.verify(schemePortResolver, Mockito.never()).resolve(ArgumentMatchers.any()); } @Test void testDirectDefaultPort() throws Exception { final HttpHost target = new HttpHost("https", "somehost", -1); Mockito.when(schemePortResolver.resolve(target)).thenReturn(443); final HttpClientContext context = HttpClientContext.create(); final HttpRoute route = routePlanner.determineRoute(target, context); Assertions.assertEquals(new HttpHost("https", "somehost", 443), route.getTargetHost()); Assertions.assertEquals(1, route.getHopCount()); Assertions.assertTrue(route.isSecure()); } @Test void testProxy() throws Exception { final InetAddress ia = InetAddress.getByAddress(new byte[] { (byte)127, (byte)0, (byte)0, (byte)1 }); final InetSocketAddress isa1 = new InetSocketAddress(ia, 11111); final InetSocketAddress isa2 = new InetSocketAddress(ia, 22222); final List proxies = new ArrayList<>(2); proxies.add(new Proxy(Proxy.Type.HTTP, isa1)); proxies.add(new Proxy(Proxy.Type.HTTP, isa2)); Mockito.when(proxySelector.select(new URI("http://somehost:80"))).thenReturn(proxies); final HttpHost target = new HttpHost("http", "somehost", 80); final HttpClientContext context = HttpClientContext.create(); final HttpRoute route = routePlanner.determineRoute(target, context); Assertions.assertEquals(target, route.getTargetHost()); Assertions.assertEquals(2, route.getHopCount()); Assertions.assertEquals(isa1.getPort(), route.getProxyHost().getPort()); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/routing/TestDefaultProxyRoutePlanner.java0100664 0000000 0000000 00000006546 14704162040 032616 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.routing; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.protocol.HttpContext; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mockito; /** * Tests for {@link DefaultProxyRoutePlanner}. */ class TestDefaultProxyRoutePlanner { private HttpHost defaultProxy; private SchemePortResolver schemePortResolver; private DefaultProxyRoutePlanner routePlanner; @BeforeEach void setup() { defaultProxy = new HttpHost("default.proxy.host", 8888); schemePortResolver = Mockito.mock(SchemePortResolver.class); routePlanner = new DefaultProxyRoutePlanner(defaultProxy, schemePortResolver); } @Test void testDefaultProxyDirect() throws Exception { final HttpHost target = new HttpHost("http", "somehost", 80); final HttpContext context = HttpClientContext.create(); final HttpRoute route = routePlanner.determineRoute(target, context); Assertions.assertEquals(target, route.getTargetHost()); Assertions.assertEquals(defaultProxy, route.getProxyHost()); Assertions.assertEquals(2, route.getHopCount()); Assertions.assertFalse(route.isSecure()); } @Test @SuppressWarnings("deprecation") void testViaProxy() throws Exception { final HttpHost target = new HttpHost("http", "somehost", 80); final HttpHost proxy = new HttpHost("custom.proxy.host", 8080); final HttpClientContext context = HttpClientContext.create(); context.setRequestConfig(RequestConfig.custom().setProxy(proxy).build()); final HttpRoute route = routePlanner.determineRoute(target, context); Assertions.assertEquals(target, route.getTargetHost()); Assertions.assertEquals(proxy, route.getProxyHost()); Assertions.assertEquals(2, route.getHopCount()); Assertions.assertFalse(route.isSecure()); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/0040775 0000000 0000000 00000000000 15063503632 024055 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestBasicResponseHandler.java0100664 0000000 0000000 00000006202 14704162040 031606 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.InputStream; import org.apache.hc.client5.http.HttpResponseException; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.StringEntity; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.mockito.Mockito; /** * Unit tests for {@link BasicHttpClientResponseHandler}. */ @SuppressWarnings("boxing") // test code class TestBasicResponseHandler { @Test void testSuccessfulResponse() throws Exception { final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); final HttpEntity entity = new StringEntity("stuff"); Mockito.when(response.getCode()).thenReturn(200); Mockito.when(response.getEntity()).thenReturn(entity); final BasicHttpClientResponseHandler handler = new BasicHttpClientResponseHandler(); final String s = handler.handleResponse(response); Assertions.assertEquals("stuff", s); } @Test void testUnsuccessfulResponse() throws Exception { final InputStream inStream = Mockito.mock(InputStream.class); final HttpEntity entity = Mockito.mock(HttpEntity.class); Mockito.when(entity.isStreaming()).thenReturn(true); Mockito.when(entity.getContent()).thenReturn(inStream); final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); Mockito.when(response.getCode()).thenReturn(404); Mockito.when(response.getEntity()).thenReturn(entity); final BasicHttpClientResponseHandler handler = new BasicHttpClientResponseHandler(); final HttpResponseException exception = Assertions.assertThrows(HttpResponseException.class, () -> handler.handleResponse(response)); Assertions.assertEquals(404, exception.getStatusCode()); Mockito.verify(entity).getContent(); Mockito.verify(inStream).close(); } } ././@LongLink0100644 0000000 0000000 00000000155 14704162040 011632 Lustar 0000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestAbstractHttpClientResponseHandler.javahttpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestAbstractHttpClientResponseHand0100664 0000000 0000000 00000011460 14704162040 032706 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InputStream; import org.apache.hc.client5.http.HttpResponseException; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.apache.hc.core5.http.io.entity.StringEntity; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.mockito.Mockito; /** * Unit tests for {@link BasicHttpClientResponseHandler}. */ class TestAbstractHttpClientResponseHandler { @Test void testSuccessfulResponse() throws Exception { final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); final HttpEntity entity = new StringEntity("42"); Mockito.when(response.getCode()).thenReturn(200); Mockito.when(response.getEntity()).thenReturn(entity); final AbstractHttpClientResponseHandler handler = new AbstractHttpClientResponseHandler() { @Override public Integer handleEntity(final HttpEntity entity) throws IOException { return Integer.valueOf(new String(EntityUtils.toByteArray(entity))); } }; final Integer number = handler.handleResponse(response); Assertions.assertEquals(42, number.intValue()); } @SuppressWarnings("boxing") @Test void testUnsuccessfulResponse() throws Exception { final InputStream inStream = Mockito.mock(InputStream.class); final HttpEntity entity = Mockito.mock(HttpEntity.class); Mockito.when(entity.isStreaming()).thenReturn(true); Mockito.when(entity.getContent()).thenReturn(inStream); final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); Mockito.when(response.getCode()).thenReturn(404); Mockito.when(response.getReasonPhrase()).thenReturn("NOT FOUND"); Mockito.when(response.getEntity()).thenReturn(entity); final BasicHttpClientResponseHandler handler = new BasicHttpClientResponseHandler(); final HttpResponseException exception = Assertions.assertThrows(HttpResponseException.class, () -> handler.handleResponse(response)); Assertions.assertEquals(404, exception.getStatusCode()); Assertions.assertEquals("NOT FOUND", exception.getReasonPhrase()); Assertions.assertEquals("status code: 404, reason phrase: NOT FOUND", exception.getMessage()); Mockito.verify(entity).getContent(); Mockito.verify(inStream).close(); } @SuppressWarnings("boxing") @Test void testUnsuccessfulResponseEmptyReason() throws Exception { final InputStream inStream = Mockito.mock(InputStream.class); final HttpEntity entity = Mockito.mock(HttpEntity.class); Mockito.when(entity.isStreaming()).thenReturn(true); Mockito.when(entity.getContent()).thenReturn(inStream); final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); Mockito.when(response.getCode()).thenReturn(404); Mockito.when(response.getEntity()).thenReturn(entity); final BasicHttpClientResponseHandler handler = new BasicHttpClientResponseHandler(); final HttpResponseException exception = Assertions.assertThrows(HttpResponseException.class, () -> handler.handleResponse(response)); Assertions.assertEquals(404, exception.getStatusCode()); Assertions.assertNull(exception.getReasonPhrase()); Assertions.assertEquals("status code: 404", exception.getMessage()); Mockito.verify(entity).getContent(); Mockito.verify(inStream).close(); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestResponseEntityProxy.java0100664 0000000 0000000 00000013607 15005672016 031620 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.ByteArrayInputStream; import java.io.InputStream; import java.util.List; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.core5.function.Supplier; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.impl.io.ChunkedInputStream; import org.apache.hc.core5.http.impl.io.SessionInputBufferImpl; import org.apache.hc.core5.http.io.SessionInputBuffer; import org.apache.hc.core5.http.io.entity.BasicHttpEntity; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; class TestResponseEntityProxy { @Mock private ClassicHttpResponse response; @Mock private ExecRuntime execRuntime; @Mock private HttpEntity entity; @BeforeEach void setUp() { MockitoAnnotations.openMocks(this); Mockito.when(entity.isStreaming()).thenReturn(Boolean.TRUE); Mockito.when(response.getEntity()).thenReturn(entity); } @Test void testGetTrailersWithNoChunkedInputStream() throws Exception { final ByteArrayInputStream inputStream = new ByteArrayInputStream("Test payload".getBytes()); Mockito.when(entity.getContent()).thenReturn(inputStream); final ArgumentCaptor httpEntityArgumentCaptor = ArgumentCaptor.forClass(HttpEntity.class); ResponseEntityProxy.enhance(response, execRuntime); Mockito.verify(response).setEntity(httpEntityArgumentCaptor.capture()); final HttpEntity wrappedEntity = httpEntityArgumentCaptor.getValue(); final InputStream is = wrappedEntity.getContent(); while (is.read() != -1) { } // read until the end final Supplier> trailers = wrappedEntity.getTrailers(); Assertions.assertTrue(trailers.get().isEmpty()); } @Test void testGetTrailersWithChunkedInputStream() throws Exception { final SessionInputBuffer sessionInputBuffer = new SessionInputBufferImpl(100); final ByteArrayInputStream inputStream = new ByteArrayInputStream("0\r\nX-Test-Trailer-Header: test\r\n".getBytes()); final ChunkedInputStream chunkedInputStream = new ChunkedInputStream(sessionInputBuffer, inputStream); Mockito.when(entity.getContent()).thenReturn(chunkedInputStream); final ArgumentCaptor httpEntityArgumentCaptor = ArgumentCaptor.forClass(HttpEntity.class); ResponseEntityProxy.enhance(response, execRuntime); Mockito.verify(response).setEntity(httpEntityArgumentCaptor.capture()); final HttpEntity wrappedEntity = httpEntityArgumentCaptor.getValue(); final InputStream is = wrappedEntity.getContent(); while (is.read() != -1) { } // consume the stream so it can reach to trailers and parse final Supplier> trailers = wrappedEntity.getTrailers(); final List headers = trailers.get(); Assertions.assertEquals(1, headers.size()); final Header header = headers.get(0); Assertions.assertEquals("X-Test-Trailer-Header", header.getName()); Assertions.assertEquals("test", header.getValue()); } @Test void testWriteToNullDrainsAndReleasesStream() throws Exception { final SessionInputBuffer sessionInputBuffer = new SessionInputBufferImpl(100); final ByteArrayInputStream inputStream = new ByteArrayInputStream("0\r\nX-Test-Trailer-Header: test\r\n".getBytes()); final ChunkedInputStream chunkedInputStream = new ChunkedInputStream(sessionInputBuffer, inputStream); final CloseableHttpResponse resp = new CloseableHttpResponse(new BasicClassicHttpResponse(200), execRuntime); final HttpEntity entity = new BasicHttpEntity(chunkedInputStream, null, true); Assertions.assertTrue(entity.isStreaming()); resp.setEntity(entity); ResponseEntityProxy.enhance(resp, execRuntime); final HttpEntity wrappedEntity = resp.getEntity(); wrappedEntity.writeTo(null); Mockito.verify(execRuntime).releaseEndpoint(); final Supplier> trailers = wrappedEntity.getTrailers(); final List headers = trailers.get(); Assertions.assertEquals(1, headers.size()); final Header header = headers.get(0); Assertions.assertEquals("X-Test-Trailer-Header", header.getName()); Assertions.assertEquals("test", header.getValue()); } }httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestHttpClientBuilder.java0100664 0000000 0000000 00000004721 14704162040 031141 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.junit.jupiter.api.Test; class TestHttpClientBuilder { @Test void testAddInterceptorFirstDoesNotThrow() throws IOException { // HTTPCLIENT-2083 HttpClients.custom() .addExecInterceptorFirst("first", NopExecChainHandler.INSTANCE) .build() .close(); } @Test void testAddInterceptorLastDoesNotThrow() throws IOException { // HTTPCLIENT-2083 HttpClients.custom() .addExecInterceptorLast("last", NopExecChainHandler.INSTANCE) .build() .close(); } enum NopExecChainHandler implements ExecChainHandler { INSTANCE; @Override public ClassicHttpResponse execute( final ClassicHttpRequest request, final ExecChain.Scope scope, final ExecChain chain) throws IOException, HttpException { return chain.proceed(request, scope); } } }httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestRedirectExec.java0100664 0000000 0000000 00000051161 14704162040 030122 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.ByteArrayInputStream; import java.io.InputStream; import java.net.URI; import java.net.URISyntaxException; import java.util.Arrays; import java.util.List; import org.apache.hc.client5.http.CircularRedirectException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RedirectException; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.entity.EntityBuilder; import org.apache.hc.client5.http.impl.DefaultRedirectStrategy; import org.apache.hc.client5.http.impl.auth.BasicScheme; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.protocol.RedirectLocations; import org.apache.hc.client5.http.protocol.RedirectStrategy; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.io.support.ClassicResponseBuilder; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; import org.mockito.ArgumentMatcher; import org.mockito.ArgumentMatchers; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; class TestRedirectExec { @Mock private HttpRoutePlanner httpRoutePlanner; @Mock private ExecChain chain; @Mock private ExecRuntime endpoint; private RedirectStrategy redirectStrategy; private RedirectExec redirectExec; private HttpHost target; @BeforeEach void setup() { MockitoAnnotations.openMocks(this); target = new HttpHost("localhost", 80); redirectStrategy = Mockito.spy(new DefaultRedirectStrategy()); redirectExec = new RedirectExec(httpRoutePlanner, redirectStrategy); } @Test void testFundamentals() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpGet request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpResponse response1 = Mockito.spy(new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY)); final URI redirect = new URI("http://localhost:80/redirect"); response1.setHeader(HttpHeaders.LOCATION, redirect.toASCIIString()); final InputStream inStream1 = Mockito.spy(new ByteArrayInputStream(new byte[] {1, 2, 3})); final HttpEntity entity1 = EntityBuilder.create() .setStream(inStream1) .build(); response1.setEntity(entity1); final ClassicHttpResponse response2 = Mockito.spy(new BasicClassicHttpResponse(HttpStatus.SC_OK)); final InputStream inStream2 = Mockito.spy(new ByteArrayInputStream(new byte[] {1, 2, 3})); final HttpEntity entity2 = EntityBuilder.create() .setStream(inStream2) .build(); response2.setEntity(entity2); Mockito.when(chain.proceed( ArgumentMatchers.same(request), ArgumentMatchers.any())).thenReturn(response1); Mockito.when(chain.proceed( HttpRequestMatcher.matchesRequestUri(redirect), ArgumentMatchers.any())).thenReturn(response2); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); redirectExec.execute(request, scope, chain); final ArgumentCaptor reqCaptor = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(chain, Mockito.times(2)).proceed(reqCaptor.capture(), ArgumentMatchers.any()); final List allValues = reqCaptor.getAllValues(); Assertions.assertNotNull(allValues); Assertions.assertEquals(2, allValues.size()); Assertions.assertSame(request, allValues.get(0)); Mockito.verify(response1, Mockito.times(1)).close(); Mockito.verify(inStream1, Mockito.times(2)).close(); Mockito.verify(response2, Mockito.never()).close(); Mockito.verify(inStream2, Mockito.never()).close(); } @Test void testMaxRedirect() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpGet request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final RequestConfig config = RequestConfig.custom() .setRedirectsEnabled(true) .setMaxRedirects(3) .build(); context.setRequestConfig(config); final ClassicHttpResponse response1 = Mockito.spy(new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY)); final URI redirect = new URI("http://localhost:80/redirect"); response1.setHeader(HttpHeaders.LOCATION, redirect.toASCIIString()); Mockito.when(chain.proceed(ArgumentMatchers.any(), ArgumentMatchers.any())).thenReturn(response1); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); Assertions.assertThrows(RedirectException.class, () -> redirectExec.execute(request, scope, chain)); } @Test void testRelativeRedirect() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpGet request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpResponse response1 = Mockito.spy(new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY)); final URI redirect = new URI("/redirect"); response1.setHeader(HttpHeaders.LOCATION, redirect.toASCIIString()); Mockito.when(chain.proceed( ArgumentMatchers.same(request), ArgumentMatchers.any())).thenReturn(response1); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); Assertions.assertThrows(HttpException.class, () -> redirectExec.execute(request, scope, chain)); } @Test void testCrossSiteRedirect() throws Exception { final HttpHost proxy = new HttpHost("proxy"); final HttpRoute route = new HttpRoute(target, proxy); final HttpGet request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final AuthExchange targetAuthExchange = new AuthExchange(); targetAuthExchange.setState(AuthExchange.State.SUCCESS); targetAuthExchange.select(new BasicScheme()); final AuthExchange proxyAuthExchange = new AuthExchange(); proxyAuthExchange.setState(AuthExchange.State.SUCCESS); proxyAuthExchange.select(new BasicScheme() { @Override public boolean isConnectionBased() { return true; } }); context.setAuthExchange(target, targetAuthExchange); context.setAuthExchange(proxy, proxyAuthExchange); final ClassicHttpResponse response1 = Mockito.spy(new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY)); final URI redirect = new URI("http://otherhost:8888/redirect"); response1.setHeader(HttpHeaders.LOCATION, redirect.toASCIIString()); final ClassicHttpResponse response2 = Mockito.spy(new BasicClassicHttpResponse(HttpStatus.SC_OK)); final HttpHost otherHost = new HttpHost("otherhost", 8888); Mockito.when(chain.proceed( ArgumentMatchers.same(request), ArgumentMatchers.any())).thenReturn(response1); Mockito.when(chain.proceed( HttpRequestMatcher.matchesRequestUri(redirect), ArgumentMatchers.any())).thenReturn(response2); Mockito.when(httpRoutePlanner.determineRoute( ArgumentMatchers.eq(otherHost), ArgumentMatchers.any())).thenReturn(new HttpRoute(otherHost)); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); redirectExec.execute(request, scope, chain); final AuthExchange authExchange1 = context.getAuthExchange(target); Assertions.assertNotNull(authExchange1); Assertions.assertEquals(AuthExchange.State.UNCHALLENGED, authExchange1.getState()); Assertions.assertNull(authExchange1.getAuthScheme()); final AuthExchange authExchange2 = context.getAuthExchange(proxy); Assertions.assertNotNull(authExchange2); Assertions.assertEquals(AuthExchange.State.UNCHALLENGED, authExchange2.getState()); Assertions.assertNull(authExchange2.getAuthScheme()); } @Test void testAllowCircularRedirects() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); context.setRequestConfig(RequestConfig.custom() .setCircularRedirectsAllowed(true) .build()); final URI uri = URI.create("http://localhost/"); final HttpGet request = new HttpGet(uri); final URI uri1 = URI.create("http://localhost/stuff1"); final URI uri2 = URI.create("http://localhost/stuff2"); final ClassicHttpResponse response1 = new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY); response1.addHeader("Location", uri1.toASCIIString()); final ClassicHttpResponse response2 = new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY); response2.addHeader("Location", uri2.toASCIIString()); final ClassicHttpResponse response3 = new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY); response3.addHeader("Location", uri1.toASCIIString()); final ClassicHttpResponse response4 = new BasicClassicHttpResponse(HttpStatus.SC_OK); Mockito.when(chain.proceed( HttpRequestMatcher.matchesRequestUri(uri), ArgumentMatchers.any())).thenReturn(response1); Mockito.when(chain.proceed( HttpRequestMatcher.matchesRequestUri(uri1), ArgumentMatchers.any())).thenReturn(response2, response4); Mockito.when(chain.proceed( HttpRequestMatcher.matchesRequestUri(uri2), ArgumentMatchers.any())).thenReturn(response3); Mockito.when(httpRoutePlanner.determineRoute( ArgumentMatchers.eq(new HttpHost("localhost")), ArgumentMatchers.any())).thenReturn(route); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); redirectExec.execute(request, scope, chain); final RedirectLocations uris = context.getRedirectLocations(); Assertions.assertNotNull(uris); Assertions.assertEquals(Arrays.asList(uri1, uri2, uri1), uris.getAll()); } @Test void testGetLocationUriDisallowCircularRedirects() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); context.setRequestConfig(RequestConfig.custom() .setCircularRedirectsAllowed(false) .build()); final URI uri = URI.create("http://localhost/"); final HttpGet request = new HttpGet(uri); final URI uri1 = URI.create("http://localhost/stuff1"); final URI uri2 = URI.create("http://localhost/stuff2"); final ClassicHttpResponse response1 = new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY); response1.addHeader("Location", uri1.toASCIIString()); final ClassicHttpResponse response2 = new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY); response2.addHeader("Location", uri2.toASCIIString()); final ClassicHttpResponse response3 = new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY); response3.addHeader("Location", uri1.toASCIIString()); Mockito.when(httpRoutePlanner.determineRoute( ArgumentMatchers.eq(new HttpHost("localhost")), ArgumentMatchers.any())).thenReturn(route); Mockito.when(chain.proceed( HttpRequestMatcher.matchesRequestUri(uri), ArgumentMatchers.any())).thenReturn(response1); Mockito.when(chain.proceed( HttpRequestMatcher.matchesRequestUri(uri1), ArgumentMatchers.any())).thenReturn(response2); Mockito.when(chain.proceed( HttpRequestMatcher.matchesRequestUri(uri2), ArgumentMatchers.any())).thenReturn(response3); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); Assertions.assertThrows(CircularRedirectException.class, () -> redirectExec.execute(request, scope, chain)); } @Test void testRedirectRuntimeException() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpGet request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpResponse response1 = Mockito.spy(new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY)); final URI redirect = new URI("http://localhost:80/redirect"); response1.setHeader(HttpHeaders.LOCATION, redirect.toASCIIString()); Mockito.when(chain.proceed( ArgumentMatchers.same(request), ArgumentMatchers.any())).thenReturn(response1); Mockito.doThrow(new RuntimeException("Oppsie")).when(redirectStrategy).getLocationURI( ArgumentMatchers.any(), ArgumentMatchers.any(), ArgumentMatchers.any()); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); Assertions.assertThrows(RuntimeException.class, () -> redirectExec.execute(request, scope, chain)); Mockito.verify(response1).close(); } @Test void testRedirectProtocolException() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpGet request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpResponse response1 = Mockito.spy(new BasicClassicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY)); final URI redirect = new URI("http://localhost:80/redirect"); response1.setHeader(HttpHeaders.LOCATION, redirect.toASCIIString()); final InputStream inStream1 = Mockito.spy(new ByteArrayInputStream(new byte[] {1, 2, 3})); final HttpEntity entity1 = EntityBuilder.create() .setStream(inStream1) .build(); response1.setEntity(entity1); Mockito.when(chain.proceed( ArgumentMatchers.same(request), ArgumentMatchers.any())).thenReturn(response1); Mockito.doThrow(new ProtocolException("Oppsie")).when(redirectStrategy).getLocationURI( ArgumentMatchers.any(), ArgumentMatchers.any(), ArgumentMatchers.any()); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); Assertions.assertThrows(ProtocolException.class, () -> redirectExec.execute(request, scope, chain)); Mockito.verify(inStream1, Mockito.times(2)).close(); Mockito.verify(response1).close(); } @Test void testPutSeeOtherRedirect() throws Exception { final HttpRoute route = new HttpRoute(target); final URI targetUri = new URI("http://localhost:80/stuff"); final ClassicHttpRequest request = ClassicRequestBuilder.put() .setUri(targetUri) .setEntity("stuff") .build(); final HttpClientContext context = HttpClientContext.create(); final URI redirect1 = new URI("http://localhost:80/see-something-else"); final ClassicHttpResponse response1 = ClassicResponseBuilder.create(HttpStatus.SC_SEE_OTHER) .addHeader(HttpHeaders.LOCATION, redirect1.toASCIIString()) .build(); final URI redirect2 = new URI("http://localhost:80/other-stuff"); final ClassicHttpResponse response2 = ClassicResponseBuilder.create(HttpStatus.SC_MOVED_PERMANENTLY) .addHeader(HttpHeaders.LOCATION, redirect2.toASCIIString()) .build(); final ClassicHttpResponse response3 = ClassicResponseBuilder.create(HttpStatus.SC_OK) .build(); Mockito.when(chain.proceed( HttpRequestMatcher.matchesRequestUri(targetUri), ArgumentMatchers.any())).thenReturn(response1); Mockito.when(chain.proceed( HttpRequestMatcher.matchesRequestUri(redirect1), ArgumentMatchers.any())).thenReturn(response2); Mockito.when(chain.proceed( HttpRequestMatcher.matchesRequestUri(redirect2), ArgumentMatchers.any())).thenReturn(response3); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); final ClassicHttpResponse finalResponse = redirectExec.execute(request, scope, chain); Assertions.assertEquals(200, finalResponse.getCode()); final ArgumentCaptor reqCaptor = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(chain, Mockito.times(3)).proceed(reqCaptor.capture(), ArgumentMatchers.any()); final List allValues = reqCaptor.getAllValues(); Assertions.assertNotNull(allValues); Assertions.assertEquals(3, allValues.size()); final ClassicHttpRequest request1 = allValues.get(0); final ClassicHttpRequest request2 = allValues.get(1); final ClassicHttpRequest request3 = allValues.get(2); Assertions.assertSame(request, request1); Assertions.assertEquals("PUT", request1.getMethod()); Assertions.assertEquals("GET", request2.getMethod()); Assertions.assertEquals("GET", request3.getMethod()); } private static class HttpRequestMatcher implements ArgumentMatcher { private final URI expectedRequestUri; HttpRequestMatcher(final URI requestUri) { super(); this.expectedRequestUri = requestUri; } @Override public boolean matches(final ClassicHttpRequest argument) { if (argument == null) { return false; } try { final URI requestUri = argument.getUri(); return this.expectedRequestUri.equals(requestUri); } catch (final URISyntaxException ex) { return false; } } static ClassicHttpRequest matchesRequestUri(final URI requestUri) { return ArgumentMatchers.argThat(new HttpRequestMatcher(requestUri)); } } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestConnectExec.java0100664 0000000 0000000 00000037243 14744133027 027766 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.ByteArrayInputStream; import java.io.InputStream; import java.util.Collections; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.RouteInfo; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.entity.EntityBuilder; import org.apache.hc.client5.http.impl.auth.BasicScheme; import org.apache.hc.client5.http.impl.auth.CredentialsProviderBuilder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; import org.mockito.stubbing.Answer; @SuppressWarnings({"boxing","static-access"}) // test code class TestConnectExec { @Mock private ConnectionReuseStrategy reuseStrategy; @Mock private HttpProcessor proxyHttpProcessor; @Mock private AuthenticationStrategy proxyAuthStrategy; @Mock private ExecRuntime execRuntime; @Mock private ExecChain execChain; private ConnectExec exec; private HttpHost target; private HttpHost proxy; @BeforeEach void setup() { MockitoAnnotations.openMocks(this); exec = new ConnectExec(reuseStrategy, proxyHttpProcessor, proxyAuthStrategy, null, true); target = new HttpHost("foo", 80); proxy = new HttpHost("bar", 8888); } @Test void testExecAcquireConnection() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); try (final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK")) { response.setEntity(EntityBuilder.create() .setStream(new ByteArrayInputStream(new byte[]{})) .build()); } context.setUserToken("Blah"); Mockito.when(execRuntime.isEndpointAcquired()).thenReturn(false); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); exec.execute(request, scope, execChain); Mockito.verify(execRuntime).acquireEndpoint("test", route, "Blah", context); Mockito.verify(execRuntime).connectEndpoint(context); } @Test void testEstablishDirectRoute() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ConnectionState connectionState = new ConnectionState(); Mockito.doAnswer(connectionState.connectAnswer()).when(execRuntime).connectEndpoint(Mockito.any()); Mockito.when(execRuntime.isEndpointConnected()).thenAnswer(connectionState.isConnectedAnswer()); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); exec.execute(request, scope, execChain); Mockito.verify(execRuntime).connectEndpoint(context); Mockito.verify(execRuntime, Mockito.never()).execute( Mockito.anyString(), Mockito.any(), Mockito.any()); } @Test void testEstablishRouteDirectProxy() throws Exception { final HttpRoute route = new HttpRoute(target, null, proxy, false); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ConnectionState connectionState = new ConnectionState(); Mockito.doAnswer(connectionState.connectAnswer()).when(execRuntime).connectEndpoint(Mockito.any()); Mockito.when(execRuntime.isEndpointConnected()).thenAnswer(connectionState.isConnectedAnswer()); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); exec.execute(request, scope, execChain); Mockito.verify(execRuntime).connectEndpoint(context); Mockito.verify(execRuntime, Mockito.never()).execute( Mockito.anyString(), Mockito.any(), Mockito.any()); } @Test void testEstablishRouteViaProxyTunnel() throws Exception { final HttpRoute route = new HttpRoute(target, null, proxy, true); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); final ConnectionState connectionState = new ConnectionState(); Mockito.doAnswer(connectionState.connectAnswer()).when(execRuntime).connectEndpoint(Mockito.any()); Mockito.when(execRuntime.isEndpointConnected()).thenAnswer(connectionState.isConnectedAnswer()); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.any(), Mockito.any())).thenReturn(response); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); exec.execute(request, scope, execChain); Mockito.verify(execRuntime).connectEndpoint(context); final ArgumentCaptor reqCaptor = ArgumentCaptor.forClass(ClassicHttpRequest.class); Mockito.verify(execRuntime).execute( Mockito.anyString(), reqCaptor.capture(), Mockito.same(context)); final HttpRequest connect = reqCaptor.getValue(); Assertions.assertNotNull(connect); Assertions.assertEquals("CONNECT", connect.getMethod()); Assertions.assertEquals(HttpVersion.HTTP_1_1, connect.getVersion()); Assertions.assertEquals("foo:80", connect.getRequestUri()); } @Test void testEstablishRouteViaProxyTunnelUnexpectedResponse() throws Exception { final HttpRoute route = new HttpRoute(target, null, proxy, true); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ClassicHttpResponse response = new BasicClassicHttpResponse(101, "Lost"); final ConnectionState connectionState = new ConnectionState(); Mockito.doAnswer(connectionState.connectAnswer()).when(execRuntime).connectEndpoint(Mockito.any()); Mockito.when(execRuntime.isEndpointConnected()).thenAnswer(connectionState.isConnectedAnswer()); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.any(), Mockito.any())).thenReturn(response); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); Assertions.assertThrows(HttpException.class, () -> exec.execute(request, scope, execChain)); } @Test void testEstablishRouteViaProxyTunnelFailure() throws Exception { final HttpRoute route = new HttpRoute(target, null, proxy, true); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ClassicHttpResponse response = new BasicClassicHttpResponse(500, "Boom"); response.setEntity(new StringEntity("Ka-boom")); final ConnectionState connectionState = new ConnectionState(); Mockito.doAnswer(connectionState.connectAnswer()).when(execRuntime).connectEndpoint(Mockito.any()); Mockito.when(execRuntime.isEndpointConnected()).thenAnswer(connectionState.isConnectedAnswer()); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.any(), Mockito.any())).thenReturn(response); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); exec.execute(request, scope, execChain); Mockito.verify(execRuntime, Mockito.atLeastOnce()).discardEndpoint(); } @Test void testEstablishRouteViaProxyTunnelRetryOnAuthChallengePersistentConnection() throws Exception { final HttpRoute route = new HttpRoute(target, null, proxy, true); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ClassicHttpResponse response1 = new BasicClassicHttpResponse(407, "Huh?"); response1.setHeader(HttpHeaders.PROXY_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=test"); final InputStream inStream1 = Mockito.spy(new ByteArrayInputStream(new byte[] {1, 2, 3})); response1.setEntity(EntityBuilder.create() .setStream(inStream1) .build()); final ClassicHttpResponse response2 = new BasicClassicHttpResponse(200, "OK"); context.setCredentialsProvider(CredentialsProviderBuilder.create() .add(new AuthScope(proxy), "user", "pass".toCharArray()) .build()); final ConnectionState connectionState = new ConnectionState(); Mockito.doAnswer(connectionState.connectAnswer()).when(execRuntime).connectEndpoint(Mockito.any()); Mockito.when(execRuntime.isEndpointConnected()).thenAnswer(connectionState.isConnectedAnswer()); Mockito.when(reuseStrategy.keepAlive( Mockito.any(), Mockito.any(), Mockito.any())).thenReturn(Boolean.TRUE); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.any(), Mockito.any())).thenReturn(response1, response2); Mockito.when(proxyAuthStrategy.select( Mockito.eq(ChallengeType.PROXY), Mockito.any(), Mockito.any())).thenReturn(Collections.singletonList(new BasicScheme())); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); exec.execute(request, scope, execChain); Mockito.verify(execRuntime).connectEndpoint(context); Mockito.verify(inStream1).close(); } @Test void testEstablishRouteViaProxyTunnelRetryOnAuthChallengeNonPersistentConnection() throws Exception { final HttpRoute route = new HttpRoute(target, null, proxy, true); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ClassicHttpResponse response1 = new BasicClassicHttpResponse(407, "Huh?"); response1.setHeader(HttpHeaders.PROXY_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=test"); final InputStream inStream1 = Mockito.spy(new ByteArrayInputStream(new byte[] {1, 2, 3})); response1.setEntity(EntityBuilder.create() .setStream(inStream1) .build()); final ClassicHttpResponse response2 = new BasicClassicHttpResponse(200, "OK"); final CredentialsProvider credentialsProvider = CredentialsProviderBuilder.create() .add(new AuthScope(proxy), "user", "pass".toCharArray()) .build(); context.setCredentialsProvider(credentialsProvider); final ConnectionState connectionState = new ConnectionState(); Mockito.doAnswer(connectionState.connectAnswer()).when(execRuntime).connectEndpoint(Mockito.any()); Mockito.when(execRuntime.isEndpointConnected()).thenAnswer(connectionState.isConnectedAnswer()); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.any(), Mockito.any())).thenReturn(response1, response2); Mockito.when(proxyAuthStrategy.select( Mockito.eq(ChallengeType.PROXY), Mockito.any(), Mockito.any())).thenReturn(Collections.singletonList(new BasicScheme())); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); exec.execute(request, scope, execChain); Mockito.verify(execRuntime).connectEndpoint(context); Mockito.verify(inStream1, Mockito.never()).close(); Mockito.verify(execRuntime, Mockito.atLeastOnce()).disconnectEndpoint(); } @Test void testEstablishRouteViaProxyTunnelMultipleHops() throws Exception { final HttpHost proxy1 = new HttpHost("this", 8888); final HttpHost proxy2 = new HttpHost("that", 8888); final HttpRoute route = new HttpRoute(target, null, new HttpHost[] {proxy1, proxy2}, true, RouteInfo.TunnelType.TUNNELLED, RouteInfo.LayerType.LAYERED); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ConnectionState connectionState = new ConnectionState(); Mockito.doAnswer(connectionState.connectAnswer()).when(execRuntime).connectEndpoint(Mockito.any()); Mockito.when(execRuntime.isEndpointConnected()).thenAnswer(connectionState.isConnectedAnswer()); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); Assertions.assertThrows(HttpException.class, () -> exec.execute(request, scope, execChain)); } static class ConnectionState { private boolean connected; public Answer connectAnswer() { return invocationOnMock -> { connected = true; return null; }; } public Answer isConnectedAnswer() { return invocationOnMock -> connected; } } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestNullBackoffStrategy.java0100664 0000000 0000000 00000003736 14704162040 031472 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import static org.junit.jupiter.api.Assertions.assertFalse; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestNullBackoffStrategy { private NullBackoffStrategy impl; @BeforeEach void setUp() { impl = new NullBackoffStrategy(); } @Test void doesNotBackoffForThrowables() { assertFalse(impl.shouldBackoff(new Exception())); } @Test void doesNotBackoffForResponses() { final HttpResponse resp = new BasicHttpResponse(HttpStatus.SC_SERVICE_UNAVAILABLE, "Service Unavailable"); assertFalse(impl.shouldBackoff(resp)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestProtocolExec.java0100664 0000000 0000000 00000031214 14704162040 030157 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; import java.util.Collections; import org.apache.hc.client5.http.AuthenticationStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.auth.AuthExchange; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.entity.EntityBuilder; import org.apache.hc.client5.http.impl.auth.BasicScheme; import org.apache.hc.client5.http.impl.auth.CredentialsProviderBuilder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; import org.mockito.stubbing.Answer; @SuppressWarnings({"static-access"}) // test code class TestProtocolExec { @Mock private AuthenticationStrategy targetAuthStrategy; @Mock private AuthenticationStrategy proxyAuthStrategy; @Mock private ExecChain chain; @Mock private ExecRuntime execRuntime; private ProtocolExec protocolExec; private HttpHost target; private HttpHost proxy; @BeforeEach void setup() { MockitoAnnotations.openMocks(this); protocolExec = new ProtocolExec(targetAuthStrategy, proxyAuthStrategy, null, true); target = new HttpHost("foo", 80); proxy = new HttpHost("bar", 8888); } @Test void testUserInfoInRequestURI() { final HttpRoute route = new HttpRoute(new HttpHost("somehost", 8080)); final ClassicHttpRequest request = new HttpGet("http://somefella:secret@bar/test"); final HttpClientContext context = HttpClientContext.create(); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); Assertions.assertThrows(ProtocolException.class, () -> protocolExec.execute(request, scope, chain)); } @Test void testPostProcessHttpException() throws Exception { final HttpRoute route = new HttpRoute(target); final ClassicHttpRequest request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); Mockito.when(chain.proceed( Mockito.any(), Mockito.any())).thenReturn(response); Mockito.doThrow(new HttpException("Ooopsie")).when(chain).proceed(Mockito.any(), Mockito.any()); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); Assertions.assertThrows(HttpException.class, () -> protocolExec.execute(request, scope, chain)); Mockito.verify(execRuntime).discardEndpoint(); } @Test void testPostProcessIOException() throws Exception { final HttpRoute route = new HttpRoute(target); final ClassicHttpRequest request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); Mockito.when(chain.proceed( Mockito.any(), Mockito.any())).thenReturn(response); Mockito.doThrow(new IOException("Ooopsie")).when(chain).proceed(Mockito.any(), Mockito.any()); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); Assertions.assertThrows(IOException.class, () -> protocolExec.execute(request, scope, chain)); Mockito.verify(execRuntime).discardEndpoint(); } @Test void testPostProcessRuntimeException() throws Exception { final HttpRoute route = new HttpRoute(target); final ClassicHttpRequest request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); Mockito.when(chain.proceed( Mockito.any(), Mockito.any())).thenReturn(response); Mockito.doThrow(new RuntimeException("Ooopsie")).when(chain).proceed(Mockito.any(), Mockito.any()); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); Assertions.assertThrows(RuntimeException.class, () -> protocolExec.execute(request, scope, chain)); Mockito.verify(execRuntime).discardEndpoint(); } @Test void testExecRequestRetryOnAuthChallenge() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://foo/test"); final ClassicHttpResponse response1 = new BasicClassicHttpResponse(401, "Huh?"); response1.setHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=test"); final InputStream inStream1 = Mockito.spy(new ByteArrayInputStream(new byte[] {1, 2, 3})); response1.setEntity(EntityBuilder.create() .setStream(inStream1) .build()); final ClassicHttpResponse response2 = new BasicClassicHttpResponse(200, "OK"); final InputStream inStream2 = Mockito.spy(new ByteArrayInputStream(new byte[] {2, 3, 4})); response2.setEntity(EntityBuilder.create() .setStream(inStream2) .build()); context.setCredentialsProvider(CredentialsProviderBuilder.create() .add(new AuthScope(target), "user", "pass".toCharArray()) .build()); Mockito.when(chain.proceed( Mockito.same(request), Mockito.any())).thenReturn(response1, response2); Mockito.when(targetAuthStrategy.select( Mockito.eq(ChallengeType.TARGET), Mockito.any(), Mockito.any())).thenReturn(Collections.singletonList(new BasicScheme())); Mockito.when(execRuntime.isConnectionReusable()).thenReturn(true); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); final ClassicHttpResponse finalResponse = protocolExec.execute(request, scope, chain); Mockito.verify(chain, Mockito.times(2)).proceed(request, scope); Mockito.verify(inStream1).close(); Mockito.verify(inStream2, Mockito.never()).close(); Assertions.assertNotNull(finalResponse); Assertions.assertEquals(200, finalResponse.getCode()); } @Test void testExecEntityEnclosingRequestRetryOnAuthChallenge() throws Exception { final HttpRoute route = new HttpRoute(target); final ClassicHttpRequest request = new HttpGet("http://foo/test"); final ClassicHttpResponse response1 = new BasicClassicHttpResponse(401, "Huh?"); response1.setHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=test"); final InputStream inStream1 = Mockito.spy(new ByteArrayInputStream(new byte[] {1, 2, 3})); response1.setEntity(EntityBuilder.create() .setStream(inStream1) .build()); final ClassicHttpResponse response2 = new BasicClassicHttpResponse(200, "OK"); final InputStream inStream2 = Mockito.spy(new ByteArrayInputStream(new byte[] {2, 3, 4})); response2.setEntity(EntityBuilder.create() .setStream(inStream2) .build()); final HttpClientContext context = HttpClientContext.create(); final AuthExchange authExchange = new AuthExchange(); authExchange.setState(AuthExchange.State.SUCCESS); authExchange.select(new BasicScheme() { @Override public boolean isConnectionBased() { return true; } }); context.setAuthExchange(target, authExchange); context.setCredentialsProvider(CredentialsProviderBuilder.create() .add(new AuthScope(target), "user", "pass".toCharArray()) .build()); Mockito.when(chain.proceed( Mockito.same(request), Mockito.any())).thenReturn(response1, response2); Mockito.when(targetAuthStrategy.select( Mockito.eq(ChallengeType.TARGET), Mockito.any(), Mockito.any())).thenReturn(Collections.singletonList(new BasicScheme())); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); final ClassicHttpResponse finalResponse = protocolExec.execute(request, scope, chain); Mockito.verify(chain, Mockito.times(2)).proceed(request, scope); Mockito.verify(execRuntime).disconnectEndpoint(); Mockito.verify(inStream2, Mockito.never()).close(); Assertions.assertNotNull(finalResponse); Assertions.assertEquals(200, finalResponse.getCode()); Assertions.assertNotNull(authExchange.getAuthScheme()); } @Test void testExecEntityEnclosingRequest() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final HttpPost request = new HttpPost("http://foo/test"); final InputStream inStream0 = new ByteArrayInputStream(new byte[] {1, 2, 3}); request.setEntity(EntityBuilder.create() .setStream(inStream0) .build()); final ClassicHttpResponse response1 = new BasicClassicHttpResponse(401, "Huh?"); response1.setHeader(HttpHeaders.WWW_AUTHENTICATE, StandardAuthScheme.BASIC + " realm=test"); final InputStream inStream1 = new ByteArrayInputStream(new byte[] {1, 2, 3}); response1.setEntity(EntityBuilder.create() .setStream(inStream1) .build()); context.setCredentialsProvider(CredentialsProviderBuilder.create() .add(new AuthScope(target), "user", "pass".toCharArray()) .build()); Mockito.when(chain.proceed( Mockito.same(request), Mockito.any())).thenAnswer((Answer) invocationOnMock -> { final Object[] args = invocationOnMock.getArguments(); final ClassicHttpRequest requestEE = (ClassicHttpRequest) args[0]; requestEE.getEntity().writeTo(new ByteArrayOutputStream()); return response1; }); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); final ClassicHttpResponse response = protocolExec.execute(request, scope, chain); Assertions.assertEquals(401, response.getCode()); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestResponseEntityWrapper.java0100664 0000000 0000000 00000012571 14704162040 032112 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.net.SocketException; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.io.entity.EntityUtils; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mockito; @SuppressWarnings("boxing") // test code class TestResponseEntityWrapper { private InputStream inStream; private HttpEntity entity; private ExecRuntime execRuntime; private ResponseEntityProxy wrapper; @BeforeEach void setup() throws Exception { inStream = Mockito.mock(InputStream.class); entity = Mockito.mock(HttpEntity.class); Mockito.when(entity.getContent()).thenReturn(inStream); execRuntime = Mockito.mock(ExecRuntime.class); wrapper = new ResponseEntityProxy(entity, execRuntime); } @Test void testReusableEntityStreamClosed() throws Exception { Mockito.when(entity.isStreaming()).thenReturn(true); Mockito.when(execRuntime.isConnectionReusable()).thenReturn(true); EntityUtils.consume(wrapper); Mockito.verify(inStream, Mockito.times(1)).close(); Mockito.verify(execRuntime).releaseEndpoint(); } @Test void testReusableEntityStreamClosedIOError() throws Exception { Mockito.when(entity.isStreaming()).thenReturn(true); Mockito.when(execRuntime.isConnectionReusable()).thenReturn(true); Mockito.doThrow(new IOException()).when(inStream).close(); Assertions.assertThrows(IOException.class, () -> EntityUtils.consume(wrapper)); Mockito.verify(execRuntime, Mockito.atLeast(1)).discardEndpoint(); } @Test void testEntityStreamClosedIOErrorAlreadyReleased() throws Exception { Mockito.when(entity.isStreaming()).thenReturn(true); Mockito.when(execRuntime.isConnectionReusable()).thenReturn(true); Mockito.when(execRuntime.isEndpointAcquired()).thenReturn(false); Mockito.doThrow(new SocketException()).when(inStream).close(); EntityUtils.consume(wrapper); Mockito.verify(execRuntime).discardEndpoint(); } @Test void testReusableEntityWriteTo() throws Exception { final OutputStream outStream = Mockito.mock(OutputStream.class); Mockito.when(entity.isStreaming()).thenReturn(true); Mockito.when(execRuntime.isConnectionReusable()).thenReturn(true); wrapper.writeTo(outStream); Mockito.verify(execRuntime).releaseEndpoint(); } @Test void testReusableEntityWriteToIOError() throws Exception { final OutputStream outStream = Mockito.mock(OutputStream.class); Mockito.when(entity.isStreaming()).thenReturn(true); Mockito.when(execRuntime.isConnectionReusable()).thenReturn(true); Mockito.doThrow(new IOException()).when(entity).writeTo(outStream); Assertions.assertThrows(IOException.class, () -> wrapper.writeTo(outStream)); Mockito.verify(execRuntime, Mockito.never()).releaseEndpoint(); Mockito.verify(execRuntime, Mockito.atLeast(1)).discardEndpoint(); } @Test void testReusableEntityEndOfStream() throws Exception { Mockito.when(inStream.read()).thenReturn(-1); Mockito.when(entity.isStreaming()).thenReturn(true); Mockito.when(execRuntime.isConnectionReusable()).thenReturn(true); final InputStream content = wrapper.getContent(); Assertions.assertEquals(-1, content.read()); Mockito.verify(inStream).close(); Mockito.verify(execRuntime).releaseEndpoint(); } @Test void testReusableEntityEndOfStreamIOError() throws Exception { Mockito.when(inStream.read()).thenReturn(-1); Mockito.when(entity.isStreaming()).thenReturn(true); Mockito.when(execRuntime.isConnectionReusable()).thenReturn(true); Mockito.doThrow(new IOException()).when(inStream).close(); final InputStream content = wrapper.getContent(); Assertions.assertThrows(IOException.class, () -> content.read()); Mockito.verify(execRuntime, Mockito.atLeast(1)).discardEndpoint(); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestProxyClient.java0100664 0000000 0000000 00000012237 14704162040 030035 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import 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.fail; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; import java.io.IOException; import java.net.Socket; import org.apache.hc.client5.http.auth.Credentials; import org.apache.hc.client5.http.auth.UsernamePasswordCredentials; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.junit.jupiter.api.Test; class TestProxyClient { @Test void testTunnelWithInvalidPort() throws IOException { // Mock dependencies final HttpConnectionFactory connFactory = mock(HttpConnectionFactory.class); final ManagedHttpClientConnection managedConnection = mock(ManagedHttpClientConnection.class); when(connFactory.createConnection(null)).thenReturn(managedConnection); final HttpRequestExecutor requestExecutor = mock(HttpRequestExecutor.class); final ClassicHttpResponse response = mock(ClassicHttpResponse.class); when(response.getCode()).thenReturn(200); try { when(requestExecutor.execute(any(), any(), any())).thenReturn(response); } catch (final IOException | HttpException e) { fail("Shouldn't fail"); } final RequestConfig requestConfig = RequestConfig.DEFAULT; final ProxyClient client = new ProxyClient(connFactory, null, null, requestConfig); final HttpHost proxy = new HttpHost("proxy.example.com", 8080); final HttpHost target = new HttpHost("target.example.com", -1); // Invalid port final Credentials credentials = new UsernamePasswordCredentials("user", "pass".toCharArray()); assertThrows(IllegalArgumentException.class, () -> client.tunnel(proxy, target, credentials)); } @Test void testSuccessfulTunnel() throws IOException, HttpException { // Mock dependencies final HttpConnectionFactory connFactory = mock(HttpConnectionFactory.class); final ManagedHttpClientConnection managedConnection = mock(ManagedHttpClientConnection.class); when(managedConnection.isOpen()).thenReturn(true); // Always return true for isOpen() when(connFactory.createConnection(null)).thenReturn(managedConnection); final ClassicHttpResponse mockResponse = mock(ClassicHttpResponse.class); when(mockResponse.getCode()).thenReturn(200); // Successful response when(managedConnection.receiveResponseHeader()).thenReturn(mockResponse); final HttpRequestExecutor mockRequestExecutor = mock(HttpRequestExecutor.class); when(mockRequestExecutor.execute(any(), any(), any())).thenReturn(mockResponse); final Socket mockSocket = mock(Socket.class); when(managedConnection.getSocket()).thenReturn(mockSocket); final RequestConfig requestConfig = RequestConfig.DEFAULT; final ProxyClient client = new ProxyClient(connFactory, null, null, requestConfig); final HttpHost proxy = new HttpHost("proxy.example.com", 8080); final HttpHost target = new HttpHost("target.example.com", 80); // Valid port final Credentials credentials = new UsernamePasswordCredentials("user", "pass".toCharArray()); final Socket resultSocket = client.tunnel(proxy, target, credentials); assertNotNull(resultSocket, "Expected a valid socket object"); assertEquals(mockSocket, resultSocket, "Expected the mock socket to be returned"); } }httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/MockClock.java0100664 0000000 0000000 00000002704 14666635064 026602 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; public class MockClock implements Clock { private long t = System.currentTimeMillis(); @Override public long getCurrentTime() { return t; } public void setCurrentTime(final long now) { t = now; } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestInternalExecRuntime.java0100664 0000000 0000000 00000030752 14704162040 031504 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.io.ConnectionEndpoint; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.io.LeaseRequest; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.concurrent.CancellableDependency; import org.apache.hc.core5.http.ConnectionRequestTimeoutException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; import org.slf4j.Logger; @SuppressWarnings({"static-access"}) // test code class TestInternalExecRuntime { @Mock private Logger log; @Mock private HttpClientConnectionManager mgr; @Mock private LeaseRequest leaseRequest; @Mock private HttpRequestExecutor requestExecutor; @Mock private CancellableDependency cancellableDependency; @Mock private ConnectionEndpoint connectionEndpoint; private HttpRoute route; private InternalExecRuntime execRuntime; @BeforeEach void setup() { MockitoAnnotations.openMocks(this); route = new HttpRoute(new HttpHost("host", 80)); execRuntime = new InternalExecRuntime(log, mgr, requestExecutor, cancellableDependency); } @Test void testAcquireEndpoint() throws Exception { final HttpClientContext context = HttpClientContext.create(); @SuppressWarnings("deprecation") final RequestConfig config = RequestConfig.custom() .setConnectionRequestTimeout(345, TimeUnit.MILLISECONDS) .setConnectTimeout(123, TimeUnit.MILLISECONDS) .build(); context.setRequestConfig(config); final HttpRoute route = new HttpRoute(new HttpHost("host", 80)); Mockito.when(mgr.lease(Mockito.eq("some-id"), Mockito.eq(route), Mockito.any(), Mockito.any())) .thenReturn(leaseRequest); Mockito.when(leaseRequest.get(Mockito.any())).thenReturn(connectionEndpoint); execRuntime.acquireEndpoint("some-id", route, null, context); Assertions.assertTrue(execRuntime.isEndpointAcquired()); Assertions.assertSame(connectionEndpoint, execRuntime.ensureValid()); Assertions.assertFalse(execRuntime.isEndpointConnected()); Assertions.assertFalse(execRuntime.isConnectionReusable()); Mockito.verify(leaseRequest).get(Timeout.ofMilliseconds(345)); Mockito.verify(cancellableDependency, Mockito.times(1)).setDependency(leaseRequest); Mockito.verify(cancellableDependency, Mockito.times(1)).setDependency(execRuntime); Mockito.verify(cancellableDependency, Mockito.times(2)).setDependency(Mockito.any()); } @Test void testAcquireEndpointAlreadyAcquired() throws Exception { final HttpClientContext context = HttpClientContext.create(); Mockito.when(mgr.lease(Mockito.eq("some-id"), Mockito.eq(route), Mockito.any(), Mockito.any())) .thenReturn(leaseRequest); Mockito.when(leaseRequest.get(Mockito.any())).thenReturn(connectionEndpoint); execRuntime.acquireEndpoint("some-id", route, null, context); Assertions.assertTrue(execRuntime.isEndpointAcquired()); Assertions.assertSame(connectionEndpoint, execRuntime.ensureValid()); Assertions.assertThrows(IllegalStateException.class, () -> execRuntime.acquireEndpoint("some-id", route, null, context)); } @Test void testAcquireEndpointLeaseRequestTimeout() throws Exception { final HttpClientContext context = HttpClientContext.create(); Mockito.when(mgr.lease(Mockito.eq("some-id"), Mockito.eq(route), Mockito.any(), Mockito.any())) .thenReturn(leaseRequest); Mockito.when(leaseRequest.get(Mockito.any())).thenThrow(new TimeoutException("timeout")); Assertions.assertThrows(ConnectionRequestTimeoutException.class, () -> execRuntime.acquireEndpoint("some-id", route, null, context)); } @Test void testAcquireEndpointLeaseRequestFailure() throws Exception { final HttpClientContext context = HttpClientContext.create(); Mockito.when(mgr.lease(Mockito.eq("some-id"), Mockito.eq(route), Mockito.any(), Mockito.any())) .thenReturn(leaseRequest); Mockito.when(leaseRequest.get(Mockito.any())).thenThrow(new ExecutionException(new IllegalStateException())); Assertions.assertThrows(RequestFailedException.class, () -> execRuntime.acquireEndpoint("some-id", route, null, context)); } @Test void testAbortEndpoint() throws Exception { final HttpClientContext context = HttpClientContext.create(); Mockito.when(mgr.lease(Mockito.eq("some-id"), Mockito.eq(route), Mockito.any(), Mockito.any())) .thenReturn(leaseRequest); Mockito.when(leaseRequest.get(Mockito.any())).thenReturn(connectionEndpoint); execRuntime.acquireEndpoint("some-id", new HttpRoute(new HttpHost("host", 80)), null, context); Assertions.assertTrue(execRuntime.isEndpointAcquired()); execRuntime.discardEndpoint(); Assertions.assertFalse(execRuntime.isEndpointAcquired()); Mockito.verify(connectionEndpoint).close(CloseMode.IMMEDIATE); Mockito.verify(mgr).release(connectionEndpoint, null, TimeValue.ZERO_MILLISECONDS); execRuntime.discardEndpoint(); Mockito.verify(connectionEndpoint, Mockito.times(1)).close(CloseMode.IMMEDIATE); Mockito.verify(mgr, Mockito.times(1)).release( Mockito.any(), Mockito.any(), Mockito.any()); } @Test void testCancell() throws Exception { final HttpClientContext context = HttpClientContext.create(); Mockito.when(mgr.lease(Mockito.eq("some-id"), Mockito.eq(route), Mockito.any(), Mockito.any())) .thenReturn(leaseRequest); Mockito.when(leaseRequest.get(Mockito.any())).thenReturn(connectionEndpoint); execRuntime.acquireEndpoint("some-id", route, null, context); Assertions.assertTrue(execRuntime.isEndpointAcquired()); Assertions.assertTrue(execRuntime.cancel()); Assertions.assertFalse(execRuntime.isEndpointAcquired()); Mockito.verify(connectionEndpoint).close(CloseMode.IMMEDIATE); Mockito.verify(mgr).release(connectionEndpoint, null, TimeValue.ZERO_MILLISECONDS); Assertions.assertFalse(execRuntime.cancel()); Mockito.verify(connectionEndpoint, Mockito.times(1)).close(CloseMode.IMMEDIATE); Mockito.verify(mgr, Mockito.times(1)).release( Mockito.any(), Mockito.any(), Mockito.any()); } @Test void testReleaseEndpointReusable() throws Exception { final HttpClientContext context = HttpClientContext.create(); Mockito.when(mgr.lease(Mockito.eq("some-id"), Mockito.eq(route), Mockito.any(), Mockito.any())) .thenReturn(leaseRequest); Mockito.when(leaseRequest.get(Mockito.any())).thenReturn(connectionEndpoint); execRuntime.acquireEndpoint("some-id", route, null, context); Assertions.assertTrue(execRuntime.isEndpointAcquired()); execRuntime.markConnectionReusable("some state", TimeValue.ofMilliseconds(100000)); execRuntime.releaseEndpoint(); Assertions.assertFalse(execRuntime.isEndpointAcquired()); Mockito.verify(connectionEndpoint, Mockito.never()).close(); Mockito.verify(mgr).release(connectionEndpoint, "some state", TimeValue.ofMilliseconds(100000)); execRuntime.releaseEndpoint(); Mockito.verify(mgr, Mockito.times(1)).release( Mockito.any(), Mockito.any(), Mockito.any()); } @Test void testReleaseEndpointNonReusable() throws Exception { final HttpClientContext context = HttpClientContext.create(); Mockito.when(mgr.lease(Mockito.eq("some-id"), Mockito.eq(route), Mockito.any(), Mockito.any())) .thenReturn(leaseRequest); Mockito.when(leaseRequest.get(Mockito.any())).thenReturn(connectionEndpoint); execRuntime.acquireEndpoint("some-id", route, null, context); Assertions.assertTrue(execRuntime.isEndpointAcquired()); execRuntime.markConnectionReusable("some state", TimeValue.ofMilliseconds(100000)); execRuntime.markConnectionNonReusable(); execRuntime.releaseEndpoint(); Assertions.assertFalse(execRuntime.isEndpointAcquired()); Mockito.verify(connectionEndpoint, Mockito.times(1)).close(CloseMode.IMMEDIATE); Mockito.verify(mgr).release(connectionEndpoint, null, TimeValue.ZERO_MILLISECONDS); execRuntime.releaseEndpoint(); Mockito.verify(mgr, Mockito.times(1)).release( Mockito.any(), Mockito.any(), Mockito.any()); } @Test void testConnectEndpoint() throws Exception { final HttpClientContext context = HttpClientContext.create(); @SuppressWarnings("deprecation") final RequestConfig config = RequestConfig.custom() .setConnectionRequestTimeout(345, TimeUnit.MILLISECONDS) .setConnectTimeout(123, TimeUnit.MILLISECONDS) .build(); context.setRequestConfig(config); Mockito.when(mgr.lease(Mockito.eq("some-id"), Mockito.eq(route), Mockito.any(), Mockito.any())) .thenReturn(leaseRequest); Mockito.when(leaseRequest.get(Mockito.any())).thenReturn(connectionEndpoint); execRuntime.acquireEndpoint("some-id", route, null, context); Assertions.assertTrue(execRuntime.isEndpointAcquired()); Mockito.when(connectionEndpoint.isConnected()).thenReturn(false); Assertions.assertFalse(execRuntime.isEndpointConnected()); execRuntime.connectEndpoint(context); Mockito.verify(mgr).connect(connectionEndpoint, Timeout.ofMilliseconds(123), context); } @Test void testDisonnectEndpoint() throws Exception { final HttpClientContext context = HttpClientContext.create(); Mockito.when(mgr.lease(Mockito.eq("some-id"), Mockito.eq(route), Mockito.any(), Mockito.any())) .thenReturn(leaseRequest); Mockito.when(leaseRequest.get(Mockito.any())).thenReturn(connectionEndpoint); execRuntime.acquireEndpoint("some-id", route, null, context); Assertions.assertTrue(execRuntime.isEndpointAcquired()); Mockito.when(connectionEndpoint.isConnected()).thenReturn(true); Assertions.assertTrue(execRuntime.isEndpointConnected()); execRuntime.connectEndpoint(context); Mockito.verify(mgr, Mockito.never()).connect( Mockito.same(connectionEndpoint), Mockito.any(), Mockito.any()); execRuntime.disconnectEndpoint(); Mockito.verify(connectionEndpoint).close(); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/MockConnPoolControl.java0100664 0000000 0000000 00000006567 14704162040 030630 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.util.HashSet; import java.util.Map; import java.util.Set; import java.util.concurrent.ConcurrentHashMap; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.pool.PoolStats; import org.apache.hc.core5.util.TimeValue; public final class MockConnPoolControl implements ConnPoolControl { private final ConcurrentHashMap maxPerHostMap; private volatile int totalMax; private volatile int defaultMax; public MockConnPoolControl() { super(); this.maxPerHostMap = new ConcurrentHashMap<>(); this.totalMax = 20; this.defaultMax = 2; } @Override public void setMaxTotal(final int max) { this.totalMax = max; } @Override public int getMaxTotal() { return this.totalMax; } @Override public PoolStats getTotalStats() { return new PoolStats(-1, -1, -1, this.totalMax); } @Override public PoolStats getStats(final HttpRoute route) { return new PoolStats(-1, -1, -1, getMaxPerRoute(route)); } @Override public int getDefaultMaxPerRoute() { return this.defaultMax; } @Override public void setDefaultMaxPerRoute(final int max) { this.defaultMax = max; } @Override public void setMaxPerRoute(final HttpRoute route, final int max) { this.maxPerHostMap.put(route, max); } @Override public int getMaxPerRoute(final HttpRoute route) { final Integer max = this.maxPerHostMap.get(route); return max != null ? max : this.defaultMax; } @Override public void closeIdle(final TimeValue idletime) { } @Override public void closeExpired() { } public void setMaxForRoutes(final Map map) { if (map == null) { return; } this.maxPerHostMap.clear(); this.maxPerHostMap.putAll(map); } @Override public Set getRoutes() { return new HashSet<>(this.maxPerHostMap.keySet()); } @Override public String toString() { return this.maxPerHostMap.toString(); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestCookieIdentityComparator.java0100664 0000000 0000000 00000012454 14704162040 032531 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.cookie.CookieIdentityComparator; import org.apache.hc.client5.http.impl.cookie.BasicClientCookie; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Simple tests for {@link CookieIdentityComparator}. */ class TestCookieIdentityComparator { @Test void testCookieIdentityComparasionByName() { final CookieIdentityComparator comparator = CookieIdentityComparator.INSTANCE; final BasicClientCookie c1 = new BasicClientCookie("name", "value1"); final BasicClientCookie c2 = new BasicClientCookie("name", "value2"); Assertions.assertEquals(0, comparator.compare(c1, c2)); final BasicClientCookie c3 = new BasicClientCookie("name1", "value"); final BasicClientCookie c4 = new BasicClientCookie("name2", "value"); Assertions.assertNotEquals(0, comparator.compare(c3, c4)); } @Test void testCookieIdentityComparasionByNameAndDomain() { final CookieIdentityComparator comparator = CookieIdentityComparator.INSTANCE; final BasicClientCookie c1 = new BasicClientCookie("name", "value1"); c1.setDomain("www.domain.com"); final BasicClientCookie c2 = new BasicClientCookie("name", "value2"); c2.setDomain("www.domain.com"); Assertions.assertEquals(0, comparator.compare(c1, c2)); final BasicClientCookie c3 = new BasicClientCookie("name", "value1"); c3.setDomain("www.domain.com"); final BasicClientCookie c4 = new BasicClientCookie("name", "value2"); c4.setDomain("domain.com"); Assertions.assertNotEquals(0, comparator.compare(c3, c4)); } @Test void testCookieIdentityComparasionByNameAndNullDomain() { final CookieIdentityComparator comparator = CookieIdentityComparator.INSTANCE; final BasicClientCookie c1 = new BasicClientCookie("name", "value1"); c1.setDomain(null); final BasicClientCookie c2 = new BasicClientCookie("name", "value2"); c2.setDomain(null); Assertions.assertEquals(0, comparator.compare(c1, c2)); final BasicClientCookie c3 = new BasicClientCookie("name", "value1"); c3.setDomain("www.domain.com"); final BasicClientCookie c4 = new BasicClientCookie("name", "value2"); c4.setDomain(null); Assertions.assertNotEquals(0, comparator.compare(c3, c4)); } @Test void testCookieIdentityComparasionByNameDomainAndPath() { final CookieIdentityComparator comparator = CookieIdentityComparator.INSTANCE; final BasicClientCookie c1 = new BasicClientCookie("name", "value1"); c1.setDomain("www.domain.com"); c1.setPath("/whatever"); final BasicClientCookie c2 = new BasicClientCookie("name", "value2"); c2.setDomain("www.domain.com"); c2.setPath("/whatever"); Assertions.assertEquals(0, comparator.compare(c1, c2)); final BasicClientCookie c3 = new BasicClientCookie("name", "value1"); c3.setDomain("www.domain.com"); c3.setPath("/whatever"); final BasicClientCookie c4 = new BasicClientCookie("name", "value2"); c4.setDomain("domain.com"); c4.setPath("/whatever-not"); Assertions.assertNotEquals(0, comparator.compare(c3, c4)); } @Test void testCookieIdentityComparasionByNameDomainAndNullPath() { final CookieIdentityComparator comparator = CookieIdentityComparator.INSTANCE; final BasicClientCookie c1 = new BasicClientCookie("name", "value1"); c1.setDomain("www.domain.com"); c1.setPath("/"); final BasicClientCookie c2 = new BasicClientCookie("name", "value2"); c2.setDomain("www.domain.com"); c2.setPath(null); Assertions.assertEquals(0, comparator.compare(c1, c2)); final BasicClientCookie c3 = new BasicClientCookie("name", "value1"); c3.setDomain("www.domain.com"); c3.setPath("/whatever"); final BasicClientCookie c4 = new BasicClientCookie("name", "value2"); c4.setDomain("domain.com"); c4.setPath(null); Assertions.assertNotEquals(0, comparator.compare(c3, c4)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/DistributedProxySelectorTest.java0100664 0000000 0000000 00000022442 14666635064 032623 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.impl.routing.DistributedProxySelector; import org.junit.jupiter.api.Test; import java.io.IOException; import java.net.InetSocketAddress; import java.net.Proxy; import java.net.ProxySelector; import java.net.SocketAddress; import java.net.URI; import java.util.Arrays; import java.util.Collections; import java.util.List; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertThrows; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; class DistributedProxySelectorTest { @Test void testConstructorThrowsExceptionWhenNullSelectors() { assertThrows(IllegalArgumentException.class, () -> new DistributedProxySelector(null)); } @Test void testConstructorThrowsExceptionWhenEmptySelectors() { assertThrows(IllegalArgumentException.class, () -> new DistributedProxySelector(Collections.emptyList())); } @Test void testSelectReturnsProxyFromFirstSelector() { final ProxySelector selector1 = new ProxySelector() { @Override public List select(final URI uri) { return Arrays.asList( new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxy1.example.com", 8080)), new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxy2.example.com", 8080)) ); } @Override public void connectFailed(final URI uri, final SocketAddress sa, final IOException ioe) { } }; final ProxySelector selector2 = new ProxySelector() { @Override public List select(final URI uri) { return Collections.singletonList( new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxy3.example.com", 8080)) ); } @Override public void connectFailed(final URI uri, final SocketAddress sa, final IOException ioe) { } }; final DistributedProxySelector failoverSelector = new DistributedProxySelector(Arrays.asList(selector1, selector2)); final URI uri = URI.create("http://example.com"); final List proxies = failoverSelector.select(uri); assertEquals(2, proxies.size()); assertEquals("proxy1.example.com", ((InetSocketAddress) proxies.get(0).address()).getHostName()); assertEquals("proxy2.example.com", ((InetSocketAddress) proxies.get(1).address()).getHostName()); } @Test void testSelectReturnsProxyFromSecondSelector() { final ProxySelector selector1 = new ProxySelector() { @Override public List select(final URI uri) { return Collections.emptyList(); } @Override public void connectFailed(final URI uri, final SocketAddress sa, final IOException ioe) { } }; final ProxySelector selector2 = new ProxySelector() { @Override public List select(final URI uri) { return Collections.singletonList( new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxy3.example.com", 8080)) ); } @Override public void connectFailed(final URI uri, final SocketAddress sa, final IOException ioe) { } }; final DistributedProxySelector failoverSelector = new DistributedProxySelector(Arrays.asList(selector1, selector2)); final URI uri = URI.create("http://example.com"); final List proxies = failoverSelector.select(uri); assertEquals(1, proxies.size()); assertEquals("proxy3.example.com", ((InetSocketAddress) proxies.get(0).address()).getHostName()); } @Test void testSelectReturnsProxyFromThirdSelector() { final ProxySelector selector1 = new ProxySelector() { @Override public List select(final URI uri) { return Collections.emptyList(); } @Override public void connectFailed(final URI uri, final SocketAddress sa, final IOException ioe) { } }; final ProxySelector selector2 = mock(ProxySelector.class); // Create a mock object for ProxySelector when(selector2.select(any(URI.class))).thenReturn(Collections.singletonList( new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxy3.example.com", 8080)) )); final DistributedProxySelector proxySelector = new DistributedProxySelector(Arrays.asList(selector1, selector2)); final URI uri = URI.create("http://example.com"); final List proxies = proxySelector.select(uri); // Assertions assertEquals(1, proxies.size(), "Expecting one proxy to be returned"); assertEquals("proxy3.example.com", ((InetSocketAddress) proxies.get(0).address()).getHostName(), "Expecting proxy3.example.com to be returned"); // Verify that selector2's connectFailed() method is called when a connection fails final SocketAddress sa = new InetSocketAddress("proxy3.example.com", 8080); final IOException ioe = new IOException("Connection refused"); proxySelector.connectFailed(uri, sa, ioe); verify(selector2, never()).connectFailed(uri, sa, ioe); } @Test void testSelectReturnsProxyFromSecondSelectorWhenFirstSelectorReturnsEmptyList() { final ProxySelector selector1 = new ProxySelector() { @Override public List select(final URI uri) { return Collections.emptyList(); } @Override public void connectFailed(final URI uri, final SocketAddress sa, final IOException ioe) { } }; final ProxySelector selector2 = new ProxySelector() { @Override public List select(final URI uri) { return Collections.singletonList( new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxy3.example.com", 8080)) ); } @Override public void connectFailed(final URI uri, final SocketAddress sa, final IOException ioe) { } }; final DistributedProxySelector failoverSelector = new DistributedProxySelector(Arrays.asList(selector1, selector2)); final URI uri = URI.create("http://example.com"); final List proxies = failoverSelector.select(uri); assertEquals(1, proxies.size()); assertEquals("proxy3.example.com", ((InetSocketAddress) proxies.get(0).address()).getHostName()); } @Test void testSelectHandlesException() { final ProxySelector exceptionThrowingSelector = new ProxySelector() { @Override public List select(final URI uri) { throw new RuntimeException("Exception for testing"); } @Override public void connectFailed(final URI uri, final SocketAddress sa, final IOException ioe) { } }; final ProxySelector workingSelector = new ProxySelector() { @Override public List select(final URI uri) { return Collections.singletonList( new Proxy(Proxy.Type.HTTP, new InetSocketAddress("proxy.example.com", 8080)) ); } @Override public void connectFailed(final URI uri, final SocketAddress sa, final IOException ioe) { } }; final DistributedProxySelector distributedSelector = new DistributedProxySelector(Arrays.asList(exceptionThrowingSelector, workingSelector)); final URI uri = URI.create("http://example.com"); final List proxies = distributedSelector.select(uri); assertEquals(1, proxies.size()); assertEquals("proxy.example.com", ((InetSocketAddress) proxies.get(0).address()).getHostName()); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/RequestEntityProxyTest.java0100664 0000000 0000000 00000006744 15005672035 031457 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.never; import java.io.ByteArrayOutputStream; import java.io.IOException; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.HttpEntity; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; import org.mockito.Mockito; class RequestEntityProxyTest { @Test void testEnhanceWrapsNonRepeatableEntity() { final HttpEntity entity = Mockito.mock(HttpEntity.class); Mockito.when(entity.isRepeatable()).thenReturn(false); final ClassicHttpRequest request = Mockito.mock(ClassicHttpRequest.class); Mockito.when(request.getEntity()).thenReturn(entity); RequestEntityProxy.enhance(request); final ArgumentCaptor captor = ArgumentCaptor.forClass(HttpEntity.class); Mockito.verify(request).setEntity(captor.capture()); final HttpEntity proxy = captor.getValue(); Assertions.assertInstanceOf(RequestEntityProxy.class, proxy, "Entity should be wrapped as RequestEntityProxy"); Assertions.assertSame(entity, ((RequestEntityProxy) proxy).getOriginal(), "The proxy should wrap the original entity"); } @Test void testEnhanceDoesNotWrapRepeatableEntity() { final HttpEntity entity = Mockito.mock(HttpEntity.class); Mockito.when(entity.isRepeatable()).thenReturn(true); final ClassicHttpRequest request = Mockito.mock(ClassicHttpRequest.class); Mockito.when(request.getEntity()).thenReturn(entity); RequestEntityProxy.enhance(request); Mockito.verify(request, never()).setEntity(any(HttpEntity.class)); } @Test void testIsRepeatableBehavior() throws IOException { final HttpEntity entity = Mockito.mock(HttpEntity.class); Mockito.when(entity.isRepeatable()).thenReturn(false); final RequestEntityProxy proxy = new RequestEntityProxy(entity); Assertions.assertTrue(proxy.isRepeatable(), "Proxy should be repeatable before consumption"); final ByteArrayOutputStream out = new ByteArrayOutputStream(); proxy.writeTo(out); Assertions.assertFalse(proxy.isRepeatable(), "Proxy should not be repeatable after consumption"); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestLinearBackoffManager.java0100664 0000000 0000000 00000016633 14704162040 031542 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertTrue; import java.time.Instant; import java.util.Map; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestLinearBackoffManager { private LinearBackoffManager impl; private MockConnPoolControl connPerRoute; private HttpRoute route; private static final long DEFAULT_COOL_DOWN_MS = 10; @BeforeEach void setUp() { connPerRoute = new MockConnPoolControl(); route = new HttpRoute(new HttpHost("localhost", 80)); impl = new LinearBackoffManager(connPerRoute); impl.setCoolDown(TimeValue.ofMilliseconds(DEFAULT_COOL_DOWN_MS)); } @Test void incrementsConnectionsOnBackoff() { final LinearBackoffManager impl = new LinearBackoffManager(connPerRoute); impl.setCoolDown(TimeValue.ofMilliseconds(DEFAULT_COOL_DOWN_MS)); // Set the cool-down period connPerRoute.setMaxPerRoute(route, 4); impl.backOff(route); assertEquals(5, connPerRoute.getMaxPerRoute(route)); } @Test void decrementsConnectionsOnProbe() { connPerRoute.setMaxPerRoute(route, 4); impl.probe(route); assertEquals(3, connPerRoute.getMaxPerRoute(route)); } @Test void backoffDoesNotAdjustDuringCoolDownPeriod() { // Arrange connPerRoute.setMaxPerRoute(route, 4); impl.backOff(route); final long max = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteBackoffs to simulate that not enough time has passed for the cooldown period final Map lastRouteBackoffs = impl.getLastRouteBackoffs(); lastRouteBackoffs.put(route, Instant.now().minusMillis(DEFAULT_COOL_DOWN_MS - 1)); // Act impl.backOff(route); // Assert assertEquals(max, connPerRoute.getMaxPerRoute(route)); } @Test void backoffStillAdjustsAfterCoolDownPeriod() { // Arrange final LinearBackoffManager impl = new LinearBackoffManager(connPerRoute); impl.setCoolDown(TimeValue.ofMilliseconds(DEFAULT_COOL_DOWN_MS)); // Set the cool-down period connPerRoute.setMaxPerRoute(route, 4); impl.backOff(route); final int max1 = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteBackoffs to simulate that enough time has passed for the cooldown period final Map lastRouteBackoffs = impl.getLastRouteBackoffs(); lastRouteBackoffs.put(route, Instant.now().minusMillis(DEFAULT_COOL_DOWN_MS + 1)); // Act impl.backOff(route); final int max2 = connPerRoute.getMaxPerRoute(route); // Assert assertTrue(max2 > max1); } @Test void probeDoesNotAdjustDuringCooldownPeriod() { // Arrange connPerRoute.setMaxPerRoute(route, 4); impl.probe(route); final long max = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteProbes to simulate that not enough time has passed for the cooldown period final Map lastRouteProbes = impl.getLastRouteProbes(); lastRouteProbes.put(route, Instant.now()); // Act impl.probe(route); // Assert assertEquals(max, connPerRoute.getMaxPerRoute(route)); } @Test void probeStillAdjustsAfterCoolDownPeriod() { // Arrange connPerRoute.setMaxPerRoute(route, 4); impl.probe(route); // Manipulate lastRouteProbes to simulate that enough time has passed for the cooldown period final Map lastRouteProbes = impl.getLastRouteProbes(); lastRouteProbes.put(route, Instant.now().minusMillis(DEFAULT_COOL_DOWN_MS + 1)); // Act impl.probe(route); final long newMax = connPerRoute.getMaxPerRoute(route); // Assert assertEquals(2, newMax); // The cap is set to 2 by default } @Test void testSetPerHostConnectionCap() { connPerRoute.setMaxPerRoute(route, 5); impl.setPerHostConnectionCap(10); // Set the cap to a higher value impl.backOff(route); assertEquals(6, connPerRoute.getMaxPerRoute(route)); } public void probeUpdatesRemainingAttemptsIndirectly() { // Set initial max per route connPerRoute.setMaxPerRoute(route, 4); // Apply backOff twice impl.backOff(route); // Manipulate lastRouteBackoffs to simulate that enough time has passed for the cooldown period final Map lastRouteBackoffs = impl.getLastRouteBackoffs(); lastRouteBackoffs.put(route, Instant.now().minusMillis(DEFAULT_COOL_DOWN_MS + 1)); impl.backOff(route); // Ensure that connection pool size has increased assertEquals(6, connPerRoute.getMaxPerRoute(route)); // Apply probe once impl.probe(route); // Manipulate lastRouteProbes to simulate that enough time has passed for the cooldown period final Map lastRouteProbes = impl.getLastRouteProbes(); lastRouteProbes.put(route, Instant.now().minusMillis(DEFAULT_COOL_DOWN_MS * 2)); // Apply probe once more impl.probe(route); // Check that connection pool size has decreased once, indicating that the remaining attempts were updated assertEquals(5, connPerRoute.getMaxPerRoute(route)); } @Test void linearIncrementTest() { final int initialMax = 4; connPerRoute.setMaxPerRoute(route, initialMax); // Manipulate lastRouteBackoffs to simulate that enough time has passed for the cooldown period final Map lastRouteBackoffs = impl.getLastRouteBackoffs(); for (int i = 1; i <= 5; i++) { // Simulate that enough time has passed for the cooldown period lastRouteBackoffs.put(route, Instant.now().minusMillis(DEFAULT_COOL_DOWN_MS + 1)); // Act impl.backOff(route); // Assert assertEquals(initialMax + i, connPerRoute.getMaxPerRoute(route)); } } } ././@LongLink0100644 0000000 0000000 00000000145 14704162040 011631 Lustar 0000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestExponentialBackoffManager.javahttpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestExponentialBackoffManager.java0100664 0000000 0000000 00000016240 14704162040 032610 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertTrue; import java.time.Instant; import java.util.Map; class TestExponentialBackoffManager { private ExponentialBackoffManager impl; private MockConnPoolControl connPerRoute; private HttpRoute route; private static final long DEFAULT_COOL_DOWN_MS = 5000; // Adjust this value to match the default cooldown period in ExponentialBackoffManager @BeforeEach void setUp() { connPerRoute = new MockConnPoolControl(); route = new HttpRoute(new HttpHost("localhost", 80)); impl = new ExponentialBackoffManager(connPerRoute); impl.setPerHostConnectionCap(10); impl.setCoolDown(TimeValue.ofMilliseconds(DEFAULT_COOL_DOWN_MS)); impl.setBackoffFactor(1.75); // Adjust this value to match the default growth rate in ExponentialBackoffManager } @Test void exponentialBackoffApplied() { connPerRoute.setMaxPerRoute(route, 4); impl.setBackoffFactor(2); // Sets the growth rate to 2 for this test impl.backOff(route); assertEquals(1, connPerRoute.getMaxPerRoute(route)); // Corrected expected value } @Test void exponentialGrowthRateIsConfigurable() { final int customCoolDownMs = 500; connPerRoute.setMaxPerRoute(route, 4); impl.setBackoffFactor(0.5); impl.setCoolDown(TimeValue.ofMilliseconds(customCoolDownMs)); impl.backOff(route); assertEquals(2, connPerRoute.getMaxPerRoute(route)); // Manipulate lastRouteBackoffs to simulate that enough time has passed for the cooldown period final Map lastRouteBackoffs = impl.getLastRouteBackoffs(); lastRouteBackoffs.put(route, Instant.now().minusMillis(customCoolDownMs + 1)); impl.backOff(route); assertEquals(1, connPerRoute.getMaxPerRoute(route)); } @Test void doesNotIncreaseBeyondPerHostMaxOnProbe() { connPerRoute.setDefaultMaxPerRoute(5); connPerRoute.setMaxPerRoute(route, 5); impl.setPerHostConnectionCap(5); impl.probe(route); assertEquals(5, connPerRoute.getMaxPerRoute(route)); } @Test void backoffDoesNotAdjustDuringCoolDownPeriod() { connPerRoute.setMaxPerRoute(route, 4); impl.backOff(route); final long max = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteBackoffs to simulate that not enough time has passed for the cooldown period final Map lastRouteBackoffs = impl.getLastRouteBackoffs(); lastRouteBackoffs.put(route, Instant.now().minusMillis(10)); // Perform another backoff impl.backOff(route); assertEquals(max, connPerRoute.getMaxPerRoute(route)); } @Test void backoffStillAdjustsAfterCoolDownPeriod() { connPerRoute.setMaxPerRoute(route, 8); impl.backOff(route); final long max = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteBackoffs to simulate that enough time has passed for the cooldown period final Map lastRouteBackoffs = impl.getLastRouteBackoffs(); lastRouteBackoffs.put(route, Instant.now().minusMillis(DEFAULT_COOL_DOWN_MS + 1)); // Perform another backoff impl.backOff(route); // Assert that the max connections have decreased assertTrue(max == 1 || max > connPerRoute.getMaxPerRoute(route)); } @Test void probeDoesNotAdjustDuringCooldownPeriod() { connPerRoute.setMaxPerRoute(route, 4); impl.probe(route); final long max = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteProbes to simulate that not enough time has passed for the cooldown period final Map lastRouteProbes = impl.getLastRouteProbes(); lastRouteProbes.put(route, Instant.now().minusMillis(0)); impl.probe(route); assertEquals(max, connPerRoute.getMaxPerRoute(route)); } @Test void probeStillAdjustsAfterCoolDownPeriod() { connPerRoute.setMaxPerRoute(route, 8); impl.probe(route); final long max = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteProbes to simulate that enough time has passed for the cooldown period final Map lastRouteProbes = impl.getLastRouteProbes(); lastRouteProbes.put(route, Instant.now().minusMillis(DEFAULT_COOL_DOWN_MS + 1)); impl.probe(route); assertTrue(max < connPerRoute.getMaxPerRoute(route)); } @Test void willBackoffImmediatelyEvenAfterAProbe() { connPerRoute.setMaxPerRoute(route, 8); impl.probe(route); final long max = connPerRoute.getMaxPerRoute(route); impl.backOff(route); assertTrue(connPerRoute.getMaxPerRoute(route) < max); } @Test void coolDownPeriodIsConfigurable() { final long cd = 500; // Fixed cooldown period of 500 milliseconds impl.setCoolDown(TimeValue.ofMilliseconds(cd)); connPerRoute.setMaxPerRoute(route, 4); impl.probe(route); final int max0 = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteProbes to simulate that not enough time has passed for the cooldown period final Map lastRouteProbes = impl.getLastRouteProbes(); lastRouteProbes.put(route, Instant.now().minusMillis(cd / 2)); impl.probe(route); assertEquals(max0, connPerRoute.getMaxPerRoute(route)); // Manipulate lastRouteProbes again to simulate that enough time has passed for the cooldown period lastRouteProbes.put(route, Instant.now().minusMillis(cd + 1)); impl.probe(route); assertTrue(max0 < connPerRoute.getMaxPerRoute(route)); } }httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestHttpRequestRetryExec.java0100664 0000000 0000000 00000030747 15036651120 031707 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import org.apache.hc.client5.http.HttpRequestRetryStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.entity.EntityBuilder; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; @SuppressWarnings({"boxing","static-access"}) // test code class TestHttpRequestRetryExec { @Mock private HttpRequestRetryStrategy retryStrategy; @Mock private ExecChain chain; @Mock private ExecRuntime endpoint; @Mock private TimeValue nextInterval; private HttpRequestRetryExec retryExec; private HttpHost target; @BeforeEach void setup() { MockitoAnnotations.openMocks(this); retryExec = new HttpRequestRetryExec(retryStrategy); target = new HttpHost("localhost", 80); } @Test void testFundamentals1() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpGet request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); Mockito.when(chain.proceed( Mockito.same(request), Mockito.any())).thenReturn(response); Mockito.when(retryStrategy.retryRequest( Mockito.any(), Mockito.anyInt(), Mockito.any())).thenReturn(Boolean.TRUE, Boolean.FALSE); Mockito.when(retryStrategy.getRetryInterval( Mockito.any(), Mockito.anyInt(), Mockito.any())).thenReturn(TimeValue.ZERO_MILLISECONDS); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); retryExec.execute(request, scope, chain); Mockito.verify(chain, Mockito.times(2)).proceed( Mockito.any(), Mockito.same(scope)); Mockito.verify(response, Mockito.times(1)).close(); } @Test void testRetrySleepOnIOException() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpGet request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); Mockito.mock(ClassicHttpResponse.class); Mockito.when(chain.proceed( Mockito.same(request), Mockito.any())).thenThrow(new IOException("Ka-boom")); Mockito.when(retryStrategy.retryRequest( Mockito.any(), Mockito.any(), Mockito.anyInt(), Mockito.any())).thenReturn(Boolean.TRUE, Boolean.FALSE); Mockito.when(retryStrategy.getRetryInterval( Mockito.any(), Mockito.any(), Mockito.anyInt(), Mockito.any())).thenReturn(nextInterval); Mockito.when(nextInterval.getDuration()).thenReturn(100L); Mockito.when(nextInterval.compareTo(Mockito.any())).thenReturn(-1); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); retryExec.execute(request, scope, chain); Mockito.verify(chain, Mockito.times(2)).proceed( Mockito.any(), Mockito.same(scope)); Mockito.verify(nextInterval, Mockito.times(1)).sleep(); } @Test void testRetryIntervalResponseTimeoutNull() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpGet request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); context.setRequestConfig(RequestConfig.custom() .setResponseTimeout(null) .build()); final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); Mockito.when(chain.proceed( Mockito.same(request), Mockito.any())).thenReturn(response); Mockito.when(retryStrategy.retryRequest( Mockito.any(), Mockito.anyInt(), Mockito.any())).thenReturn(Boolean.TRUE, Boolean.FALSE); Mockito.when(retryStrategy.getRetryInterval( Mockito.any(), Mockito.anyInt(), Mockito.any())).thenReturn(TimeValue.ofSeconds(1)); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); retryExec.execute(request, scope, chain); Mockito.verify(chain, Mockito.times(2)).proceed( Mockito.any(), Mockito.same(scope)); Mockito.verify(response, Mockito.times(1)).close(); } @Test void testStrategyRuntimeException() throws Exception { final HttpRoute route = new HttpRoute(target); final ClassicHttpRequest request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); Mockito.when(chain.proceed( Mockito.any(), Mockito.any())).thenReturn(response); Mockito.doThrow(new RuntimeException("Ooopsie")).when(retryStrategy).retryRequest( Mockito.any(), Mockito.anyInt(), Mockito.any()); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); Assertions.assertThrows(RuntimeException.class, () -> retryExec.execute(request, scope, chain)); Mockito.verify(response).close(); } @Test void testNonRepeatableEntityResponseReturnedImmediately() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpPost request = new HttpPost("/test"); request.setEntity(EntityBuilder.create() .setStream(new ByteArrayInputStream(new byte[]{})) .build()); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpResponse response = Mockito.mock(ClassicHttpResponse.class); Mockito.when(chain.proceed( Mockito.any(), Mockito.any())).thenReturn(response); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, endpoint, context); final ClassicHttpResponse finalResponse = retryExec.execute(request, scope, chain); Assertions.assertSame(response, finalResponse); Mockito.verify(response, Mockito.times(0)).close(); } @Test void testFundamentals2() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpGet originalRequest = new HttpGet("/test"); originalRequest.addHeader("header", "this"); originalRequest.addHeader("header", "that"); final HttpClientContext context = HttpClientContext.create(); Mockito.when(chain.proceed( Mockito.any(), Mockito.any())).thenAnswer(invocationOnMock -> { final Object[] args = invocationOnMock.getArguments(); final ClassicHttpRequest wrapper = (ClassicHttpRequest) args[0]; final Header[] headers = wrapper.getHeaders(); Assertions.assertEquals(2, headers.length); Assertions.assertEquals("this", headers[0].getValue()); Assertions.assertEquals("that", headers[1].getValue()); wrapper.addHeader("Cookie", "monster"); throw new IOException("Ka-boom"); }); Mockito.when(retryStrategy.retryRequest( Mockito.any(), Mockito.any(), Mockito.eq(1), Mockito.any())).thenReturn(Boolean.TRUE); final ExecChain.Scope scope = new ExecChain.Scope("test", route, originalRequest, endpoint, context); final ClassicHttpRequest request = ClassicRequestBuilder.copy(originalRequest).build(); Assertions.assertThrows(IOException.class, () -> retryExec.execute(request, scope, chain)); Mockito.verify(chain, Mockito.times(2)).proceed( Mockito.any(), Mockito.same(scope)); } @Test void testAbortedRequest() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpGet originalRequest = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); Mockito.when(chain.proceed( Mockito.any(), Mockito.any())).thenThrow(new IOException("Ka-boom")); Mockito.when(endpoint.isExecutionAborted()).thenReturn(true); final ExecChain.Scope scope = new ExecChain.Scope("test", route, originalRequest, endpoint, context); final ClassicHttpRequest request = ClassicRequestBuilder.copy(originalRequest).build(); Assertions.assertThrows(IOException.class, () -> retryExec.execute(request, scope, chain)); Mockito.verify(chain, Mockito.times(1)).proceed( Mockito.same(request), Mockito.same(scope)); Mockito.verify(retryStrategy, Mockito.never()).retryRequest( Mockito.any(), Mockito.any(), Mockito.anyInt(), Mockito.any()); } @Test void testNonRepeatableRequest() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpPost originalRequest = new HttpPost("/test"); originalRequest.setEntity(EntityBuilder.create() .setStream(new ByteArrayInputStream(new byte[]{})) .build()); final HttpClientContext context = HttpClientContext.create(); Mockito.when(chain.proceed( Mockito.any(), Mockito.any())).thenAnswer(invocationOnMock -> { final Object[] args = invocationOnMock.getArguments(); final ClassicHttpRequest req = (ClassicHttpRequest) args[0]; req.getEntity().writeTo(new ByteArrayOutputStream()); throw new IOException("Ka-boom"); }); final ExecChain.Scope scope = new ExecChain.Scope("test", route, originalRequest, endpoint, context); final ClassicHttpRequest request = ClassicRequestBuilder.copy(originalRequest).build(); Assertions.assertThrows(IOException.class, () -> retryExec.execute(request, scope, chain)); Mockito.verify(chain, Mockito.times(1)).proceed( Mockito.same(request), Mockito.same(scope)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestDefaultBackoffStrategy.java0100664 0000000 0000000 00000006051 15005672016 032141 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertTrue; import java.net.ConnectException; import java.net.SocketTimeoutException; import org.apache.hc.core5.http.ConnectionRequestTimeoutException; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestDefaultBackoffStrategy { private DefaultBackoffStrategy impl; @BeforeEach void setUp() { impl = new DefaultBackoffStrategy(); } @Test void backsOffForSocketTimeouts() { assertTrue(impl.shouldBackoff(new SocketTimeoutException())); } @Test void backsOffForConnectionTimeouts() { assertTrue(impl.shouldBackoff(new ConnectException())); } @Test void doesNotBackOffForConnectionManagerTimeout() { assertFalse(impl.shouldBackoff(new ConnectionRequestTimeoutException())); } @Test void backsOffForServiceUnavailable() { final HttpResponse resp = new BasicHttpResponse(HttpStatus.SC_SERVICE_UNAVAILABLE, "Service Unavailable"); assertTrue(impl.shouldBackoff(resp)); } @Test void backsOffForTooManyRequests() { final HttpResponse resp = new BasicHttpResponse(HttpStatus.SC_TOO_MANY_REQUESTS, "Too Many Requests"); assertTrue(impl.shouldBackoff(resp)); } @Test void doesNotBackOffForNon429And503StatusCodes() { for (int i = 100; i <= 599; i++) { if (i == HttpStatus.SC_TOO_MANY_REQUESTS || i == HttpStatus.SC_SERVICE_UNAVAILABLE) { continue; } final HttpResponse resp = new BasicHttpResponse(i, "Foo"); assertFalse(impl.shouldBackoff(resp)); } } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestHttpAsyncClientBuilder.java0100664 0000000 0000000 00000006250 14704162040 032136 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import org.apache.hc.client5.http.async.AsyncExecCallback; import org.apache.hc.client5.http.async.AsyncExecChain; import org.apache.hc.client5.http.async.AsyncExecChainHandler; import org.apache.hc.client5.http.impl.async.HttpAsyncClients; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.nio.AsyncEntityProducer; import org.junit.jupiter.api.Test; class TestHttpAsyncClientBuilder { @Test void testAddInterceptorFirstDoesNotThrow() throws IOException { HttpAsyncClients.custom() .addExecInterceptorFirst("first", NopExecChainHandler.INSTANCE) .build() .close(); } @Test void testAddInterceptorLastDoesNotThrow() throws IOException { HttpAsyncClients.custom() .addExecInterceptorLast("last", NopExecChainHandler.INSTANCE) .build() .close(); } @Test void testH2AddInterceptorFirstDoesNotThrow() throws IOException { HttpAsyncClients.customHttp2() .addExecInterceptorFirst("first", NopExecChainHandler.INSTANCE) .build() .close(); } @Test void testH2AddInterceptorLastDoesNotThrow() throws IOException { HttpAsyncClients.customHttp2() .addExecInterceptorLast("last", NopExecChainHandler.INSTANCE) .build() .close(); } enum NopExecChainHandler implements AsyncExecChainHandler { INSTANCE; @Override public void execute(final HttpRequest request, final AsyncEntityProducer entityProducer, final AsyncExecChain.Scope scope, final AsyncExecChain chain, final AsyncExecCallback asyncExecCallback) throws HttpException, IOException { chain.proceed(request, entityProducer, scope, asyncExecCallback); } } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestMainClientExec.java0100664 0000000 0000000 00000036550 14704162040 030411 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InterruptedIOException; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.UserTokenHandler; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.entity.EntityBuilder; import org.apache.hc.client5.http.impl.ConnectionShutdownException; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.ConnectionReuseStrategy; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.apache.hc.core5.http.protocol.HttpProcessor; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; class TestMainClientExec { @Mock private HttpClientConnectionManager connectionManager; @Mock private HttpProcessor httpProcessor; @Mock private ConnectionReuseStrategy reuseStrategy; @Mock private ConnectionKeepAliveStrategy keepAliveStrategy; @Mock private UserTokenHandler userTokenHandler; @Mock private ExecRuntime execRuntime; private MainClientExec mainClientExec; private HttpHost target; @BeforeEach void setup() { MockitoAnnotations.openMocks(this); mainClientExec = new MainClientExec(connectionManager, httpProcessor, reuseStrategy, keepAliveStrategy, userTokenHandler); target = new HttpHost("foo", 80); } @Test void testFundamentals() throws Exception { final HttpRoute route = new HttpRoute(target); final ClassicHttpRequest request = new HttpGet("/test"); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); final HttpEntity responseEntity = EntityBuilder.create() .setStream(new ByteArrayInputStream(new byte[]{})) .build(); response.setEntity(responseEntity); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.same(request), Mockito.any(), Mockito.any())).thenReturn(response); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); mainClientExec.execute(request, scope, null); Mockito.verify(httpProcessor).process(request, null, context); Mockito.verify(execRuntime).execute(Mockito.eq("test"), Mockito.same(request), Mockito.any(), Mockito.any()); Mockito.verify(httpProcessor).process(response, responseEntity, context); Assertions.assertEquals(route, context.getHttpRoute()); Assertions.assertSame(request, context.getRequest()); Assertions.assertSame(response, context.getResponse()); } @Test void testExecRequestNonPersistentConnection() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); response.setEntity(EntityBuilder.create() .setStream(new ByteArrayInputStream(new byte[]{})) .build()); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.same(request), Mockito.any(), Mockito.any())).thenReturn(response); Mockito.when(reuseStrategy.keepAlive( Mockito.same(request), Mockito.same(response), Mockito.any())).thenReturn(false); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); final ClassicHttpResponse finalResponse = mainClientExec.execute(request, scope, null); Mockito.verify(execRuntime).execute(Mockito.eq("test"), Mockito.same(request), Mockito.any(), Mockito.any()); Mockito.verify(execRuntime, Mockito.times(1)).markConnectionNonReusable(); Mockito.verify(execRuntime, Mockito.never()).releaseEndpoint(); Assertions.assertNull(context.getUserToken()); Assertions.assertNotNull(finalResponse); Assertions.assertTrue(finalResponse instanceof CloseableHttpResponse); } @Test void testExecRequestNonPersistentConnectionNoResponseEntity() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); response.setEntity(null); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.same(request), Mockito.any(), Mockito.any())).thenReturn(response); Mockito.when(reuseStrategy.keepAlive( Mockito.same(request), Mockito.same(response), Mockito.any())).thenReturn(false); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); final ClassicHttpResponse finalResponse = mainClientExec.execute(request, scope, null); Mockito.verify(execRuntime).execute(Mockito.eq("test"), Mockito.same(request), Mockito.any(), Mockito.any()); Mockito.verify(execRuntime).markConnectionNonReusable(); Mockito.verify(execRuntime).releaseEndpoint(); Assertions.assertNotNull(finalResponse); Assertions.assertTrue(finalResponse instanceof CloseableHttpResponse); } @Test void testExecRequestPersistentConnection() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); // The entity is streaming response.setEntity(EntityBuilder.create() .setStream(new ByteArrayInputStream(new byte[]{})) .build()); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.same(request), Mockito.any(), Mockito.any())).thenReturn(response); Mockito.when(reuseStrategy.keepAlive( Mockito.same(request), Mockito.same(response), Mockito.any())).thenReturn(true); Mockito.when(keepAliveStrategy.getKeepAliveDuration( Mockito.same(response), Mockito.any())).thenReturn(TimeValue.ofMilliseconds(678L)); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); final ClassicHttpResponse finalResponse = mainClientExec.execute(request, scope, null); Mockito.verify(execRuntime).execute(Mockito.eq("test"), Mockito.same(request), Mockito.any(), Mockito.any()); Mockito.verify(execRuntime).markConnectionReusable(null, TimeValue.ofMilliseconds(678L)); Mockito.verify(execRuntime, Mockito.never()).releaseEndpoint(); Assertions.assertNotNull(finalResponse); Assertions.assertTrue(finalResponse instanceof CloseableHttpResponse); } @Test void testExecRequestPersistentConnectionNoResponseEntity() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.same(request), Mockito.any(), Mockito.any())).thenReturn(response); Mockito.when(reuseStrategy.keepAlive( Mockito.same(request), Mockito.same(response), Mockito.any())).thenReturn(true); Mockito.when(keepAliveStrategy.getKeepAliveDuration( Mockito.same(response), Mockito.any())).thenReturn(TimeValue.ofMilliseconds(678L)); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); final ClassicHttpResponse finalResponse = mainClientExec.execute(request, scope, null); Mockito.verify(execRuntime).execute(Mockito.eq("test"), Mockito.same(request), Mockito.any(), Mockito.any()); Mockito.verify(execRuntime).releaseEndpoint(); Assertions.assertNotNull(finalResponse); Assertions.assertTrue(finalResponse instanceof CloseableHttpResponse); } @Test void testExecRequestConnectionRelease() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); // The entity is streaming response.setEntity(EntityBuilder.create() .setStream(new ByteArrayInputStream(new byte[]{})) .build()); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.same(request), Mockito.any(), Mockito.any())).thenReturn(response); Mockito.when(reuseStrategy.keepAlive( Mockito.same(request), Mockito.same(response), Mockito.any())).thenReturn(Boolean.FALSE); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); final ClassicHttpResponse finalResponse = mainClientExec.execute(request, scope, null); Mockito.verify(execRuntime, Mockito.times(1)).execute(Mockito.eq("test"), Mockito.same(request), Mockito.any(), Mockito.any()); Mockito.verify(execRuntime, Mockito.never()).disconnectEndpoint(); Mockito.verify(execRuntime, Mockito.never()).releaseEndpoint(); Assertions.assertNotNull(finalResponse); Assertions.assertTrue(finalResponse instanceof CloseableHttpResponse); finalResponse.close(); Mockito.verify(execRuntime).disconnectEndpoint(); Mockito.verify(execRuntime).discardEndpoint(); } @Test void testExecConnectionShutDown() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.same(request), Mockito.any(), Mockito.any())).thenThrow(new ConnectionShutdownException()); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); Assertions.assertThrows(InterruptedIOException.class, () -> mainClientExec.execute(request, scope, null)); Mockito.verify(execRuntime).discardEndpoint(); } @Test void testExecRuntimeException() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.same(request), Mockito.any(), Mockito.any())).thenThrow(new RuntimeException("Ka-boom")); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); Assertions.assertThrows(RuntimeException.class, () -> mainClientExec.execute(request, scope, null)); Mockito.verify(execRuntime).discardEndpoint(); } @Test void testExecHttpException() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.same(request), Mockito.any(), Mockito.any())).thenThrow(new HttpException("Ka-boom")); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); Assertions.assertThrows(HttpException.class, () -> mainClientExec.execute(request, scope, null)); Mockito.verify(execRuntime).discardEndpoint(); } @Test void testExecIOException() throws Exception { final HttpRoute route = new HttpRoute(target); final HttpClientContext context = HttpClientContext.create(); final ClassicHttpRequest request = new HttpGet("http://bar/test"); Mockito.when(execRuntime.execute( Mockito.anyString(), Mockito.same(request), Mockito.any(), Mockito.any())).thenThrow(new IOException("Ka-boom")); final ExecChain.Scope scope = new ExecChain.Scope("test", route, request, execRuntime, context); Assertions.assertThrows(IOException.class, () -> mainClientExec.execute(request, scope, null)); Mockito.verify(execRuntime).discardEndpoint(); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestContentCompressionExec.java0100664 0000000 0000000 00000023364 15063503632 032226 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.classic.ExecChain; import org.apache.hc.client5.http.classic.ExecRuntime; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.entity.DecompressingEntity; import org.apache.hc.client5.http.entity.EntityBuilder; import org.apache.hc.client5.http.entity.GzipDecompressingEntity; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.Method; import org.apache.hc.core5.http.io.entity.StringEntity; import org.apache.hc.core5.http.message.BasicClassicHttpRequest; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; class TestContentCompressionExec { @Mock private ExecRuntime execRuntime; @Mock private ExecChain execChain; @Mock private ClassicHttpRequest originaRequest; private HttpClientContext context; private HttpHost host; private ExecChain.Scope scope; private ContentCompressionExec impl; @BeforeEach void setup() { MockitoAnnotations.openMocks(this); host = new HttpHost("somehost", 80); context = HttpClientContext.create(); scope = new ExecChain.Scope("test", new HttpRoute(host), originaRequest, execRuntime, context); impl = new ContentCompressionExec(); } @Test void testContentEncodingNoEntity() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest(Method.GET, host, "/"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); Mockito.when(execChain.proceed(request, scope)).thenReturn(response); impl.execute(request, scope, execChain); final HttpEntity entity = response.getEntity(); Assertions.assertNull(entity); } @Test void testNoContentEncoding() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest(Method.GET, host, "/"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); final StringEntity original = new StringEntity("plain stuff"); response.setEntity(original); Mockito.when(execChain.proceed(request, scope)).thenReturn(response); impl.execute(request, scope, execChain); final HttpEntity entity = response.getEntity(); Assertions.assertNotNull(entity); Assertions.assertTrue(entity instanceof StringEntity); } @Test void testGzipContentEncoding() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest(Method.GET, host, "/"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); final HttpEntity original = EntityBuilder.create().setText("encoded stuff").setContentEncoding("GZip").build(); response.setEntity(original); Mockito.when(execChain.proceed(request, scope)).thenReturn(response); impl.execute(request, scope, execChain); final HttpEntity entity = response.getEntity(); Assertions.assertNotNull(entity); Assertions.assertTrue(entity instanceof DecompressingEntity); } @Test void testGzipContentEncodingZeroLength() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest(Method.GET, host, "/"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); final HttpEntity original = EntityBuilder.create().setText("").setContentEncoding("GZip").build(); response.setEntity(original); Mockito.when(execChain.proceed(request, scope)).thenReturn(response); impl.execute(request, scope, execChain); final HttpEntity entity = response.getEntity(); Assertions.assertNotNull(entity); Assertions.assertTrue(entity instanceof StringEntity); } @Test void testXGzipContentEncoding() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest(Method.GET, host, "/"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); final HttpEntity original = EntityBuilder.create().setText("encoded stuff").setContentEncoding("x-gzip").build(); response.setEntity(original); Mockito.when(execChain.proceed(request, scope)).thenReturn(response); impl.execute(request, scope, execChain); final HttpEntity entity = response.getEntity(); Assertions.assertNotNull(entity); Assertions.assertTrue(entity instanceof DecompressingEntity); } @Test void testDeflateContentEncoding() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest(Method.GET, host, "/"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); final HttpEntity original = EntityBuilder.create().setText("encoded stuff").setContentEncoding("deFlaTe").build(); response.setEntity(original); Mockito.when(execChain.proceed(request, scope)).thenReturn(response); impl.execute(request, scope, execChain); final HttpEntity entity = response.getEntity(); Assertions.assertNotNull(entity); Assertions.assertTrue(entity instanceof DecompressingEntity); } @Test void testIdentityContentEncoding() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest(Method.GET, host, "/"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); final HttpEntity original = EntityBuilder.create().setText("encoded stuff").setContentEncoding("identity").build(); response.setEntity(original); Mockito.when(execChain.proceed(request, scope)).thenReturn(response); impl.execute(request, scope, execChain); final HttpEntity entity = response.getEntity(); Assertions.assertNotNull(entity); Assertions.assertTrue(entity instanceof StringEntity); } @Test void testBrotliContentEncoding() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest(Method.GET, host, "/"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); final HttpEntity original = EntityBuilder.create().setText("encoded stuff").setContentEncoding("br").build(); response.setEntity(original); Mockito.when(execChain.proceed(request, scope)).thenReturn(response); impl.execute(request, scope, execChain); final HttpEntity entity = response.getEntity(); Assertions.assertNotNull(entity); Assertions.assertTrue(entity instanceof DecompressingEntity); } @Test void testUnknownContentEncoding() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest(Method.GET, host, "/"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); final HttpEntity original = EntityBuilder.create().setText("encoded stuff").setContentEncoding("whatever").build(); response.setEntity(original); impl = new ContentCompressionExec(false); Mockito.when(execChain.proceed(request, scope)).thenReturn(response); Assertions.assertThrows(HttpException.class, () -> impl.execute(request, scope, execChain)); } @Test void testContentEncodingRequestParameter() throws Exception { final ClassicHttpRequest request = new BasicClassicHttpRequest(Method.GET, host, "/"); final ClassicHttpResponse response = new BasicClassicHttpResponse(200, "OK"); final HttpEntity original = EntityBuilder.create().setText("encoded stuff").setContentEncoding("GZip").build(); response.setEntity(original); final RequestConfig config = RequestConfig.custom() .setContentCompressionEnabled(false) .build(); context.setRequestConfig(config); Mockito.when(execChain.proceed(request, scope)).thenReturn(response); impl.execute(request, scope, execChain); final HttpEntity entity = response.getEntity(); Assertions.assertNotNull(entity); Assertions.assertFalse(entity instanceof GzipDecompressingEntity); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestAIMDBackoffManager.java0100664 0000000 0000000 00000023433 14704162040 031036 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertTrue; import java.time.Instant; import java.util.Map; import java.util.Random; import java.util.concurrent.BrokenBarrierException; import java.util.concurrent.CountDownLatch; import java.util.concurrent.CyclicBarrier; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.classic.BackoffManager; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestAIMDBackoffManager { private AIMDBackoffManager impl; private MockConnPoolControl connPerRoute; private HttpRoute route; private static final long DEFAULT_COOL_DOWN_MS = 10; // Adjust this value to match the default cooldown period in AIMDBackoffManager @BeforeEach void setUp() { connPerRoute = new MockConnPoolControl(); route = new HttpRoute(new HttpHost("localhost", 80)); impl = new AIMDBackoffManager(connPerRoute); impl.setPerHostConnectionCap(10); impl.setCoolDown(TimeValue.ofMilliseconds(DEFAULT_COOL_DOWN_MS)); } @Test void isABackoffManager() { assertTrue(impl instanceof BackoffManager); } @Test void halvesConnectionsOnBackoff() { connPerRoute.setMaxPerRoute(route, 4); impl.backOff(route); assertEquals(2, connPerRoute.getMaxPerRoute(route)); } @Test void doesNotBackoffBelowOneConnection() { connPerRoute.setMaxPerRoute(route, 1); impl.backOff(route); assertEquals(1, connPerRoute.getMaxPerRoute(route)); } @Test void increasesByOneOnProbe() { connPerRoute.setMaxPerRoute(route, 2); impl.probe(route); assertEquals(3, connPerRoute.getMaxPerRoute(route)); } @Test void doesNotIncreaseBeyondPerHostMaxOnProbe() { connPerRoute.setDefaultMaxPerRoute(5); connPerRoute.setMaxPerRoute(route, 5); impl.setPerHostConnectionCap(5); impl.probe(route); assertEquals(5, connPerRoute.getMaxPerRoute(route)); } @Test void backoffDoesNotAdjustDuringCoolDownPeriod() { // Arrange connPerRoute.setMaxPerRoute(route, 4); // Act impl.backOff(route); final long max1 = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteBackoffs to simulate that not enough time has passed final Map lastRouteBackoffs = impl.getLastRouteBackoffs(); lastRouteBackoffs.put(route, Instant.now().minusMillis(1)); // Act again impl.backOff(route); final long max2 = connPerRoute.getMaxPerRoute(route); // Assert assertEquals(max1, max2); } @Test void backoffStillAdjustsAfterCoolDownPeriod() { // Arrange: Initialize the maximum number of connections for a route to 8 connPerRoute.setMaxPerRoute(route, 8); // Act: Perform the first backoff operation impl.backOff(route); final long initialMax = connPerRoute.getMaxPerRoute(route); // Act: Simulate that the cooldown period has passed final Map lastRouteBackoffs = impl.getLastRouteBackoffs(); lastRouteBackoffs.put(route, Instant.now().minusMillis(DEFAULT_COOL_DOWN_MS + 1)); // Act: Perform the second backoff operation impl.backOff(route); final long finalMax = connPerRoute.getMaxPerRoute(route); // Assert: Verify that the maximum number of connections has decreased or reached the minimum limit (1) if (initialMax != 1) { assertTrue(finalMax < initialMax, "Max connections should decrease after cooldown"); } else { assertEquals(1, finalMax, "Max connections should remain 1 if it's already at the minimum"); } } @Test void probeDoesNotAdjustDuringCooldownPeriod() { // Arrange connPerRoute.setMaxPerRoute(route, 4); // First probe impl.probe(route); final long max1 = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteProbes to simulate that not enough time has passed final Map lastRouteProbes = impl.getLastRouteProbes(); lastRouteProbes.put(route, Instant.now().minusMillis(1)); // Second probe impl.probe(route); final long max2 = connPerRoute.getMaxPerRoute(route); // Assert assertEquals(max1, max2); } @Test void probeStillAdjustsAfterCoolDownPeriod() { connPerRoute.setMaxPerRoute(route, 8); // First probe impl.probe(route); final long max = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteProbes to simulate that enough time has passed for the cooldown period final Map lastRouteProbes = impl.getLastRouteProbes(); lastRouteProbes.put(route, Instant.now().minusMillis(DEFAULT_COOL_DOWN_MS + 1)); // Second probe impl.probe(route); // Assert that the max connections have increased assertTrue(max < connPerRoute.getMaxPerRoute(route)); } @Test void willBackoffImmediatelyEvenAfterAProbe() { connPerRoute.setMaxPerRoute(route, 8); impl.probe(route); final long max = connPerRoute.getMaxPerRoute(route); impl.backOff(route); assertTrue(connPerRoute.getMaxPerRoute(route) < max); } @Test void backOffFactorIsConfigurable() { connPerRoute.setMaxPerRoute(route, 10); impl.setBackoffFactor(0.9); impl.backOff(route); assertEquals(9, connPerRoute.getMaxPerRoute(route)); } @Test void coolDownPeriodIsConfigurable() { final long cd = new Random().nextInt(500) + 500; // Random cooldown period between 500 and 1000 milliseconds impl.setCoolDown(TimeValue.ofMilliseconds(cd)); // Probe and check if the connection count remains the same during the cooldown period impl.probe(route); final int max0 = connPerRoute.getMaxPerRoute(route); // Manipulate lastRouteProbes to simulate that not enough time has passed final Map lastRouteProbes = impl.getLastRouteProbes(); lastRouteProbes.put(route, Instant.now().minusMillis(cd / 2)); // Probe again impl.probe(route); assertEquals(max0, connPerRoute.getMaxPerRoute(route)); // Manipulate lastRouteProbes to simulate that enough time has passed lastRouteProbes.put(route, Instant.now().minusMillis(cd + 1)); // Probe again impl.probe(route); assertTrue(max0 < connPerRoute.getMaxPerRoute(route)); } @Test void testConcurrency() throws InterruptedException { final int initialMaxPerRoute = 10; final int numberOfThreads = 20; final int numberOfOperationsPerThread = 100; // reduced operations // Create a cyclic barrier that will wait for all threads to be ready before proceeding final CyclicBarrier barrier = new CyclicBarrier(numberOfThreads); final CountDownLatch latch = new CountDownLatch(numberOfThreads); for (int i = 0; i < numberOfThreads; i++) { final HttpRoute threadRoute = new HttpRoute(new HttpHost("localhost", 8080 + i)); // Each thread gets its own route connPerRoute.setMaxPerRoute(threadRoute, initialMaxPerRoute); new Thread(() -> { try { // Wait for all threads to be ready barrier.await(); // Run operations for (int j = 0; j < numberOfOperationsPerThread; j++) { if (Math.random() < 0.5) { impl.backOff(threadRoute); } else { impl.probe(threadRoute); } } } catch (InterruptedException | BrokenBarrierException e) { Thread.currentThread().interrupt(); } finally { latch.countDown(); } }).start(); } latch.await(); // Check that the final value for each route is within an acceptable range for (int i = 0; i < numberOfThreads; i++) { final HttpRoute threadRoute = new HttpRoute(new HttpHost("localhost", 8080 + i)); final int finalMaxPerRoute = connPerRoute.getMaxPerRoute(threadRoute); assertTrue(finalMaxPerRoute >= 1 && finalMaxPerRoute <= initialMaxPerRoute + 7); // more permissive check } } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestCloseableHttpClient.java0100664 0000000 0000000 00000014646 14704162040 031453 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.IOException; import java.io.InputStream; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.ClassicHttpResponse; import org.apache.hc.core5.http.HttpEntity; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.io.HttpClientResponseHandler; import org.apache.hc.core5.http.protocol.HttpContext; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mockito; /** * Simple tests for {@link CloseableHttpClient}. */ @SuppressWarnings({"boxing","static-access"}) // test code class TestCloseableHttpClient { static abstract class NoopCloseableHttpClient extends CloseableHttpClient { @Override protected CloseableHttpResponse doExecute( final HttpHost target, final ClassicHttpRequest request, final HttpContext context) { return null; } } private NoopCloseableHttpClient client; private InputStream content; private HttpEntity entity; private ClassicHttpResponse originResponse; private CloseableHttpResponse response; @BeforeEach void setup() throws Exception { content = Mockito.mock(InputStream.class); entity = Mockito.mock(HttpEntity.class); originResponse = Mockito.mock(ClassicHttpResponse.class); response = CloseableHttpResponse.adapt(originResponse); Mockito.when(entity.getContent()).thenReturn(content); Mockito.when(entity.isStreaming()).thenReturn(Boolean.TRUE); Mockito.when(response.getEntity()).thenReturn(entity); client = Mockito.mock(NoopCloseableHttpClient.class, Mockito.CALLS_REAL_METHODS); } @Test void testExecuteRequestAbsoluteURI() throws Exception { final HttpGet httpget = new HttpGet("https://somehost:444/stuff"); Mockito.when(client.doExecute( Mockito.any(), Mockito.any(), Mockito.any())).thenReturn(response); client.execute(httpget, response -> null); Mockito.verify(client).doExecute( Mockito.eq(new HttpHost("https", "somehost", 444)), Mockito.same(httpget), (HttpContext) Mockito.isNull()); } @Test void testExecuteRequestRelativeURI() throws Exception { final HttpGet httpget = new HttpGet("/stuff"); Mockito.when(client.doExecute( Mockito.any(), Mockito.any(), Mockito.any())).thenReturn(response); client.execute(httpget, response -> null); Mockito.verify(client).doExecute( (HttpHost) Mockito.isNull(), Mockito.same(httpget), (HttpContext) Mockito.isNull()); } @Test void testExecuteRequestHandleResponse() throws Exception { final HttpGet httpget = new HttpGet("https://somehost:444/stuff"); Mockito.when(client.doExecute( new HttpHost("https", "somehost", 444), httpget, null)).thenReturn(response); final HttpClientResponseHandler handler = Mockito.mock(HttpClientResponseHandler.class); client.execute(httpget, handler); Mockito.verify(client).doExecute( Mockito.eq(new HttpHost("https", "somehost", 444)), Mockito.same(httpget), (HttpContext) Mockito.isNull()); Mockito.verify(handler).handleResponse(response); Mockito.verify(content).close(); } @Test void testExecuteRequestHandleResponseIOException() throws Exception { final HttpGet httpget = new HttpGet("https://somehost:444/stuff"); Mockito.when(client.doExecute( new HttpHost("https", "somehost", 444), httpget, null)).thenReturn(response); final HttpClientResponseHandler handler = Mockito.mock(HttpClientResponseHandler.class); Mockito.when(handler.handleResponse(response)).thenThrow(new IOException()); Assertions.assertThrows(IOException.class, () -> client.execute(httpget, handler)); Mockito.verify(client).doExecute( Mockito.eq(new HttpHost("https", "somehost", 444)), Mockito.same(httpget), (HttpContext) Mockito.isNull()); Mockito.verify(originResponse).close(); } @Test void testExecuteRequestHandleResponseHttpException() throws Exception { final HttpGet httpget = new HttpGet("https://somehost:444/stuff"); Mockito.when(client.doExecute( new HttpHost("https", "somehost", 444), httpget, null)).thenReturn(response); final HttpClientResponseHandler handler = Mockito.mock(HttpClientResponseHandler.class); Mockito.when(handler.handleResponse(response)).thenThrow(new RuntimeException()); Assertions.assertThrows(RuntimeException.class, () -> client.execute(httpget, handler)); Mockito.verify(client).doExecute( Mockito.eq(new HttpHost("https", "somehost", 444)), Mockito.same(httpget), (HttpContext) Mockito.isNull()); Mockito.verify(originResponse).close(); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/classic/TestInternalHttpClient.java0100664 0000000 0000000 00000024427 15005672035 031341 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.classic; import java.io.Closeable; import java.io.IOException; import java.util.Arrays; import org.apache.hc.client5.http.ClientProtocolException; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.CredentialsProvider; import org.apache.hc.client5.http.classic.ExecChainHandler; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.cookie.CookieSpecFactory; import org.apache.hc.client5.http.cookie.CookieStore; import org.apache.hc.client5.http.io.HttpClientConnectionManager; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.routing.HttpRoutePlanner; import org.apache.hc.core5.http.ClassicHttpRequest; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.impl.io.HttpRequestExecutor; import org.apache.hc.core5.http.io.support.ClassicRequestBuilder; import org.apache.hc.core5.http.message.BasicClassicHttpResponse; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; /** * Simple tests for {@link InternalHttpClient}. */ class TestInternalHttpClient { @Mock private HttpClientConnectionManager connManager; @Mock private HttpRequestExecutor requestExecutor; @Mock private ExecChainHandler execChain; @Mock private HttpRoutePlanner routePlanner; @Mock private Lookup cookieSpecRegistry; @Mock private Lookup authSchemeRegistry; @Mock private CookieStore cookieStore; @Mock private CredentialsProvider credentialsProvider; @Mock private RequestConfig defaultConfig; @Mock private Closeable closeable1; @Mock private Closeable closeable2; private InternalHttpClient client; @BeforeEach void setup() { MockitoAnnotations.openMocks(this); client = new InternalHttpClient(connManager, requestExecutor, new ExecChainElement(execChain, null), routePlanner, cookieSpecRegistry, authSchemeRegistry, cookieStore, credentialsProvider, HttpClientContext::castOrCreate, defaultConfig, Arrays.asList(closeable1, closeable2)); } @Test void testExecute() throws Exception { final HttpGet httpget = new HttpGet("http://somehost/stuff"); final HttpRoute route = new HttpRoute(new HttpHost("somehost", 80)); Mockito.when(routePlanner.determineRoute( Mockito.eq(new HttpHost("somehost")), Mockito.any(), Mockito.any())).thenReturn(route); Mockito.when(execChain.execute( Mockito.any(), Mockito.any(), Mockito.any())).thenReturn( CloseableHttpResponse.adapt(new BasicClassicHttpResponse(200))); client.execute(httpget, response -> null); Mockito.verify(execChain).execute( Mockito.any(), Mockito.any(), Mockito.any()); } @Test void testExecuteHttpException() throws Exception { final HttpGet httpget = new HttpGet("http://somehost/stuff"); final HttpRoute route = new HttpRoute(new HttpHost("somehost", 80)); Mockito.when(routePlanner.determineRoute( Mockito.eq(new HttpHost("somehost")), Mockito.any(), Mockito.any())).thenReturn(route); Mockito.when(execChain.execute( Mockito.any(), Mockito.any(), Mockito.any())).thenReturn( CloseableHttpResponse.adapt(new BasicClassicHttpResponse(200))); Mockito.when(execChain.execute( Mockito.any(), Mockito.any(), Mockito.any())).thenThrow(new HttpException()); Assertions.assertThrows(ClientProtocolException.class, () -> client.execute(httpget, response -> null)); } @Test void testExecuteDefaultContext() throws Exception { final HttpGet httpget = new HttpGet("http://somehost/stuff"); final HttpRoute route = new HttpRoute(new HttpHost("somehost", 80)); Mockito.when(routePlanner.determineRoute( Mockito.eq(new HttpHost("somehost")), Mockito.any(), Mockito.any())).thenReturn(route); Mockito.when(execChain.execute( Mockito.any(), Mockito.any(), Mockito.any())).thenReturn( CloseableHttpResponse.adapt(new BasicClassicHttpResponse(200))); final HttpClientContext context = HttpClientContext.create(); client.execute(httpget, context, response -> null); Assertions.assertSame(cookieSpecRegistry, context.getCookieSpecRegistry()); Assertions.assertSame(authSchemeRegistry, context.getAuthSchemeRegistry()); Assertions.assertSame(cookieStore, context.getCookieStore()); Assertions.assertSame(credentialsProvider, context.getCredentialsProvider()); Assertions.assertSame(defaultConfig, context.getRequestConfigOrDefault()); } @Test void testExecuteRequestConfig() throws Exception { final HttpGet httpget = new HttpGet("http://somehost/stuff"); final HttpRoute route = new HttpRoute(new HttpHost("somehost", 80)); Mockito.when(routePlanner.determineRoute( Mockito.eq(new HttpHost("somehost")), Mockito.any(), Mockito.any())).thenReturn(route); Mockito.when(execChain.execute( Mockito.any(), Mockito.any(), Mockito.any())).thenReturn( CloseableHttpResponse.adapt(new BasicClassicHttpResponse(200))); final RequestConfig config = RequestConfig.custom().build(); httpget.setConfig(config); final HttpClientContext context = HttpClientContext.create(); client.execute(httpget, context, response -> null); Assertions.assertSame(config, context.getRequestConfigOrDefault()); } @Test void testExecuteLocalContext() throws Exception { final HttpGet httpget = new HttpGet("http://somehost/stuff"); final HttpRoute route = new HttpRoute(new HttpHost("somehost", 80)); Mockito.when(routePlanner.determineRoute( Mockito.eq(new HttpHost("somehost")), Mockito.any(), Mockito.any())).thenReturn(route); Mockito.when(execChain.execute( Mockito.any(), Mockito.any(), Mockito.any())).thenReturn( CloseableHttpResponse.adapt(new BasicClassicHttpResponse(200))); final HttpClientContext context = HttpClientContext.create(); final Lookup localCookieSpecRegistry = Mockito.mock(Lookup.class); final Lookup localAuthSchemeRegistry = Mockito.mock(Lookup.class); final CookieStore localCookieStore = Mockito.mock(CookieStore.class); final CredentialsProvider localCredentialsProvider = Mockito.mock(CredentialsProvider.class); final RequestConfig localConfig = RequestConfig.custom().build(); context.setCookieSpecRegistry(localCookieSpecRegistry); context.setAuthSchemeRegistry(localAuthSchemeRegistry); context.setCookieStore(localCookieStore); context.setCredentialsProvider(localCredentialsProvider); context.setRequestConfig(localConfig); client.execute(httpget, context, response -> null); Assertions.assertSame(localCookieSpecRegistry, context.getCookieSpecRegistry()); Assertions.assertSame(localAuthSchemeRegistry, context.getAuthSchemeRegistry()); Assertions.assertSame(localCookieStore, context.getCookieStore()); Assertions.assertSame(localCredentialsProvider, context.getCredentialsProvider()); Assertions.assertSame(localConfig, context.getRequestConfigOrDefault()); } @Test void testClientClose() throws Exception { client.close(); Mockito.verify(closeable1).close(); Mockito.verify(closeable2).close(); } @Test void testClientCloseIOException() throws Exception { Mockito.doThrow(new IOException()).when(closeable1).close(); client.close(); Mockito.verify(closeable1).close(); Mockito.verify(closeable2).close(); } @Test void testDoExecuteThrowsWhenNoTargetOrHost() throws Exception { final ClassicHttpRequest request = ClassicRequestBuilder.get("/foo").build(); final HttpClientContext context = HttpClientContext.create(); Mockito.when(routePlanner.determineRoute( Mockito.eq(null), Mockito.any(), Mockito.any())).thenThrow(new ProtocolException()); Assertions.assertThrows(ClientProtocolException.class, () -> client.execute(null, request, context)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/TestLaxRedirectStrategy.java0100664 0000000 0000000 00000006361 15063503632 030073 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.classic.methods.HttpDelete; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpHead; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.classic.methods.HttpPut; import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.protocol.HttpContext; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; class TestLaxRedirectStrategy { @Test void testIsRedirectedWithHttpGet() { testIsRedirected(new HttpGet("/get"), true); } @Test void testIsRedirectedWithHttpPost() { testIsRedirected(new HttpPost("/post"), true); } @Test void testIsRedirectedWithHttpHead() { testIsRedirected(new HttpHead("/head"), true); } @Test void testIsRedirectedWithHttpDelete() { testIsRedirected(new HttpDelete("/delete"), true); } @Test void testIsRedirectedWithNonRedirectMethod() { testIsRedirected(new HttpPut("/put"), false); } private void testIsRedirected(final HttpRequest request, final boolean expected) { final LaxRedirectStrategy strategy = new LaxRedirectStrategy(); final HttpResponse response = mock(HttpResponse.class); final HttpContext context = mock(HttpContext.class); // Mock the response to simulate a redirect with a Location header when(response.getCode()).thenReturn(HttpStatus.SC_MOVED_TEMPORARILY); when(response.containsHeader("Location")).thenReturn(true); when(response.getFirstHeader("location")).thenReturn(mock(org.apache.hc.core5.http.Header.class)); when(response.getFirstHeader("location").getValue()).thenReturn("http://localhost/redirect"); assertEquals(expected, strategy.isRedirected(request, response, context)); } }httpclient5/src/test/java/org/apache/hc/client5/http/impl/nio/0040775 0000000 0000000 00000000000 15034701711 023215 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/nio/H2SharingConnPoolTest.java0100664 0000000 0000000 00000040200 15034701711 030146 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.nio; import java.util.concurrent.Future; import java.util.concurrent.atomic.AtomicReference; import org.apache.hc.core5.concurrent.BasicFuture; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.http.HttpVersion; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.pool.ManagedConnPool; import org.apache.hc.core5.pool.PoolEntry; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; public class H2SharingConnPoolTest { static final String DEFAULT_ROUTE = "DEFAULT_ROUTE"; @Mock ManagedConnPool connPool; @Mock FutureCallback> callback; @Mock HttpConnection connection; H2SharingConnPool h2SharingPool; @BeforeEach void setup() { MockitoAnnotations.openMocks(this); h2SharingPool = new H2SharingConnPool<>(connPool); } @Test void testLeaseFutureReturned() throws Exception { Mockito.when(connPool.lease( Mockito.eq(DEFAULT_ROUTE), Mockito.any(), Mockito.any(), Mockito.any())).thenReturn(new BasicFuture<>(null)); final Future> result = h2SharingPool.lease(DEFAULT_ROUTE, null, Timeout.ONE_MILLISECOND, callback); Assertions.assertNotNull(result); Assertions.assertFalse(result.isDone()); Mockito.verify(connPool).lease( Mockito.eq(DEFAULT_ROUTE), Mockito.eq(null), Mockito.eq(Timeout.ONE_MILLISECOND), Mockito.any()); Mockito.verify(callback, Mockito.never()).completed( Mockito.any()); } @Test void testLeaseExistingConnectionReturned() throws Exception { final PoolEntry poolEntry = new PoolEntry<>(DEFAULT_ROUTE); final HttpConnection conn = Mockito.mock(HttpConnection.class); Mockito.when(conn.isOpen()).thenReturn(true); poolEntry.assignConnection(conn); final H2SharingConnPool.PerRoutePool routePool = h2SharingPool.getPerRoutePool(DEFAULT_ROUTE); routePool.track(poolEntry); final Future> future = h2SharingPool.lease(DEFAULT_ROUTE, null, Timeout.ONE_MILLISECOND, callback); Assertions.assertNotNull(future); Assertions.assertSame(poolEntry, future.get()); Mockito.verify(connPool, Mockito.never()).lease( Mockito.eq(DEFAULT_ROUTE), Mockito.any(), Mockito.any(), Mockito.any()); Mockito.verify(callback).completed(Mockito.same(poolEntry)); } @Test void testLeaseWithStateCacheBypassed() throws Exception { final PoolEntry poolEntry = new PoolEntry<>(DEFAULT_ROUTE); final H2SharingConnPool.PerRoutePool routePool = h2SharingPool.getPerRoutePool(DEFAULT_ROUTE); routePool.track(poolEntry); Mockito.when(connPool.lease( Mockito.eq(DEFAULT_ROUTE), Mockito.any(), Mockito.any(), Mockito.any())).thenReturn(new BasicFuture<>(null)); final Future> result = h2SharingPool.lease(DEFAULT_ROUTE, "stuff", Timeout.ONE_MILLISECOND, callback); Assertions.assertNotNull(result); Assertions.assertFalse(result.isDone()); Mockito.verify(connPool).lease( Mockito.eq(DEFAULT_ROUTE), Mockito.eq("stuff"), Mockito.eq(Timeout.ONE_MILLISECOND), Mockito.any()); Mockito.verify(callback, Mockito.never()).completed( Mockito.any()); } @Test void testLeaseNewConnectionReturnedAndCached() throws Exception { final AtomicReference>> futureRef = new AtomicReference<>(); Mockito.when(connPool.lease( Mockito.eq(DEFAULT_ROUTE), Mockito.any(), Mockito.any(), Mockito.any())).thenAnswer(invocationOnMock -> { final BasicFuture> future = new BasicFuture<>(invocationOnMock.getArgument(3)); futureRef.set(future); return future; }); final Future> result = h2SharingPool.lease(DEFAULT_ROUTE, null, Timeout.ONE_MILLISECOND, callback); final BasicFuture> future = futureRef.get(); Assertions.assertNotNull(future); final PoolEntry poolEntry = new PoolEntry<>(DEFAULT_ROUTE); poolEntry.assignConnection(connection); Mockito.when(connection.getProtocolVersion()).thenReturn(HttpVersion.HTTP_2); future.completed(poolEntry); Assertions.assertTrue(result.isDone()); Mockito.verify(connPool).lease( Mockito.eq(DEFAULT_ROUTE), Mockito.eq(null), Mockito.eq(Timeout.ONE_MILLISECOND), Mockito.any()); Mockito.verify(callback).completed( Mockito.any()); final H2SharingConnPool.PerRoutePool routePool = h2SharingPool.getPerRoutePool(DEFAULT_ROUTE); Assertions.assertEquals(1, routePool.getCount(poolEntry)); } @Test void testLeaseNewConnectionReturnedAndNotCached() throws Exception { final AtomicReference>> futureRef = new AtomicReference<>(); Mockito.when(connPool.lease( Mockito.eq(DEFAULT_ROUTE), Mockito.any(), Mockito.any(), Mockito.any())).thenAnswer(invocationOnMock -> { final BasicFuture> future = new BasicFuture<>(invocationOnMock.getArgument(3)); futureRef.set(future); return future; }); final Future> result = h2SharingPool.lease(DEFAULT_ROUTE, null, Timeout.ONE_MILLISECOND, callback); final BasicFuture> future = futureRef.get(); Assertions.assertNotNull(future); final PoolEntry poolEntry = new PoolEntry<>(DEFAULT_ROUTE); poolEntry.assignConnection(connection); Mockito.when(connection.getProtocolVersion()).thenReturn(HttpVersion.HTTP_1_1); future.completed(poolEntry); Assertions.assertTrue(result.isDone()); Mockito.verify(connPool).lease( Mockito.eq(DEFAULT_ROUTE), Mockito.eq(null), Mockito.eq(Timeout.ONE_MILLISECOND), Mockito.any()); Mockito.verify(callback).completed( Mockito.any()); final H2SharingConnPool.PerRoutePool routePool = h2SharingPool.getPerRoutePool(DEFAULT_ROUTE); Assertions.assertEquals(0, routePool.getCount(poolEntry)); } @Test void testLeaseNoConnection() throws Exception { final AtomicReference>> futureRef = new AtomicReference<>(); Mockito.when(connPool.lease( Mockito.eq(DEFAULT_ROUTE), Mockito.any(), Mockito.any(), Mockito.any())).thenAnswer(invocationOnMock -> { final BasicFuture> future = new BasicFuture<>(invocationOnMock.getArgument(3)); futureRef.set(future); return future; }); final Future> result = h2SharingPool.lease(DEFAULT_ROUTE, null, Timeout.ONE_MILLISECOND, callback); final BasicFuture> future = futureRef.get(); Assertions.assertNotNull(future); final PoolEntry poolEntry = new PoolEntry<>(DEFAULT_ROUTE); poolEntry.discardConnection(CloseMode.IMMEDIATE); future.completed(poolEntry); Assertions.assertTrue(result.isDone()); Mockito.verify(connPool).lease( Mockito.eq(DEFAULT_ROUTE), Mockito.eq(null), Mockito.eq(Timeout.ONE_MILLISECOND), Mockito.any()); Mockito.verify(callback).completed( Mockito.any()); final H2SharingConnPool.PerRoutePool routePool = h2SharingPool.getPerRoutePool(DEFAULT_ROUTE); Assertions.assertEquals(0, routePool.getCount(poolEntry)); } @Test void testLeaseWithStateNewConnectionReturnedAndNotCached() throws Exception { final AtomicReference>> futureRef = new AtomicReference<>(); Mockito.when(connPool.lease( Mockito.eq(DEFAULT_ROUTE), Mockito.any(), Mockito.any(), Mockito.any())).thenAnswer(invocationOnMock -> { final BasicFuture> future = new BasicFuture<>(invocationOnMock.getArgument(3)); futureRef.set(future); return future; }); final Future> result = h2SharingPool.lease(DEFAULT_ROUTE, "stuff", Timeout.ONE_MILLISECOND, callback); final BasicFuture> future = futureRef.get(); Assertions.assertNotNull(future); final PoolEntry poolEntry = new PoolEntry<>(DEFAULT_ROUTE); poolEntry.assignConnection(connection); Mockito.when(connection.getProtocolVersion()).thenReturn(HttpVersion.HTTP_2); future.completed(poolEntry); Assertions.assertTrue(result.isDone()); Mockito.verify(connPool).lease( Mockito.eq(DEFAULT_ROUTE), Mockito.eq("stuff"), Mockito.eq(Timeout.ONE_MILLISECOND), Mockito.any()); Mockito.verify(callback).completed( Mockito.any()); final H2SharingConnPool.PerRoutePool routePool = h2SharingPool.getPerRoutePool(DEFAULT_ROUTE); Assertions.assertEquals(0, routePool.getCount(poolEntry)); } @Test void testReleaseReusableNoCacheReturnedToPool() throws Exception { final PoolEntry poolEntry = new PoolEntry<>(DEFAULT_ROUTE); poolEntry.assignConnection(connection); Mockito.when(connection.isOpen()).thenReturn(true); h2SharingPool.release(poolEntry, true); Mockito.verify(connPool).release( Mockito.same(poolEntry), Mockito.eq(true)); } @Test void testReleaseReusableNotInCacheReturnedToPool() throws Exception { final PoolEntry poolEntry = new PoolEntry<>(DEFAULT_ROUTE); poolEntry.assignConnection(connection); Mockito.when(connection.isOpen()).thenReturn(true); final H2SharingConnPool.PerRoutePool routePool = h2SharingPool.getPerRoutePool(DEFAULT_ROUTE); routePool.track(poolEntry); h2SharingPool.release(poolEntry, true); Mockito.verify(connPool).release( Mockito.same(poolEntry), Mockito.eq(true)); } @Test void testReleaseReusableInCacheNotReturnedToPool() throws Exception { final PoolEntry poolEntry = new PoolEntry<>(DEFAULT_ROUTE); poolEntry.assignConnection(connection); Mockito.when(connection.isOpen()).thenReturn(true); final H2SharingConnPool.PerRoutePool routePool = h2SharingPool.getPerRoutePool(DEFAULT_ROUTE); routePool.track(poolEntry); routePool.track(poolEntry); h2SharingPool.release(poolEntry, true); Mockito.verify(connPool, Mockito.never()).release( Mockito.same(poolEntry), Mockito.anyBoolean()); } /** * Same connection can only be released once. * Attempting to release it again will throw: IllegalStateException("Pool entry is not present in the set of leased entries") * * @see org.apache.hc.core5.pool.LaxConnPool.PerRoutePool#removeLeased(PoolEntry) * @see org.apache.hc.core5.pool.StrictConnPool#release(PoolEntry, boolean) */ @Test void testReleaseNonReusableNotInCacheReturnedToPool() throws Exception { final PoolEntry poolEntry = new PoolEntry<>(DEFAULT_ROUTE); poolEntry.assignConnection(connection); Mockito.when(connection.isOpen()).thenReturn(false); final H2SharingConnPool.PerRoutePool routePool = h2SharingPool.getPerRoutePool(DEFAULT_ROUTE); routePool.track(poolEntry); routePool.track(poolEntry); final AtomicReference connRef = new AtomicReference<>(connection); Mockito.doAnswer(invocation -> { final PoolEntry entry = invocation.getArgument(0); if (!connRef.compareAndSet(entry.getConnection(), null)) { throw new IllegalStateException("Pool entry is not present in the set of leased entries"); } return null; }).when(connPool).release(Mockito.eq(poolEntry), Mockito.anyBoolean()); h2SharingPool.release(poolEntry, false); // for reproduce https://issues.apache.org/jira/browse/HTTPCLIENT-2379 Assertions.assertThrows(IllegalStateException.class, () -> h2SharingPool.release(poolEntry, false)); } @Test void testClose() throws Exception { h2SharingPool.close(); Mockito.verify(connPool).close(); } @Test void testCloseMode() throws Exception { h2SharingPool.close(CloseMode.IMMEDIATE); Mockito.verify(connPool).close(CloseMode.IMMEDIATE); } @Test void testLeasePoolClosed() throws Exception { h2SharingPool.close(); Assertions.assertThrows(IllegalStateException.class, () -> h2SharingPool.lease(DEFAULT_ROUTE, null, Timeout.ONE_MILLISECOND, callback)); } @Test void testReleasePoolClosed() throws Exception { final PoolEntry poolEntry = new PoolEntry<>(DEFAULT_ROUTE); poolEntry.assignConnection(connection); Mockito.when(connection.isOpen()).thenReturn(false); final H2SharingConnPool.PerRoutePool routePool = h2SharingPool.getPerRoutePool(DEFAULT_ROUTE); routePool.track(poolEntry); h2SharingPool.close(); h2SharingPool.release(poolEntry, true); Mockito.verify(connPool).release( Mockito.same(poolEntry), Mockito.eq(true)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/nio/H2SharingPerRoutePoolTest.java0100664 0000000 0000000 00000010567 15034701711 031033 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.nio; import org.apache.hc.core5.http.HttpConnection; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.pool.PoolEntry; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mockito; public class H2SharingPerRoutePoolTest { static PoolEntry createMockEntry() { final PoolEntry poolEntry = new PoolEntry<>("some route"); final HttpConnection conn = Mockito.mock(HttpConnection.class); Mockito.when(conn.isOpen()).thenReturn(true); poolEntry.assignConnection(conn); return poolEntry; } H2SharingConnPool.PerRoutePool pool; PoolEntry poolEntry1; PoolEntry poolEntry2; @BeforeEach void setup() { pool = new H2SharingConnPool.PerRoutePool<>(); poolEntry1 = createMockEntry(); poolEntry2 = createMockEntry(); } @Test void testKeep() { Assertions.assertEquals(1, pool.track(poolEntry1)); Assertions.assertEquals(2, pool.track(poolEntry1)); Assertions.assertEquals(1, pool.track(poolEntry2)); Assertions.assertEquals(3, pool.track(poolEntry1)); } @Test void testLeaseLeastUsed() { pool.track(poolEntry1); pool.track(poolEntry1); pool.track(poolEntry2); Assertions.assertSame(poolEntry2, pool.lease()); Assertions.assertEquals(2, pool.getCount(poolEntry2)); final PoolEntry poolEntry = pool.lease(); Assertions.assertEquals(3, pool.getCount(poolEntry)); } @Test void testLeaseEmptyPool() { Assertions.assertNull(pool.lease()); } @Test void testReleaseReusable() { pool.track(poolEntry1); pool.track(poolEntry1); pool.track(poolEntry1); Assertions.assertEquals(2, pool.release(poolEntry1, true)); Assertions.assertEquals(1, pool.release(poolEntry1, true)); Assertions.assertEquals(0, pool.release(poolEntry1, true)); Assertions.assertEquals(0, pool.release(poolEntry1, true)); } @Test void testReleaseNonReusable() { pool.track(poolEntry1); pool.track(poolEntry1); pool.track(poolEntry1); Assertions.assertEquals(2, pool.release(poolEntry1, false)); // 3 → 2 } @Test void testReleaseNonPresent() { Assertions.assertEquals(0, pool.release(poolEntry1, true)); Assertions.assertEquals(0, pool.release(poolEntry2, true)); } @Test void testReleaseConnectionClosed() { pool.track(poolEntry1); pool.track(poolEntry1); pool.track(poolEntry1); Mockito.when(poolEntry1.getConnection().isOpen()).thenReturn(false); Assertions.assertEquals(2, pool.release(poolEntry1, true)); // 3 → 2 } @Test void testReleaseConnectionMissing() { pool.track(poolEntry1); pool.track(poolEntry1); pool.track(poolEntry1); poolEntry1.discardConnection(CloseMode.IMMEDIATE); Assertions.assertEquals(2, pool.release(poolEntry1, true)); // 3 → 2 } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/nio/MultihomeIOSessionRequesterTest.java0100664 0000000 0000000 00000015447 15005672016 032372 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.nio; import 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; import static org.junit.jupiter.api.Assertions.fail; import static org.mockito.ArgumentMatchers.any; import java.io.IOException; import java.net.InetAddress; import java.net.InetSocketAddress; import java.util.Arrays; import java.util.List; import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.core5.concurrent.FutureCallback; import org.apache.hc.core5.net.NamedEndpoint; import org.apache.hc.core5.reactor.ConnectionInitiator; import org.apache.hc.core5.reactor.IOSession; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mockito; class MultihomeIOSessionRequesterTest { private DnsResolver dnsResolver; private ConnectionInitiator connectionInitiator; private MultihomeIOSessionRequester sessionRequester; private NamedEndpoint namedEndpoint; @BeforeEach void setUp() { dnsResolver = Mockito.mock(DnsResolver.class); connectionInitiator = Mockito.mock(ConnectionInitiator.class); namedEndpoint = Mockito.mock(NamedEndpoint.class); sessionRequester = new MultihomeIOSessionRequester(dnsResolver); } @Test void testConnectWithMultipleAddresses() throws Exception { final InetAddress address1 = InetAddress.getByAddress(new byte[]{10, 0, 0, 1}); final InetAddress address2 = InetAddress.getByAddress(new byte[]{10, 0, 0, 2}); final List remoteAddresses = Arrays.asList( new InetSocketAddress(address1, 8080), new InetSocketAddress(address2, 8080) ); Mockito.when(namedEndpoint.getHostName()).thenReturn("somehost"); Mockito.when(namedEndpoint.getPort()).thenReturn(8080); Mockito.when(dnsResolver.resolve("somehost", 8080)).thenReturn(remoteAddresses); Mockito.when(connectionInitiator.connect(any(), any(), any(), any(), any(), any())) .thenAnswer(invocation -> { final FutureCallback callback = invocation.getArgument(5); // Simulate a failure for the first connection attempt final CompletableFuture future = new CompletableFuture<>(); callback.failed(new IOException("Simulated connection failure")); future.completeExceptionally(new IOException("Simulated connection failure")); return future; }); final Future future = sessionRequester.connect( connectionInitiator, namedEndpoint, null, Timeout.ofMilliseconds(500), null, null ); assertTrue(future.isDone()); try { future.get(); fail("Expected ExecutionException"); } catch (final ExecutionException ex) { assertInstanceOf(IOException.class, ex.getCause()); assertEquals("Simulated connection failure", ex.getCause().getMessage()); } } @Test void testConnectSuccessfulAfterRetries() throws Exception { final InetAddress address1 = InetAddress.getByAddress(new byte[]{10, 0, 0, 1}); final InetAddress address2 = InetAddress.getByAddress(new byte[]{10, 0, 0, 2}); final List remoteAddresses = Arrays.asList( new InetSocketAddress(address1, 8080), new InetSocketAddress(address2, 8080) ); Mockito.when(namedEndpoint.getHostName()).thenReturn("somehost"); Mockito.when(namedEndpoint.getPort()).thenReturn(8080); Mockito.when(dnsResolver.resolve("somehost", 8080)).thenReturn(remoteAddresses); Mockito.when(connectionInitiator.connect(any(), any(), any(), any(), any(), any())) .thenAnswer(invocation -> { final FutureCallback callback = invocation.getArgument(5); final InetSocketAddress remoteAddress = invocation.getArgument(1); final CompletableFuture future = new CompletableFuture<>(); if (remoteAddress.getAddress().equals(address1)) { // Fail the first address callback.failed(new IOException("Simulated connection failure")); future.completeExceptionally(new IOException("Simulated connection failure")); } else { // Succeed for the second address final IOSession mockSession = Mockito.mock(IOSession.class); callback.completed(mockSession); future.complete(mockSession); } return future; }); final Future future = sessionRequester.connect( connectionInitiator, namedEndpoint, null, Timeout.ofMilliseconds(500), null, null ); assertTrue(future.isDone()); try { final IOSession session = future.get(); assertNotNull(session); } catch (final ExecutionException ex) { fail("Did not expect an ExecutionException", ex); } } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/PrefixedIncrementingIdTest.java0100664 0000000 0000000 00000004237 14704162040 030523 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class PrefixedIncrementingIdTest { @Test void testGetNextId() { final PrefixedIncrementingId testId = new PrefixedIncrementingId("test-"); Assertions.assertEquals(String.format("test-%010d", 1), testId.getNextId()); Assertions.assertEquals(String.format("test-%010d", 2), testId.getNextId()); } @Test void testCreateId() { final PrefixedIncrementingId exchangeId = new PrefixedIncrementingId("ex-"); Assertions.assertEquals(String.format("ex-%010d", 0), exchangeId.createId(0)); for (long i = 1; i <= 100_000_000L; i *= 10) { Assertions.assertEquals(String.format("ex-%010d", i - 1), exchangeId.createId(i - 1)); Assertions.assertEquals(String.format("ex-%010d", i), exchangeId.createId(i)); Assertions.assertEquals(String.format("ex-%010d", i + 1), exchangeId.createId(i + 1)); } } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/InMemoryDnsResolverTest.java0100664 0000000 0000000 00000005256 14704162040 030065 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import static org.junit.jupiter.api.Assertions.assertArrayEquals; import static org.junit.jupiter.api.Assertions.assertEquals; import java.net.InetAddress; import java.net.UnknownHostException; import org.junit.jupiter.api.Test; /** * Tests {@link InMemoryDnsResolver}. */ class InMemoryDnsResolverTest { @Test void resolve() throws UnknownHostException { final InMemoryDnsResolver resolver = new InMemoryDnsResolver(); final String hostString = "127.0.0.1"; final byte[] address = new byte[] { 127, 0, 0, 1 }; resolver.add(hostString, InetAddress.getByAddress(hostString, address)); final InetAddress[] result1 = resolver.resolve(hostString); assertEquals(1, result1.length); assertArrayEquals(address, result1[0].getAddress()); } @Test void resolveIPv6ZoneId() throws UnknownHostException { final InMemoryDnsResolver resolver = new InMemoryDnsResolver(); final String hostStr = "[fe80::221:b7ff:fe8a:57d5%en4]"; final byte[] address = new byte[] { (byte) 0xfe, (byte) 0x80, 0, 0, 0, 0, 0, 0, 0x02, 0x21, (byte) 0xb7, (byte) 0xff, (byte) 0xfe, (byte) 0x8a, 0x57, (byte) 0xd5 }; resolver.add(hostStr, InetAddress.getByAddress(hostStr, address)); // This is an IPv6 address literal with zone ID final InetAddress[] result = resolver.resolve(hostStr); assertEquals(1, result.length); assertArrayEquals(address, result[0].getAddress()); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/TestAuthenticationStrategy.java0100664 0000000 0000000 00000017153 14704162040 030640 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Locale; import java.util.Map; import org.apache.hc.client5.http.auth.AuthChallenge; import org.apache.hc.client5.http.auth.AuthScheme; import org.apache.hc.client5.http.auth.AuthSchemeFactory; import org.apache.hc.client5.http.auth.AuthScope; import org.apache.hc.client5.http.auth.ChallengeType; import org.apache.hc.client5.http.auth.StandardAuthScheme; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.impl.auth.BasicScheme; import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory; import org.apache.hc.client5.http.impl.auth.CredentialsProviderBuilder; import org.apache.hc.client5.http.impl.auth.DigestScheme; import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.config.Registry; import org.apache.hc.core5.http.config.RegistryBuilder; import org.apache.hc.core5.http.message.BasicNameValuePair; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Simple tests for {@link DefaultAuthenticationStrategy}. */ @SuppressWarnings("boxing") // test code class TestAuthenticationStrategy { @Test void testSelectInvalidInput() { final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); final HttpClientContext context = HttpClientContext.create(); Assertions.assertThrows(NullPointerException.class, () -> authStrategy.select(null, Collections.emptyMap(), context)); Assertions.assertThrows(NullPointerException.class, () -> authStrategy.select(ChallengeType.TARGET, null, context)); Assertions.assertThrows(NullPointerException.class, () -> authStrategy.select(ChallengeType.TARGET, Collections.emptyMap(), null)); } @Test void testSelectNoSchemeRegistry() { final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); final HttpClientContext context = HttpClientContext.create(); final Map challenges = new HashMap<>(); challenges.put(StandardAuthScheme.BASIC.toLowerCase(Locale.ROOT), new AuthChallenge(ChallengeType.TARGET, StandardAuthScheme.BASIC, new BasicNameValuePair("realm", "test"))); challenges.put(StandardAuthScheme.DIGEST.toLowerCase(Locale.ROOT), new AuthChallenge(ChallengeType.TARGET, StandardAuthScheme.DIGEST, new BasicNameValuePair("realm", "test"), new BasicNameValuePair("nonce", "1234"))); final List authSchemes = authStrategy.select(ChallengeType.TARGET, challenges, context); Assertions.assertNotNull(authSchemes); Assertions.assertEquals(0, authSchemes.size()); } @Test void testUnsupportedScheme() { final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); final HttpClientContext context = HttpClientContext.create(); final Map challenges = new HashMap<>(); challenges.put(StandardAuthScheme.BASIC.toLowerCase(Locale.ROOT), new AuthChallenge(ChallengeType.TARGET, StandardAuthScheme.BASIC, new BasicNameValuePair("realm", "realm1"))); challenges.put(StandardAuthScheme.DIGEST.toLowerCase(Locale.ROOT), new AuthChallenge(ChallengeType.TARGET, StandardAuthScheme.DIGEST, new BasicNameValuePair("realm", "realm2"), new BasicNameValuePair("nonce", "1234"))); challenges.put("whatever", new AuthChallenge(ChallengeType.TARGET, "Whatever", new BasicNameValuePair("realm", "realm3"))); final Registry authSchemeRegistry = RegistryBuilder.create() .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE) .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE).build(); context.setAuthSchemeRegistry(authSchemeRegistry); context.setCredentialsProvider(CredentialsProviderBuilder.create() .add(new AuthScope("somehost", 80), "user", "pwd".toCharArray()) .build()); final List authSchemes = authStrategy.select(ChallengeType.TARGET, challenges, context); Assertions.assertNotNull(authSchemes); Assertions.assertEquals(2, authSchemes.size()); final AuthScheme authScheme1 = authSchemes.get(0); Assertions.assertTrue(authScheme1 instanceof DigestScheme); final AuthScheme authScheme2 = authSchemes.get(1); Assertions.assertTrue(authScheme2 instanceof BasicScheme); } @Test void testCustomAuthPreference() { final DefaultAuthenticationStrategy authStrategy = new DefaultAuthenticationStrategy(); final RequestConfig config = RequestConfig.custom() .setTargetPreferredAuthSchemes(Collections.singletonList(StandardAuthScheme.BASIC)) .build(); final HttpClientContext context = HttpClientContext.create(); final Map challenges = new HashMap<>(); challenges.put(StandardAuthScheme.BASIC.toLowerCase(Locale.ROOT), new AuthChallenge(ChallengeType.TARGET, StandardAuthScheme.BASIC, new BasicNameValuePair("realm", "realm1"))); challenges.put(StandardAuthScheme.DIGEST.toLowerCase(Locale.ROOT), new AuthChallenge(ChallengeType.TARGET, StandardAuthScheme.DIGEST, new BasicNameValuePair("realm", "realm2"), new BasicNameValuePair("nonce", "1234"))); final Registry authSchemeRegistry = RegistryBuilder.create() .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE) .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE).build(); context.setAuthSchemeRegistry(authSchemeRegistry); context.setRequestConfig(config); context.setCredentialsProvider(CredentialsProviderBuilder.create() .add(new AuthScope("somehost", 80), "user", "pwd".toCharArray()) .build()); final List authSchemes = authStrategy.select(ChallengeType.TARGET, challenges, context); Assertions.assertNotNull(authSchemes); Assertions.assertEquals(1, authSchemes.size()); final AuthScheme authScheme1 = authSchemes.get(0); Assertions.assertTrue(authScheme1 instanceof BasicScheme); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/TestProtocolSwitchStrategy.java0100664 0000000 0000000 00000025740 15005672035 030652 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.ProtocolVersion; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.ssl.TLS; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; /** * Simple tests for {@link ProtocolSwitchStrategy}. */ class TestProtocolSwitchStrategy { ProtocolSwitchStrategy switchStrategy; @BeforeEach void setUp() { switchStrategy = new ProtocolSwitchStrategy(); } @Test void testSwitchToTLS() throws Exception { final HttpResponse response1 = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response1.addHeader(HttpHeaders.UPGRADE, "TLS"); Assertions.assertEquals(TLS.V_1_2.getVersion(), switchStrategy.switchProtocol(response1)); final HttpResponse response2 = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response2.addHeader(HttpHeaders.UPGRADE, "TLS/1.3"); Assertions.assertEquals(TLS.V_1_3.getVersion(), switchStrategy.switchProtocol(response2)); } @Test void testSwitchToHTTP11AndTLS() throws Exception { final HttpResponse response1 = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response1.addHeader(HttpHeaders.UPGRADE, "TLS, HTTP/1.1"); Assertions.assertEquals(TLS.V_1_2.getVersion(), switchStrategy.switchProtocol(response1)); final HttpResponse response2 = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response2.addHeader(HttpHeaders.UPGRADE, ",, HTTP/1.1, TLS, "); Assertions.assertEquals(TLS.V_1_2.getVersion(), switchStrategy.switchProtocol(response2)); final HttpResponse response3 = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response3.addHeader(HttpHeaders.UPGRADE, "HTTP/1.1"); response3.addHeader(HttpHeaders.UPGRADE, "TLS/1.2"); Assertions.assertEquals(TLS.V_1_2.getVersion(), switchStrategy.switchProtocol(response3)); final HttpResponse response4 = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response4.addHeader(HttpHeaders.UPGRADE, "HTTP/1.1"); response4.addHeader(HttpHeaders.UPGRADE, "TLS/1.2, TLS/1.3"); Assertions.assertEquals(TLS.V_1_3.getVersion(), switchStrategy.switchProtocol(response4)); } @Test void testSwitchInvalid() { final HttpResponse response1 = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response1.addHeader(HttpHeaders.UPGRADE, "Crap"); Assertions.assertThrows(ProtocolException.class, () -> switchStrategy.switchProtocol(response1)); final HttpResponse response2 = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response2.addHeader(HttpHeaders.UPGRADE, "TLS, huh?"); Assertions.assertThrows(ProtocolException.class, () -> switchStrategy.switchProtocol(response2)); final HttpResponse response3 = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response3.addHeader(HttpHeaders.UPGRADE, ",,,"); Assertions.assertThrows(ProtocolException.class, () -> switchStrategy.switchProtocol(response3)); } @Test void testNullToken() throws ProtocolException { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "TLS,"); response.addHeader(HttpHeaders.UPGRADE, null); Assertions.assertEquals(TLS.V_1_2.getVersion(), switchStrategy.switchProtocol(response)); } @Test void testWhitespaceOnlyToken() throws ProtocolException { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, " , TLS"); Assertions.assertEquals(TLS.V_1_2.getVersion(), switchStrategy.switchProtocol(response)); } @Test void testUnsupportedTlsVersion() throws Exception { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "TLS/1.4"); Assertions.assertEquals(new ProtocolVersion("TLS", 1, 4), switchStrategy.switchProtocol(response)); } @Test void testUnsupportedTlsMajorVersion() throws Exception { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "TLS/2.0"); Assertions.assertEquals(new ProtocolVersion("TLS", 2, 0), switchStrategy.switchProtocol(response)); } @Test void testUnsupportedHttpVersion() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "HTTP/2.0"); final ProtocolException ex = Assertions.assertThrows(ProtocolException.class, () -> switchStrategy.switchProtocol(response)); Assertions.assertEquals("Unsupported protocol or HTTP version: HTTP/2.0", ex.getMessage()); } @Test void testInvalidTlsFormat() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "TLS/abc"); final ProtocolException ex = Assertions.assertThrows(ProtocolException.class, () -> switchStrategy.switchProtocol(response)); Assertions.assertEquals("Invalid TLS major version number; error at offset 7: ", ex.getMessage()); } @Test void testHttp11Only() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "HTTP/1.1"); final ProtocolException ex = Assertions.assertThrows(ProtocolException.class, () -> switchStrategy.switchProtocol(response)); Assertions.assertEquals("Invalid protocol switch response: no TLS version found", ex.getMessage()); } @Test void testSwitchToTlsValid_TLS_1_2() throws Exception { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "TLS/1.2"); final ProtocolVersion result = switchStrategy.switchProtocol(response); Assertions.assertEquals(TLS.V_1_2.getVersion(), result); } @Test void testSwitchToTlsValid_TLS_1_0() throws Exception { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "TLS/1.0"); final ProtocolVersion result = switchStrategy.switchProtocol(response); Assertions.assertEquals(TLS.V_1_0.getVersion(), result); } @Test void testSwitchToTlsValid_TLS_1_1() throws Exception { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "TLS/1.1"); final ProtocolVersion result = switchStrategy.switchProtocol(response); Assertions.assertEquals(TLS.V_1_1.getVersion(), result); } @Test void testInvalidTlsFormat_NoSlash() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "TLSv1"); final ProtocolException ex = Assertions.assertThrows(ProtocolException.class, () -> switchStrategy.switchProtocol(response)); Assertions.assertEquals("Unsupported or invalid protocol: TLSv1", ex.getMessage()); } @Test void testSwitchToTlsValid_TLS_1() throws Exception { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "TLS/1"); final ProtocolVersion result = switchStrategy.switchProtocol(response); Assertions.assertEquals(TLS.V_1_0.getVersion(), result); } @Test void testInvalidTlsFormat_MissingMajor() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "TLS/.1"); final ProtocolException ex = Assertions.assertThrows(ProtocolException.class, () -> switchStrategy.switchProtocol(response)); Assertions.assertEquals("Invalid TLS major version number; error at offset 4: ", ex.getMessage()); } @Test void testMultipleHttp11Tokens() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "HTTP/1.1, HTTP/1.1"); final ProtocolException ex = Assertions.assertThrows(ProtocolException.class, () -> switchStrategy.switchProtocol(response)); Assertions.assertEquals("Invalid protocol switch response: no TLS version found", ex.getMessage()); } @Test void testMixedInvalidAndValidTokens() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, "Crap, TLS/1.2, Invalid"); final ProtocolException ex = Assertions.assertThrows(ProtocolException.class, () -> switchStrategy.switchProtocol(response)); Assertions.assertEquals("Unsupported or invalid protocol: Crap", ex.getMessage()); } @Test void testInvalidTlsFormat_NoProtocolName() { final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SWITCHING_PROTOCOLS); response.addHeader(HttpHeaders.UPGRADE, ",,/1.1"); final ProtocolException ex = Assertions.assertThrows(ProtocolException.class, () -> switchStrategy.switchProtocol(response)); Assertions.assertEquals("Invalid protocol; error at offset 2: <,,/1.1>", ex.getMessage()); } }httpclient5/src/test/java/org/apache/hc/client5/http/impl/TestDefaultHttpRequestRetryStrategy.java0100664 0000000 0000000 00000016672 15036651120 032512 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.io.IOException; import java.net.ConnectException; import java.net.NoRouteToHostException; import java.net.SocketTimeoutException; import java.net.UnknownHostException; import java.time.Instant; import java.time.temporal.ChronoUnit; import javax.net.ssl.SSLException; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.utils.DateUtils; import org.apache.hc.core5.http.ConnectionClosedException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestDefaultHttpRequestRetryStrategy { private DefaultHttpRequestRetryStrategy retryStrategy; @BeforeEach void setup() { this.retryStrategy = new DefaultHttpRequestRetryStrategy(3, TimeValue.ofMilliseconds(1234L)); } @Test void testBasics() { final HttpResponse response1 = new BasicHttpResponse(503, "Oopsie"); Assertions.assertTrue(this.retryStrategy.retryRequest(response1, 1, null)); Assertions.assertTrue(this.retryStrategy.retryRequest(response1, 2, null)); Assertions.assertTrue(this.retryStrategy.retryRequest(response1, 3, null)); Assertions.assertFalse(this.retryStrategy.retryRequest(response1, 4, null)); final HttpResponse response2 = new BasicHttpResponse(500, "Big Time Oopsie"); Assertions.assertFalse(this.retryStrategy.retryRequest(response2, 1, null)); final HttpResponse response3 = new BasicHttpResponse(429, "Oopsie"); Assertions.assertTrue(this.retryStrategy.retryRequest(response3, 1, null)); Assertions.assertTrue(this.retryStrategy.retryRequest(response3, 2, null)); Assertions.assertTrue(this.retryStrategy.retryRequest(response3, 3, null)); Assertions.assertFalse(this.retryStrategy.retryRequest(response3, 4, null)); Assertions.assertEquals(TimeValue.ofMilliseconds(1234L), this.retryStrategy.getRetryInterval(response1, 1, null)); } @Test void testRetryRequestWithResponseTimeout() { final HttpResponse response = new BasicHttpResponse(503, "Oopsie"); final HttpClientContext context = HttpClientContext.create(); context.setRequestConfig(RequestConfig.custom() .build()); Assertions.assertTrue(retryStrategy.retryRequest(response, 1, context)); context.setRequestConfig(RequestConfig.custom() .setResponseTimeout(Timeout.ofMilliseconds(1234L)) .build()); Assertions.assertTrue(retryStrategy.retryRequest(response, 1, context)); context.setRequestConfig(RequestConfig.custom() .setResponseTimeout(Timeout.ofMilliseconds(1233L)) .build()); Assertions.assertFalse(retryStrategy.retryRequest(response, 1, context)); } @Test void testRetryAfterHeaderAsLong() { final HttpResponse response = new BasicHttpResponse(503, "Oopsie"); response.setHeader(HttpHeaders.RETRY_AFTER, "321"); Assertions.assertEquals(TimeValue.ofSeconds(321L), this.retryStrategy.getRetryInterval(response, 3, null)); } @Test void testRetryAfterHeaderAsDate() { this.retryStrategy = new DefaultHttpRequestRetryStrategy(3, TimeValue.ZERO_MILLISECONDS); final HttpResponse response = new BasicHttpResponse(503, "Oopsie"); response.setHeader(HttpHeaders.RETRY_AFTER, DateUtils.formatStandardDate(Instant.now().plus(100, ChronoUnit.SECONDS))); Assertions.assertTrue(this.retryStrategy.getRetryInterval(response, 3, null).compareTo(TimeValue.ZERO_MILLISECONDS) > 0); } @Test void testRetryAfterHeaderAsPastDate() { final HttpResponse response = new BasicHttpResponse(503, "Oopsie"); response.setHeader(HttpHeaders.RETRY_AFTER, DateUtils.formatStandardDate(Instant.now().minus(100, ChronoUnit.SECONDS))); Assertions.assertEquals(TimeValue.ofMilliseconds(1234L), this.retryStrategy.getRetryInterval(response, 3, null)); } @Test void testInvalidRetryAfterHeader() { final HttpResponse response = new BasicHttpResponse(503, "Oopsie"); response.setHeader(HttpHeaders.RETRY_AFTER, "Stuff"); Assertions.assertEquals(TimeValue.ofMilliseconds(1234L), retryStrategy.getRetryInterval(response, 3, null)); } @Test void noRetryOnConnectTimeout() { final HttpGet request = new HttpGet("/"); Assertions.assertFalse(retryStrategy.retryRequest(request, new SocketTimeoutException(), 1, null)); } @Test void noRetryOnConnect() { final HttpGet request = new HttpGet("/"); Assertions.assertFalse(retryStrategy.retryRequest(request, new ConnectException(), 1, null)); } @Test void noRetryOnConnectionClosed() { final HttpGet request = new HttpGet("/"); Assertions.assertFalse(retryStrategy.retryRequest(request, new ConnectionClosedException(), 1, null)); } @Test void noRetryForNoRouteToHostException() { final HttpGet request = new HttpGet("/"); Assertions.assertFalse(retryStrategy.retryRequest(request, new NoRouteToHostException(), 1, null)); } @Test void noRetryOnSSLFailure() { final HttpGet request = new HttpGet("/"); Assertions.assertFalse(retryStrategy.retryRequest(request, new SSLException("encryption failed"), 1, null)); } @Test void noRetryOnUnknownHost() { final HttpGet request = new HttpGet("/"); Assertions.assertFalse(retryStrategy.retryRequest(request, new UnknownHostException(), 1, null)); } @Test void noRetryOnAbortedRequests() { final HttpGet request = new HttpGet("/"); request.cancel(); Assertions.assertFalse(retryStrategy.retryRequest(request, new IOException(), 1, null)); } @Test void retryOnNonAbortedRequests() { final HttpGet request = new HttpGet("/"); Assertions.assertTrue(retryStrategy.retryRequest(request, new IOException(), 1, null)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/TestIdleConnectionEvictor.java0100664 0000000 0000000 00000005766 14704162040 030376 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.core5.pool.ConnPoolControl; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.mockito.ArgumentMatchers; import org.mockito.Mockito; /** * Unit tests for {@link IdleConnectionEvictor}. */ class TestIdleConnectionEvictor { @Test void testEvictExpiredAndIdle() throws Exception { final ConnPoolControl cm = Mockito.mock(ConnPoolControl.class); final IdleConnectionEvictor connectionEvictor = new IdleConnectionEvictor(cm, TimeValue.ofMilliseconds(500), TimeValue.ofSeconds(3)); connectionEvictor.start(); Thread.sleep(1000); Mockito.verify(cm, Mockito.atLeast(1)).closeExpired(); Mockito.verify(cm, Mockito.atLeast(1)).closeIdle(TimeValue.ofSeconds(3)); Assertions.assertTrue(connectionEvictor.isRunning()); connectionEvictor.shutdown(); connectionEvictor.awaitTermination(Timeout.ofSeconds(1)); Assertions.assertFalse(connectionEvictor.isRunning()); } @Test void testEvictExpiredOnly() throws Exception { final ConnPoolControl cm = Mockito.mock(ConnPoolControl.class); final IdleConnectionEvictor connectionEvictor = new IdleConnectionEvictor(cm, TimeValue.ofMilliseconds(500), null); connectionEvictor.start(); Thread.sleep(1000); Mockito.verify(cm, Mockito.atLeast(1)).closeExpired(); Mockito.verify(cm, Mockito.never()).closeIdle(ArgumentMatchers.any()); Assertions.assertTrue(connectionEvictor.isRunning()); connectionEvictor.shutdown(); connectionEvictor.awaitTermination(Timeout.ofSeconds(1)); Assertions.assertFalse(connectionEvictor.isRunning()); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/io/0040775 0000000 0000000 00000000000 15063503632 023043 5ustar000000000 0000000 ././@LongLink0100644 0000000 0000000 00000000151 15005672016 011632 Lustar 0000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/io/TestPoolingHttpClientConnectionManager.javahttpclient5/src/test/java/org/apache/hc/client5/http/impl/io/TestPoolingHttpClientConnectionManager.0100664 0000000 0000000 00000042055 15005672016 032627 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.Socket; import java.util.Collections; 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; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.io.ConnectionEndpoint; import org.apache.hc.client5.http.io.DetachedSocketFactory; import org.apache.hc.client5.http.io.LeaseRequest; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.pool.PoolEntry; import org.apache.hc.core5.pool.StrictConnPool; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; /** * {@link PoolingHttpClientConnectionManager} tests. */ class TestPoolingHttpClientConnectionManager { @Mock private ManagedHttpClientConnection conn; @Mock private Lookup tlsSocketStrategyLookup; @Mock private DetachedSocketFactory detachedSocketFactory; @Mock private TlsSocketStrategy tlsSocketStrategy; @Mock private Socket socket; @Mock private SSLSocket upgradedSocket; @Mock private SchemePortResolver schemePortResolver; @Mock private DnsResolver dnsResolver; @Mock private Future> future; @Mock private StrictConnPool pool; private PoolingHttpClientConnectionManager mgr; @BeforeEach void setup() { MockitoAnnotations.openMocks(this); mgr = new PoolingHttpClientConnectionManager(new DefaultHttpClientConnectionOperator( detachedSocketFactory, schemePortResolver, dnsResolver, tlsSocketStrategyLookup), pool, null); } @Test void testLeaseRelease() throws Exception { final HttpHost target = new HttpHost("localhost", 80); final HttpRoute route = new HttpRoute(target); final PoolEntry entry = new PoolEntry<>(route, TimeValue.NEG_ONE_MILLISECOND); entry.assignConnection(conn); Mockito.when(conn.isOpen()).thenReturn(true); Mockito.when(conn.isConsistent()).thenReturn(true); Mockito.when(future.get(1, TimeUnit.SECONDS)).thenReturn(entry); Mockito.when(pool.lease( Mockito.eq(route), Mockito.eq(null), Mockito.any(), Mockito.eq(null))) .thenReturn(future); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ofSeconds(1)); Assertions.assertNotNull(endpoint1); Assertions.assertNotSame(conn, endpoint1); mgr.release(endpoint1, null, TimeValue.NEG_ONE_MILLISECOND); Mockito.verify(pool).release(entry, true); } @Test void testReleaseRouteIncomplete() throws Exception { final HttpHost target = new HttpHost("localhost", 80); final HttpRoute route = new HttpRoute(target); final PoolEntry entry = new PoolEntry<>(route, TimeValue.NEG_ONE_MILLISECOND); Mockito.when(future.get(1, TimeUnit.SECONDS)).thenReturn(entry); Mockito.when(pool.lease( Mockito.eq(route), Mockito.eq(null), Mockito.any(), Mockito.eq(null))) .thenReturn(future); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ofSeconds(1)); Assertions.assertNotNull(endpoint1); Assertions.assertNotSame(conn, endpoint1); mgr.release(endpoint1, null, TimeValue.NEG_ONE_MILLISECOND); Mockito.verify(pool).release(entry, false); } @Test void testLeaseFutureTimeout() throws Exception { final HttpHost target = new HttpHost("localhost", 80); final HttpRoute route = new HttpRoute(target); Mockito.when(future.get(1, TimeUnit.SECONDS)).thenThrow(new TimeoutException()); Mockito.when(pool.lease( Mockito.eq(route), Mockito.eq(null), Mockito.any(), Mockito.eq(null))) .thenReturn(future); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); Assertions.assertThrows(TimeoutException.class, () -> connRequest1.get(Timeout.ofSeconds(1))); } @Test void testReleaseReusable() throws Exception { final HttpHost target = new HttpHost("localhost", 80); final HttpRoute route = new HttpRoute(target); final PoolEntry entry = new PoolEntry<>(route, TimeValue.NEG_ONE_MILLISECOND); entry.assignConnection(conn); Mockito.when(future.get(1, TimeUnit.SECONDS)).thenReturn(entry); Mockito.when(pool.lease( Mockito.eq(route), Mockito.eq(null), Mockito.any(), Mockito.eq(null))) .thenReturn(future); Mockito.when(conn.isOpen()).thenReturn(true); Mockito.when(conn.isConsistent()).thenReturn(true); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ofSeconds(1)); Assertions.assertNotNull(endpoint1); Assertions.assertTrue(endpoint1.isConnected()); mgr.release(endpoint1, "some state", TimeValue.NEG_ONE_MILLISECOND); Mockito.verify(pool).release(entry, true); Assertions.assertEquals("some state", entry.getState()); } @Test void testReleaseNonReusable() throws Exception { final HttpHost target = new HttpHost("localhost", 80); final HttpRoute route = new HttpRoute(target); final PoolEntry entry = new PoolEntry<>(route, TimeValue.NEG_ONE_MILLISECOND); entry.assignConnection(conn); Mockito.when(future.get(1, TimeUnit.SECONDS)).thenReturn(entry); Mockito.when(pool.lease( Mockito.eq(route), Mockito.eq(null), Mockito.any(), Mockito.eq(null))) .thenReturn(future); Mockito.when(conn.isOpen()).thenReturn(Boolean.FALSE); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ofSeconds(1)); Assertions.assertNotNull(endpoint1); Assertions.assertFalse(endpoint1.isConnected()); mgr.release(endpoint1, "some state", TimeValue.NEG_ONE_MILLISECOND); Mockito.verify(pool).release(entry, false); Assertions.assertNull(entry.getState()); } @Test void testTargetConnect() throws Exception { final HttpHost target = new HttpHost("https", "somehost", 443); final InetAddress remote = InetAddress.getByAddress(new byte[] {10, 0, 0, 1}); final InetAddress local = InetAddress.getByAddress(new byte[]{127, 0, 0, 1}); final HttpRoute route = new HttpRoute(target, local, true); final PoolEntry entry = new PoolEntry<>(route, TimeValue.NEG_ONE_MILLISECOND); entry.assignConnection(conn); Mockito.when(conn.isOpen()).thenReturn(false); Mockito.when(future.get(1, TimeUnit.SECONDS)).thenReturn(entry); Mockito.when(pool.lease( Mockito.eq(route), Mockito.eq(null), Mockito.any(), Mockito.eq(null))) .thenReturn(future); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ofSeconds(1)); Assertions.assertNotNull(endpoint1); final HttpClientContext context = HttpClientContext.create(); final SocketConfig sconfig = SocketConfig.custom().build(); mgr.setDefaultSocketConfig(sconfig); final ConnectionConfig connectionConfig = ConnectionConfig.custom() .setConnectTimeout(234, TimeUnit.MILLISECONDS) .build(); mgr.setDefaultConnectionConfig(connectionConfig); final TlsConfig tlsConfig = TlsConfig.custom() .setHandshakeTimeout(345, TimeUnit.MILLISECONDS) .build(); mgr.setDefaultTlsConfig(tlsConfig); Mockito.when(dnsResolver.resolve("somehost", 8443)).thenReturn(Collections.singletonList(new InetSocketAddress(remote, 8443))); Mockito.when(schemePortResolver.resolve(target.getSchemeName(), target)).thenReturn(8443); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); Mockito.when(tlsSocketStrategyLookup.lookup("https")).thenReturn(tlsSocketStrategy); Mockito.when(tlsSocketStrategy.upgrade( Mockito.same(socket), Mockito.eq("somehost"), Mockito.anyInt(), Mockito.any(), Mockito.any())).thenReturn(upgradedSocket); mgr.connect(endpoint1, null, context); Mockito.verify(dnsResolver, Mockito.times(1)).resolve("somehost", 8443); Mockito.verify(schemePortResolver, Mockito.times(1)).resolve(target.getSchemeName(), target); Mockito.verify(detachedSocketFactory, Mockito.times(1)).create("https", null); Mockito.verify(socket, Mockito.times(1)).connect(new InetSocketAddress(remote, 8443), 234); Mockito.verify(tlsSocketStrategy).upgrade(socket, "somehost", 443, tlsConfig, context); mgr.connect(endpoint1, TimeValue.ofMilliseconds(123), context); Mockito.verify(dnsResolver, Mockito.times(2)).resolve("somehost", 8443); Mockito.verify(schemePortResolver, Mockito.times(2)).resolve(target.getSchemeName(), target); Mockito.verify(detachedSocketFactory, Mockito.times(2)).create("https", null); Mockito.verify(socket, Mockito.times(1)).connect(new InetSocketAddress(remote, 8443), 123); Mockito.verify(tlsSocketStrategy, Mockito.times(2)).upgrade(socket, "somehost", 443, tlsConfig, context); } @Test void testProxyConnectAndUpgrade() throws Exception { final HttpHost target = new HttpHost("https", "somehost", 443); final HttpHost proxy = new HttpHost("someproxy", 8080); final InetAddress remote = InetAddress.getByAddress(new byte[] {10, 0, 0, 1}); final InetAddress local = InetAddress.getByAddress(new byte[] {127, 0, 0, 1}); final HttpRoute route = new HttpRoute(target, local, proxy, true); final PoolEntry entry = new PoolEntry<>(route, TimeValue.NEG_ONE_MILLISECOND); entry.assignConnection(conn); Mockito.when(conn.isOpen()).thenReturn(false); Mockito.when(future.get(1, TimeUnit.SECONDS)).thenReturn(entry); Mockito.when(pool.lease( Mockito.eq(route), Mockito.eq(null), Mockito.any(), Mockito.eq(null))) .thenReturn(future); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ofSeconds(1)); Assertions.assertNotNull(endpoint1); final HttpClientContext context = HttpClientContext.create(); final SocketConfig sconfig = SocketConfig.custom().build(); mgr.setDefaultSocketConfig(sconfig); final ConnectionConfig connectionConfig = ConnectionConfig.custom() .setConnectTimeout(234, TimeUnit.MILLISECONDS) .build(); mgr.setDefaultConnectionConfig(connectionConfig); final TlsConfig tlsConfig = TlsConfig.custom() .setHandshakeTimeout(345, TimeUnit.MILLISECONDS) .build(); mgr.setDefaultTlsConfig(tlsConfig); Mockito.when(dnsResolver.resolve("someproxy", 8080)).thenReturn(Collections.singletonList(new InetSocketAddress(remote, 8080))); Mockito.when(schemePortResolver.resolve(proxy.getSchemeName(), proxy)).thenReturn(8080); Mockito.when(schemePortResolver.resolve(target.getSchemeName(), target)).thenReturn(8443); Mockito.when(tlsSocketStrategyLookup.lookup("https")).thenReturn(tlsSocketStrategy); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); mgr.connect(endpoint1, null, context); Mockito.verify(dnsResolver, Mockito.times(1)).resolve("someproxy", 8080); Mockito.verify(schemePortResolver, Mockito.times(1)).resolve(proxy.getSchemeName(), proxy); Mockito.verify(detachedSocketFactory, Mockito.times(1)).create("http", null); Mockito.verify(socket, Mockito.times(1)).connect(new InetSocketAddress(remote, 8080), 234); Mockito.when(conn.isOpen()).thenReturn(true); Mockito.when(conn.getSocket()).thenReturn(socket); mgr.upgrade(endpoint1, context); Mockito.verify(tlsSocketStrategy, Mockito.times(1)).upgrade( socket, "somehost", 443, tlsConfig, context); } @Test void testIsShutdownInitially() { Assertions.assertFalse(mgr.isClosed(), "Connection manager should not be shutdown initially."); } @Test void testShutdownIdempotency() { mgr.close(); Assertions.assertTrue(mgr.isClosed(), "Connection manager should remain shutdown after the first call to shutdown."); mgr.close(); // Second call to shutdown Assertions.assertTrue(mgr.isClosed(), "Connection manager should still be shutdown after subsequent calls to shutdown."); } @Test void testLeaseAfterShutdown() { mgr.close(); Assertions.assertThrows(IllegalArgumentException.class, () -> { // Attempt to lease a connection after shutdown mgr.lease("some-id", new HttpRoute(new HttpHost("localhost")), null); }, "Attempting to lease a connection after shutdown should throw an exception."); } @Test void testIsShutdown() { // Setup phase Mockito.when(pool.isShutdown()).thenReturn(false, true); // Simulate changing states // Execution phase: Initially, the manager should not be shutdown Assertions.assertFalse(mgr.isClosed(), "Connection manager should not be shutdown initially."); // Simulate shutting down the manager mgr.close(); // Verification phase: Now, the manager should be reported as shutdown Assertions.assertTrue(mgr.isClosed(), "Connection manager should be shutdown after close() is called."); } @Test void testConcurrentShutdown() throws InterruptedException { final ExecutorService executor = Executors.newFixedThreadPool(2); // Submit two shutdown tasks to be run in parallel, explicitly calling close() with no arguments executor.submit(() -> mgr.close()); executor.submit(() -> mgr.close()); executor.shutdown(); executor.awaitTermination(1, TimeUnit.SECONDS); Assertions.assertTrue(mgr.isClosed(), "Connection manager should be shutdown after concurrent calls to shutdown."); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/io/TestHttpClientConnectionOperator.java0100664 0000000 0000000 00000044620 15005672035 032363 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.net.ConnectException; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.Socket; import java.net.SocketTimeoutException; import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.concurrent.TimeUnit; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.ConnectTimeoutException; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.HttpHostConnectException; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.UnsupportedSchemeException; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.io.DetachedSocketFactory; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.http2.HttpVersionPolicy; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mockito; class TestHttpClientConnectionOperator { private ManagedHttpClientConnection conn; private Socket socket; private DetachedSocketFactory detachedSocketFactory; private TlsSocketStrategy tlsSocketStrategy; private Lookup tlsSocketStrategyLookup; private SchemePortResolver schemePortResolver; private DnsResolver dnsResolver; private DefaultHttpClientConnectionOperator connectionOperator; @BeforeEach void setup() { conn = Mockito.mock(ManagedHttpClientConnection.class); socket = Mockito.mock(Socket.class); detachedSocketFactory = Mockito.mock(DetachedSocketFactory.class); tlsSocketStrategy = Mockito.mock(TlsSocketStrategy.class); tlsSocketStrategyLookup = Mockito.mock(Lookup.class); schemePortResolver = Mockito.mock(SchemePortResolver.class); dnsResolver = Mockito.mock(DnsResolver.class); connectionOperator = new DefaultHttpClientConnectionOperator( detachedSocketFactory, schemePortResolver, dnsResolver, tlsSocketStrategyLookup); } @Test void testConnect() throws Exception { final HttpClientContext context = HttpClientContext.create(); final HttpHost host = new HttpHost("somehost"); final InetAddress local = InetAddress.getByAddress(new byte[] {127, 0, 0, 0}); final InetAddress ip1 = InetAddress.getByAddress(new byte[] {127, 0, 0, 1}); final InetAddress ip2 = InetAddress.getByAddress(new byte[] {127, 0, 0, 2}); final int port = 80; final List resolvedAddresses = Arrays.asList( new InetSocketAddress(ip1, port), new InetSocketAddress(ip2, port) ); Mockito.when(dnsResolver.resolve("somehost", port)).thenReturn(resolvedAddresses); Mockito.when(schemePortResolver.resolve(host.getSchemeName(), host)).thenReturn(port); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); final SocketConfig socketConfig = SocketConfig.custom() .setSoKeepAlive(true) .setSoReuseAddress(true) .setSoTimeout(5000, TimeUnit.MILLISECONDS) .setTcpNoDelay(true) .setSoLinger(50, TimeUnit.MILLISECONDS) .build(); final InetSocketAddress localAddress = new InetSocketAddress(local, 0); connectionOperator.connect(conn, host, null, localAddress, Timeout.ofMilliseconds(123), socketConfig, null, context); Mockito.verify(socket).setKeepAlive(true); Mockito.verify(socket).setReuseAddress(true); Mockito.verify(socket).setSoTimeout(5000); Mockito.verify(socket).setSoLinger(true, 50); Mockito.verify(socket).setTcpNoDelay(true); Mockito.verify(socket).bind(localAddress); Mockito.verify(socket).connect(new InetSocketAddress(ip1, port), 123); Mockito.verify(conn, Mockito.times(2)).bind(socket); } @Test void testConnectWithTLSUpgrade() throws Exception { final HttpClientContext context = HttpClientContext.create(); final HttpHost host = new HttpHost("https", "somehost"); final InetAddress local = InetAddress.getByAddress(new byte[] {127, 0, 0, 0}); final InetAddress ip1 = InetAddress.getByAddress(new byte[] {127, 0, 0, 1}); final InetAddress ip2 = InetAddress.getByAddress(new byte[] {127, 0, 0, 2}); final int port = 443; final TlsConfig tlsConfig = TlsConfig.custom() .setHandshakeTimeout(Timeout.ofMilliseconds(345)) .setVersionPolicy(HttpVersionPolicy.FORCE_HTTP_1) .build(); final List resolvedAddresses = Arrays.asList( new InetSocketAddress(ip1, port), new InetSocketAddress(ip2, port) ); Mockito.when(dnsResolver.resolve("somehost", port)).thenReturn(resolvedAddresses); Mockito.when(schemePortResolver.resolve(host.getSchemeName(), host)).thenReturn(port); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); Mockito.when(tlsSocketStrategyLookup.lookup("https")).thenReturn(tlsSocketStrategy); final SSLSocket upgradedSocket = Mockito.mock(SSLSocket.class); Mockito.when(tlsSocketStrategy.upgrade( Mockito.same(socket), Mockito.eq("somehost"), Mockito.anyInt(), Mockito.any(), Mockito.any())).thenReturn(upgradedSocket); final InetSocketAddress localAddress = new InetSocketAddress(local, 0); connectionOperator.connect(conn, host, null, localAddress, Timeout.ofMilliseconds(123), SocketConfig.DEFAULT, tlsConfig, context); Mockito.verify(socket).connect(new InetSocketAddress(ip1, port), 123); Mockito.verify(conn, Mockito.times(2)).bind(socket); Mockito.verify(tlsSocketStrategy).upgrade(socket, "somehost", -1, tlsConfig, context); Mockito.verify(conn, Mockito.times(1)).bind(upgradedSocket, socket); } @Test void testConnectTimeout() throws Exception { final HttpClientContext context = HttpClientContext.create(); final HttpHost host = new HttpHost("somehost"); final int port = 80; final InetAddress ip1 = InetAddress.getByAddress(new byte[] {10, 0, 0, 1}); final InetAddress ip2 = InetAddress.getByAddress(new byte[] {10, 0, 0, 2}); final List resolvedAddresses = Arrays.asList( new InetSocketAddress(ip1, port), new InetSocketAddress(ip2, port) ); Mockito.when(dnsResolver.resolve("somehost", port)).thenReturn(resolvedAddresses); Mockito.when(schemePortResolver.resolve(host.getSchemeName(), host)).thenReturn(port); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); Mockito.doThrow(new SocketTimeoutException()).when(socket).connect(Mockito.any(), Mockito.anyInt()); Assertions.assertThrows(ConnectTimeoutException.class, () -> connectionOperator.connect( conn, host, null, new InetSocketAddress(InetAddress.getLoopbackAddress(), 0), Timeout.ofMilliseconds(1000), SocketConfig.DEFAULT, null, context)); } @Test void testConnectFailure() throws Exception { final HttpClientContext context = HttpClientContext.create(); final HttpHost host = new HttpHost("somehost"); final InetAddress ip1 = InetAddress.getByAddress(new byte[] {10, 0, 0, 1}); final InetAddress ip2 = InetAddress.getByAddress(new byte[] {10, 0, 0, 2}); final int port = 80; final List resolvedAddresses = Arrays.asList( new InetSocketAddress(ip1, port), new InetSocketAddress(ip2, port) ); Mockito.when(dnsResolver.resolve("somehost", port)).thenReturn(resolvedAddresses); Mockito.when(schemePortResolver.resolve(host.getSchemeName(), host)).thenReturn(port); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); Mockito.doThrow(new ConnectException()).when(socket).connect(Mockito.any(), Mockito.anyInt()); Assertions.assertThrows(HttpHostConnectException.class, () -> connectionOperator.connect( conn, host, null, TimeValue.ofMilliseconds(1000), SocketConfig.DEFAULT, context)); } @Test void testConnectFailover() throws Exception { final HttpClientContext context = HttpClientContext.create(); final HttpHost host = new HttpHost("somehost"); final InetAddress local = InetAddress.getByAddress(new byte[] {127, 0, 0, 0}); final InetSocketAddress ipAddress1 = new InetSocketAddress(InetAddress.getByAddress(new byte[] {10, 0, 0, 1}), 80); final InetSocketAddress ipAddress2 = new InetSocketAddress(InetAddress.getByAddress(new byte[] {10, 0, 0, 2}), 80); Mockito.when(dnsResolver.resolve("somehost", 80)).thenReturn(Arrays.asList(ipAddress1, ipAddress2)); Mockito.when(schemePortResolver.resolve(host.getSchemeName(), host)).thenReturn(80); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); Mockito.doThrow(new ConnectException()).when(socket).connect( Mockito.eq(ipAddress1), Mockito.anyInt()); final InetSocketAddress localAddress = new InetSocketAddress(local, 0); final TlsConfig tlsConfig = TlsConfig.custom() .build(); connectionOperator.connect(conn, host, null, localAddress, Timeout.ofMilliseconds(123), SocketConfig.DEFAULT, tlsConfig, context); Mockito.verify(socket, Mockito.times(2)).bind(localAddress); Mockito.verify(socket).connect(ipAddress2, 123); Mockito.verify(conn, Mockito.times(3)).bind(socket); } @Test void testConnectExplicitAddress() throws Exception { final HttpClientContext context = HttpClientContext.create(); final InetAddress local = InetAddress.getByAddress(new byte[] {127, 0, 0, 0}); final InetAddress ip = InetAddress.getByAddress(new byte[] {127, 0, 0, 23}); final HttpHost host = new HttpHost(ip); Mockito.when(schemePortResolver.resolve(host.getSchemeName(), host)).thenReturn(80); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); final InetSocketAddress localAddress = new InetSocketAddress(local, 0); final TlsConfig tlsConfig = TlsConfig.custom() .build(); connectionOperator.connect(conn, host, null, localAddress, Timeout.ofMilliseconds(123), SocketConfig.DEFAULT, tlsConfig, context); Mockito.verify(socket).bind(localAddress); Mockito.verify(socket).connect(new InetSocketAddress(ip, 80), 123); Mockito.verify(dnsResolver, Mockito.never()).resolve(Mockito.anyString(), Mockito.anyInt()); Mockito.verify(conn, Mockito.times(2)).bind(socket); } @Test void testUpgrade() throws Exception { final HttpClientContext context = HttpClientContext.create(); final HttpHost host = new HttpHost("https", "somehost", -1); Mockito.when(conn.isOpen()).thenReturn(true); Mockito.when(conn.getSocket()).thenReturn(socket); Mockito.when(tlsSocketStrategyLookup.lookup("https")).thenReturn(tlsSocketStrategy); final SSLSocket upgradedSocket = Mockito.mock(SSLSocket.class); Mockito.when(tlsSocketStrategy.upgrade( Mockito.any(), Mockito.eq("somehost"), Mockito.anyInt(), Mockito.eq(Timeout.ofMilliseconds(345)), Mockito.any())).thenReturn(upgradedSocket); connectionOperator.upgrade(conn, host, null, Timeout.ofMilliseconds(345), context); Mockito.verify(conn).bind(Mockito.eq(upgradedSocket), Mockito.any()); } @Test void testUpgradeUpsupportedScheme() { final HttpClientContext context = HttpClientContext.create(); final HttpHost host = new HttpHost("httpsssss", "somehost", -1); Mockito.when(conn.isOpen()).thenReturn(true); Mockito.when(conn.getSocket()).thenReturn(socket); Assertions.assertThrows(UnsupportedSchemeException.class, () -> connectionOperator.upgrade(conn, host, context)); } @Test void testUpgradeNonLayeringScheme() { final HttpClientContext context = HttpClientContext.create(); final HttpHost host = new HttpHost("http", "somehost", -1); Mockito.when(conn.isOpen()).thenReturn(true); Mockito.when(conn.getSocket()).thenReturn(socket); Assertions.assertThrows(UnsupportedSchemeException.class, () -> connectionOperator.upgrade(conn, host, context)); } @Test void testConnectWithDisableDnsResolution() throws Exception { final HttpClientContext context = HttpClientContext.create(); final HttpHost host = new HttpHost("someonion.onion"); final InetAddress local = InetAddress.getByAddress(new byte[]{127, 0, 0, 0}); final int port = 80; final List resolvedAddresses = Collections.singletonList( InetSocketAddress.createUnresolved(host.getHostName(), port) ); Mockito.when(dnsResolver.resolve(host.getHostName(), port)).thenReturn(resolvedAddresses); Mockito.when(schemePortResolver.resolve(host.getSchemeName(), host)).thenReturn(port); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); final SocketConfig socketConfig = SocketConfig.custom() .setSoKeepAlive(true) .setSoReuseAddress(true) .setSoTimeout(5000, TimeUnit.MILLISECONDS) .setTcpNoDelay(true) .setSoLinger(50, TimeUnit.MILLISECONDS) .build(); final InetSocketAddress localAddress = new InetSocketAddress(local, 0); final InetSocketAddress remoteAddress = InetSocketAddress.createUnresolved(host.getHostName(), port); connectionOperator.connect(conn, host, null, localAddress, Timeout.ofMilliseconds(123), socketConfig, null, context); // Verify that the socket was created and attempted to connect without DNS resolution Mockito.verify(socket).setKeepAlive(true); Mockito.verify(socket).setReuseAddress(true); Mockito.verify(socket).setSoTimeout(5000); Mockito.verify(socket).setSoLinger(true, 50); Mockito.verify(socket).setTcpNoDelay(true); Mockito.verify(socket).bind(localAddress); Mockito.verify(socket).connect(remoteAddress, 123); Mockito.verify(conn, Mockito.times(2)).bind(socket); Mockito.verify(dnsResolver, Mockito.never()).resolve(Mockito.anyString()); } @Test void testConnectWithDnsResolutionAndFallback() throws Exception { final HttpClientContext context = HttpClientContext.create(); final HttpHost host = new HttpHost("fallbackhost.com"); final InetAddress local = InetAddress.getByAddress(new byte[] {127, 0, 0, 0}); final int port = 8080; final InetAddress ip1 = InetAddress.getByAddress(new byte[] {10, 0, 0, 1}); final InetAddress ip2 = InetAddress.getByAddress(new byte[] {10, 0, 0, 2}); // Update to match the new `resolve` implementation that returns a list of SocketAddress final List resolvedAddresses = Arrays.asList( new InetSocketAddress(ip1, port), new InetSocketAddress(ip2, port) ); Mockito.when(dnsResolver.resolve("fallbackhost.com", port)).thenReturn(resolvedAddresses); Mockito.when(schemePortResolver.resolve(host.getSchemeName(), host)).thenReturn(port); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); // Simulate failure to connect to the first resolved address Mockito.doThrow(new ConnectException()).when(socket).connect(Mockito.eq(new InetSocketAddress(ip1, port)), Mockito.anyInt()); final InetSocketAddress localAddress = new InetSocketAddress(local, 0); final SocketConfig socketConfig = SocketConfig.custom() .setSoKeepAlive(true) .setSoReuseAddress(true) .setSoTimeout(5000, TimeUnit.MILLISECONDS) .setTcpNoDelay(true) .setSoLinger(50, TimeUnit.MILLISECONDS) .build(); // Connect using the updated connection operator connectionOperator.connect(conn, host, null, localAddress, Timeout.ofMilliseconds(123), socketConfig, null, context); // Verify fallback behavior after connection failure to the first address Mockito.verify(socket, Mockito.times(2)).bind(localAddress); Mockito.verify(socket).connect(new InetSocketAddress(ip2, port), 123); Mockito.verify(conn, Mockito.times(3)).bind(socket); } } ././@LongLink0100644 0000000 0000000 00000000147 15005672016 011637 Lustar 0000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/io/TestBasicHttpClientConnectionManager.javahttpclient5/src/test/java/org/apache/hc/client5/http/impl/io/TestBasicHttpClientConnectionManager.ja0100664 0000000 0000000 00000054461 15005672016 032560 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.io; import java.net.InetAddress; import java.net.InetSocketAddress; import java.net.Socket; import java.util.Collections; import java.util.concurrent.TimeUnit; import javax.net.ssl.SSLSocket; import org.apache.hc.client5.http.DnsResolver; import org.apache.hc.client5.http.HttpRoute; import org.apache.hc.client5.http.SchemePortResolver; import org.apache.hc.client5.http.config.ConnectionConfig; import org.apache.hc.client5.http.config.TlsConfig; import org.apache.hc.client5.http.io.ConnectionEndpoint; import org.apache.hc.client5.http.io.DetachedSocketFactory; import org.apache.hc.client5.http.io.LeaseRequest; import org.apache.hc.client5.http.io.ManagedHttpClientConnection; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.client5.http.ssl.TlsSocketStrategy; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.config.Lookup; import org.apache.hc.core5.http.io.HttpConnectionFactory; import org.apache.hc.core5.http.io.SocketConfig; import org.apache.hc.core5.io.CloseMode; import org.apache.hc.core5.util.TimeValue; import org.apache.hc.core5.util.Timeout; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.mockito.Mock; import org.mockito.Mockito; import org.mockito.MockitoAnnotations; class TestBasicHttpClientConnectionManager { @Mock private ManagedHttpClientConnection conn; @Mock private HttpConnectionFactory connFactory; @Mock private Lookup tlsSocketStrategyLookup; @Mock private DetachedSocketFactory detachedSocketFactory; @Mock private TlsSocketStrategy tlsSocketStrategy; @Mock private Socket socket; @Mock private SSLSocket upgradedSocket; @Mock private SchemePortResolver schemePortResolver; @Mock private DnsResolver dnsResolver; private BasicHttpClientConnectionManager mgr; @BeforeEach void setup() { MockitoAnnotations.openMocks(this); mgr = new BasicHttpClientConnectionManager(new DefaultHttpClientConnectionOperator( detachedSocketFactory, schemePortResolver, dnsResolver, tlsSocketStrategyLookup), connFactory); } @Test void testLeaseReleaseNonReusable() throws Exception { final HttpHost target = new HttpHost("localhost", 80); final HttpRoute route = new HttpRoute(target); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); Assertions.assertFalse(endpoint1.isConnected()); mgr.release(endpoint1, null, TimeValue.ofMilliseconds(100)); Assertions.assertNull(mgr.getRoute()); Assertions.assertNull(mgr.getState()); final LeaseRequest connRequest2 = mgr.lease("some-id", route, null); final ConnectionEndpoint conn2 = connRequest2.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(conn2); Assertions.assertFalse(conn2.isConnected()); Mockito.verify(connFactory, Mockito.times(2)).createConnection(Mockito.any()); } @Test void testLeaseReleaseReusable() throws Exception { final HttpHost target = new HttpHost("somehost", 80); final HttpRoute route = new HttpRoute(target); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); Mockito.when(conn.isOpen()).thenReturn(Boolean.TRUE); Mockito.when(conn.isConsistent()).thenReturn(Boolean.TRUE); mgr.release(endpoint1, null, TimeValue.ofMilliseconds(100)); Assertions.assertEquals(route, mgr.getRoute()); Assertions.assertNull(mgr.getState()); final LeaseRequest connRequest2 = mgr.lease("some-id", route, null); final ConnectionEndpoint conn2 = connRequest2.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(conn2); Assertions.assertTrue(conn2.isConnected()); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); } @Test void testLeaseReleaseReusableWithState() throws Exception { final HttpHost target = new HttpHost("somehost", 80); final HttpRoute route = new HttpRoute(target); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, "some state"); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); Mockito.when(conn.isOpen()).thenReturn(Boolean.TRUE); Mockito.when(conn.isConsistent()).thenReturn(Boolean.TRUE); mgr.release(endpoint1, "some other state", TimeValue.ofMilliseconds(10000)); Assertions.assertEquals(route, mgr.getRoute()); Assertions.assertEquals("some other state", mgr.getState()); final LeaseRequest connRequest2 = mgr.lease("some-id", route, "some other state"); final ConnectionEndpoint conn2 = connRequest2.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(conn2); Assertions.assertTrue(conn2.isConnected()); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); } @Test void testLeaseDifferentRoute() throws Exception { final HttpHost target1 = new HttpHost("somehost", 80); final HttpRoute route1 = new HttpRoute(target1); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route1, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); Mockito.when(conn.isOpen()).thenReturn(Boolean.TRUE, Boolean.FALSE); Mockito.when(conn.isConsistent()).thenReturn(Boolean.TRUE, Boolean.FALSE); mgr.release(endpoint1, null, TimeValue.NEG_ONE_MILLISECOND); Assertions.assertEquals(route1, mgr.getRoute()); Assertions.assertNull(mgr.getState()); final HttpHost target2 = new HttpHost("otherhost", 80); final HttpRoute route2 = new HttpRoute(target2); final LeaseRequest connRequest2 = mgr.lease("some-id", route2, null); final ConnectionEndpoint conn2 = connRequest2.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(conn2); Assertions.assertFalse(conn2.isConnected()); Mockito.verify(conn).close(CloseMode.GRACEFUL); Mockito.verify(connFactory, Mockito.times(2)).createConnection(Mockito.any()); } @Test void testLeaseExpired() throws Exception { final HttpHost target = new HttpHost("somehost", 80); final HttpRoute route = new HttpRoute(target); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); Mockito.when(conn.isOpen()).thenReturn(Boolean.TRUE, Boolean.FALSE); Mockito.when(conn.isConsistent()).thenReturn(Boolean.TRUE, Boolean.FALSE); mgr.release(endpoint1, null, TimeValue.ofMilliseconds(10)); Assertions.assertEquals(route, mgr.getRoute()); Assertions.assertNull(mgr.getState()); Thread.sleep(50); final LeaseRequest connRequest2 = mgr.lease("some-id", route, null); final ConnectionEndpoint conn2 = connRequest2.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(conn2); Assertions.assertFalse(conn2.isConnected()); Mockito.verify(conn).close(CloseMode.GRACEFUL); Mockito.verify(connFactory, Mockito.times(2)).createConnection(Mockito.any()); } @Test void testReleaseInvalidArg() { Assertions.assertThrows(NullPointerException.class, () -> mgr.release(null, null, TimeValue.NEG_ONE_MILLISECOND)); } @Test void testReleaseAnotherConnection() { final ConnectionEndpoint wrongCon = Mockito.mock(ConnectionEndpoint.class); Assertions.assertThrows(IllegalStateException.class, () -> mgr.release(wrongCon, null, TimeValue.NEG_ONE_MILLISECOND)); } @Test void testShutdown() throws Exception { final HttpHost target = new HttpHost("somehost", 80); final HttpRoute route = new HttpRoute(target); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); Mockito.when(conn.isOpen()).thenReturn(Boolean.TRUE); Mockito.when(conn.isConsistent()).thenReturn(Boolean.TRUE); mgr.release(endpoint1, null, TimeValue.NEG_ONE_MILLISECOND); mgr.close(); Mockito.verify(conn, Mockito.times(1)).close(CloseMode.GRACEFUL); final LeaseRequest connRequest2 = mgr.lease("some-id", route, null); Assertions.assertThrows(IllegalStateException.class, () -> connRequest2.get(Timeout.ZERO_MILLISECONDS)); // Should have no effect mgr.closeExpired(); mgr.closeIdle(TimeValue.ZERO_MILLISECONDS); mgr.close(); Mockito.verify(conn, Mockito.times(1)).close(CloseMode.GRACEFUL); } @Test void testCloseExpired() throws Exception { final HttpHost target = new HttpHost("somehost", 80); final HttpRoute route = new HttpRoute(target); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); Mockito.when(conn.isOpen()).thenReturn(Boolean.TRUE, Boolean.FALSE); Mockito.when(conn.isConsistent()).thenReturn(Boolean.TRUE, Boolean.FALSE); mgr.release(endpoint1, null, TimeValue.ofMilliseconds(10)); Assertions.assertEquals(route, mgr.getRoute()); Assertions.assertNull(mgr.getState()); Thread.sleep(50); mgr.closeExpired(); Mockito.verify(conn).close(CloseMode.GRACEFUL); } @Test void testCloseIdle() throws Exception { final HttpHost target = new HttpHost("somehost", 80); final HttpRoute route = new HttpRoute(target); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); Mockito.when(conn.isOpen()).thenReturn(Boolean.TRUE, Boolean.FALSE); Mockito.when(conn.isConsistent()).thenReturn(Boolean.TRUE, Boolean.FALSE); mgr.release(endpoint1, null, TimeValue.NEG_ONE_MILLISECOND); Assertions.assertEquals(route, mgr.getRoute()); Assertions.assertNull(mgr.getState()); Thread.sleep(100); mgr.closeIdle(TimeValue.ofMilliseconds(50)); Mockito.verify(conn).close(CloseMode.GRACEFUL); } @Test void testAlreadyLeased() throws Exception { final HttpHost target = new HttpHost("somehost", 80); final HttpRoute route = new HttpRoute(target); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); mgr.release(endpoint1, null, TimeValue.ofMilliseconds(100)); mgr.getConnection(route, null); Assertions.assertThrows(IllegalStateException.class, () -> mgr.getConnection(route, null)); } @Test void testTargetConnect() throws Exception { final HttpHost target = new HttpHost("https", "somehost", 443); final InetAddress remote = InetAddress.getByAddress(new byte[] {10, 0, 0, 1}); final InetAddress local = InetAddress.getByAddress(new byte[] {127, 0, 0, 1}); final HttpRoute route = new HttpRoute(target, local, true); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); final HttpClientContext context = HttpClientContext.create(); final SocketConfig sconfig = SocketConfig.custom().build(); mgr.setSocketConfig(sconfig); final ConnectionConfig connectionConfig = ConnectionConfig.custom() .setConnectTimeout(234, TimeUnit.MILLISECONDS) .build(); mgr.setConnectionConfig(connectionConfig); final TlsConfig tlsConfig = TlsConfig.custom() .setHandshakeTimeout(345, TimeUnit.MILLISECONDS) .build(); mgr.setTlsConfig(tlsConfig); Mockito.when(dnsResolver.resolve("somehost", 8443)).thenReturn(Collections.singletonList(new InetSocketAddress(remote, 8443))); Mockito.when(schemePortResolver.resolve(target.getSchemeName(), target)).thenReturn(8443); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); Mockito.when(tlsSocketStrategyLookup.lookup("https")).thenReturn(tlsSocketStrategy); Mockito.when(tlsSocketStrategy.upgrade( Mockito.same(socket), Mockito.eq("somehost"), Mockito.eq(8443), Mockito.any(), Mockito.any())).thenReturn(upgradedSocket); mgr.connect(endpoint1, null, context); Mockito.verify(dnsResolver, Mockito.times(1)).resolve("somehost", 8443); Mockito.verify(schemePortResolver, Mockito.times(1)).resolve(target.getSchemeName(), target); Mockito.verify(detachedSocketFactory, Mockito.times(1)).create("https", null); Mockito.verify(socket, Mockito.times(1)).connect(new InetSocketAddress(remote, 8443), 234); Mockito.verify(tlsSocketStrategy).upgrade(socket, "somehost", 443, tlsConfig, context); mgr.connect(endpoint1, TimeValue.ofMilliseconds(123), context); Mockito.verify(dnsResolver, Mockito.times(2)).resolve("somehost", 8443); Mockito.verify(schemePortResolver, Mockito.times(2)).resolve(target.getSchemeName(), target); Mockito.verify(detachedSocketFactory, Mockito.times(2)).create("https", null); Mockito.verify(socket, Mockito.times(1)).connect(new InetSocketAddress(remote, 8443), 123); Mockito.verify(tlsSocketStrategy, Mockito.times(2)).upgrade(socket, "somehost", 443, tlsConfig, context); } @Test void testProxyConnectAndUpgrade() throws Exception { final HttpHost target = new HttpHost("https", "somehost", 443); final HttpHost proxy = new HttpHost("someproxy", 8080); final InetAddress remote = InetAddress.getByAddress(new byte[] {10, 0, 0, 1}); final InetAddress local = InetAddress.getByAddress(new byte[] {127, 0, 0, 1}); final HttpRoute route = new HttpRoute(target, local, proxy, true); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); final HttpClientContext context = HttpClientContext.create(); final SocketConfig sconfig = SocketConfig.custom().build(); mgr.setSocketConfig(sconfig); final ConnectionConfig connectionConfig = ConnectionConfig.custom() .setConnectTimeout(234, TimeUnit.MILLISECONDS) .build(); mgr.setConnectionConfig(connectionConfig); final TlsConfig tlsConfig = TlsConfig.custom() .setHandshakeTimeout(345, TimeUnit.MILLISECONDS) .build(); mgr.setTlsConfig(tlsConfig); Mockito.when(dnsResolver.resolve("someproxy", 8080)).thenReturn(Collections.singletonList(new InetSocketAddress(remote, 8080))); Mockito.when(schemePortResolver.resolve(proxy.getSchemeName(), proxy)).thenReturn(8080); Mockito.when(schemePortResolver.resolve(target.getSchemeName(), target)).thenReturn(8443); Mockito.when(tlsSocketStrategyLookup.lookup("https")).thenReturn(tlsSocketStrategy); Mockito.when(detachedSocketFactory.create(Mockito.any(), Mockito.any())).thenReturn(socket); mgr.connect(endpoint1, null, context); Mockito.verify(dnsResolver, Mockito.times(1)).resolve("someproxy", 8080); Mockito.verify(schemePortResolver, Mockito.times(1)).resolve(proxy.getSchemeName(), proxy); Mockito.verify(detachedSocketFactory, Mockito.times(1)).create("http", null); Mockito.verify(socket, Mockito.times(1)).connect(new InetSocketAddress(remote, 8080), 234); Mockito.when(conn.getSocket()).thenReturn(socket); mgr.upgrade(endpoint1, context); Mockito.verify(tlsSocketStrategy, Mockito.times(1)).upgrade( socket, "somehost", 443, tlsConfig, context); } @Test void shouldCloseStaleConnectionAndCreateNewOne() throws Exception { final HttpHost target = new HttpHost("somehost", 80); final HttpRoute route = new HttpRoute(target); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); Mockito.when(conn.isOpen()).thenReturn(Boolean.TRUE); Mockito.when(conn.isConsistent()).thenReturn(Boolean.TRUE); mgr.release(endpoint1, null, TimeValue.ofMilliseconds(100)); Assertions.assertEquals(route, mgr.getRoute()); Assertions.assertNull(mgr.getState()); final LeaseRequest connRequest2 = mgr.lease("some-id", route, null); Mockito.when(conn.isStale()).thenReturn(Boolean.TRUE); final ConnectionEndpoint conn2 = connRequest2.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(conn2); Assertions.assertTrue(conn2.isConnected()); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); } @Test void shouldCloseGRACEFULStaleConnection() throws Exception { final HttpHost target = new HttpHost("somehost", 80); final HttpRoute route = new HttpRoute(target); Mockito.when(connFactory.createConnection(Mockito.any())).thenReturn(conn); final LeaseRequest connRequest1 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint1 = connRequest1.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint1); Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); Mockito.when(conn.isOpen()).thenReturn(Boolean.TRUE); Mockito.when(conn.isConsistent()).thenReturn(Boolean.TRUE); // Simulate the connection being released with no keep-alive (it should be closed) mgr.release(endpoint1, null, null); // Ensure the connection was closed Mockito.verify(conn, Mockito.times(1)).close(CloseMode.GRACEFUL); // Now, when a new lease request is made, the connection is stale Mockito.when(conn.isStale()).thenReturn(Boolean.TRUE); // Attempt to lease a new connection final LeaseRequest connRequest2 = mgr.lease("some-id", route, null); final ConnectionEndpoint endpoint2 = connRequest2.get(Timeout.ZERO_MILLISECONDS); Assertions.assertNotNull(endpoint2); // The connection should be closed and a new one created because the old one was stale Mockito.verify(connFactory, Mockito.times(1)).createConnection(Mockito.any()); // The new connection should be connected Assertions.assertTrue(endpoint2.isConnected()); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/TestDefaultRedirectStrategy.java0100664 0000000 0000000 00000043450 15063503632 030733 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import java.net.URI; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpPost; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpException; import org.apache.hc.core5.http.HttpHeaders; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.ProtocolException; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.http.support.BasicRequestBuilder; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestDefaultRedirectStrategy { @Test void testIsRedirectedMovedTemporary() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); Assertions.assertFalse(redirectStrategy.isRedirected(httpget, response, context)); response.setHeader(HttpHeaders.LOCATION, "http://localhost/blah"); Assertions.assertTrue(redirectStrategy.isRedirected(httpget, response, context)); } @Test void testIsRedirectedMovedTemporaryNoLocation() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); Assertions.assertFalse(redirectStrategy.isRedirected(httpget, response, context)); } @Test void testIsRedirectedMovedPermanently() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_PERMANENTLY, "Redirect"); Assertions.assertFalse(redirectStrategy.isRedirected(httpget, response, context)); response.setHeader(HttpHeaders.LOCATION, "http://localhost/blah"); Assertions.assertTrue(redirectStrategy.isRedirected(httpget, response, context)); } @Test void testIsRedirectedTemporaryRedirect() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_TEMPORARY_REDIRECT, "Redirect"); Assertions.assertFalse(redirectStrategy.isRedirected(httpget, response, context)); response.setHeader(HttpHeaders.LOCATION, "http://localhost/blah"); Assertions.assertTrue(redirectStrategy.isRedirected(httpget, response, context)); } @Test void testIsRedirectedSeeOther() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SEE_OTHER, "Redirect"); Assertions.assertFalse(redirectStrategy.isRedirected(httpget, response, context)); response.setHeader(HttpHeaders.LOCATION, "http://localhost/blah"); Assertions.assertTrue(redirectStrategy.isRedirected(httpget, response, context)); } @Test void testIsRedirectedUnknownStatus() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(333, "Redirect"); Assertions.assertFalse(redirectStrategy.isRedirected(httpget, response, context)); final HttpPost httppost = new HttpPost("http://localhost/"); Assertions.assertFalse(redirectStrategy.isRedirected(httppost, response, context)); } @Test void testIsRedirectedInvalidInput() { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_SEE_OTHER, "Redirect"); Assertions.assertThrows(NullPointerException.class, () -> redirectStrategy.isRedirected(null, response, context)); Assertions.assertThrows(NullPointerException.class, () -> redirectStrategy.isRedirected(httpget, null, context)); } @Test void testGetLocationUri() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); response.addHeader("Location", "http://localhost/stuff"); final URI uri = redirectStrategy.getLocationURI(httpget, response, context); Assertions.assertEquals(URI.create("http://localhost/stuff"), uri); } @Test void testGetLocationUriMissingHeader() { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); Assertions.assertThrows(HttpException.class, () -> redirectStrategy.getLocationURI(httpget, response, context)); } @Test void testGetLocationUriInvalidLocation() { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); response.addHeader("Location", "http://localhost/not valid"); Assertions.assertThrows(ProtocolException.class, () -> redirectStrategy.getLocationURI(httpget, response, context)); } @Test void testGetLocationUriRelative() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); response.addHeader("Location", "/stuff"); final URI uri = redirectStrategy.getLocationURI(httpget, response, context); Assertions.assertEquals(URI.create("http://localhost/stuff"), uri); } @Test void testGetLocationUriRelativeWithFragment() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); response.addHeader("Location", "/stuff#fragment"); final URI uri = redirectStrategy.getLocationURI(httpget, response, context); Assertions.assertEquals(URI.create("http://localhost/stuff#fragment"), uri); } @Test void testGetLocationUriAbsoluteWithFragment() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); response.addHeader("Location", "http://localhost/stuff#fragment"); final URI uri = redirectStrategy.getLocationURI(httpget, response, context); Assertions.assertEquals(URI.create("http://localhost/stuff#fragment"), uri); } @Test void testGetLocationUriNormalized() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); response.addHeader("Location", "http://localhost/././stuff/../morestuff"); final URI uri = redirectStrategy.getLocationURI(httpget, response, context); Assertions.assertEquals(URI.create("http://localhost/morestuff"), uri); } @Test void testGetLocationUriInvalidInput() { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet httpget = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); response.addHeader("Location", "http://localhost/stuff"); Assertions.assertThrows(NullPointerException.class, () -> redirectStrategy.getLocationURI(null, response, context)); Assertions.assertThrows(NullPointerException.class, () -> redirectStrategy.getLocationURI(httpget, null, context)); Assertions.assertThrows(NullPointerException.class, () -> redirectStrategy.getLocationURI(httpget, response, null)); } @Test void testCreateLocationURI() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); Assertions.assertEquals("http://blahblah/", redirectStrategy.createLocationURI("http://BlahBlah").toASCIIString()); } @Test void testCreateLocationURIInvalid() { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); Assertions.assertThrows(ProtocolException.class, () -> redirectStrategy.createLocationURI(":::::::")); } @Test void testResolveRelativeLocation() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet request = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); response.addHeader("Location", "/foo;bar=baz"); final URI locationURI = redirectStrategy.getLocationURI(request, response, context); Assertions.assertEquals(URI.create("http://localhost/foo;bar=baz"), locationURI); } @Test void testUseAbsoluteLocation() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); final HttpClientContext context = HttpClientContext.create(); final HttpGet request = new HttpGet("http://localhost/"); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_MOVED_TEMPORARILY, "Redirect"); response.addHeader("Location", "http://localhost/foo;bar=baz"); final URI locationURI = redirectStrategy.getLocationURI(request, response, context); Assertions.assertEquals(URI.create("http://localhost/foo;bar=baz"), locationURI); } @Test void testRedirectAllowed() throws Exception { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); Assertions.assertTrue(redirectStrategy.isRedirectAllowed( new HttpHost("somehost", 1234), new HttpHost("somehost", 1234), BasicRequestBuilder.get("/").build(), null)); Assertions.assertTrue(redirectStrategy.isRedirectAllowed( new HttpHost("somehost", 1234), new HttpHost("somehost", 1234), BasicRequestBuilder.get("/") .build(), null)); Assertions.assertTrue(redirectStrategy.isRedirectAllowed( new HttpHost("somehost", 1234), new HttpHost("somehost", 1234), BasicRequestBuilder.get("/") .addHeader(HttpHeaders.AUTHORIZATION, "let me pass") .build(), null)); Assertions.assertTrue(redirectStrategy.isRedirectAllowed( new HttpHost("somehost", 1234), new HttpHost("somehost", 1234), BasicRequestBuilder.get("/") .addHeader(HttpHeaders.COOKIE, "stuff=blah") .build(), null)); Assertions.assertTrue(redirectStrategy.isRedirectAllowed( new HttpHost("somehost", 1234), new HttpHost("someotherhost", 1234), BasicRequestBuilder.get("/") .build(), null)); Assertions.assertFalse(redirectStrategy.isRedirectAllowed( new HttpHost("somehost", 1234), new HttpHost("someotherhost", 1234), BasicRequestBuilder.get("/") .addHeader(HttpHeaders.AUTHORIZATION, "let me pass") .build(), null)); Assertions.assertFalse(redirectStrategy.isRedirectAllowed( new HttpHost("somehost", 1234), new HttpHost("someotherhost", 1234), BasicRequestBuilder.get("/") .addHeader(HttpHeaders.COOKIE, "stuff=blah") .build(), null)); Assertions.assertFalse(redirectStrategy.isRedirectAllowed( new HttpHost("somehost", 1234), new HttpHost("somehost", 80), BasicRequestBuilder.get("/") .addHeader(HttpHeaders.AUTHORIZATION, "let me pass") .build(), null)); Assertions.assertFalse(redirectStrategy.isRedirectAllowed( new HttpHost("somehost", 1234), new HttpHost("somehost", 80), BasicRequestBuilder.get("/") .addHeader(HttpHeaders.COOKIE, "stuff=blah") .build(), null)); } @Test void testRedirectAllowedDefaultPortNormalization() { final DefaultRedirectStrategy redirectStrategy = new DefaultRedirectStrategy(); // HTTPS with explicit 443 vs HTTPS with no port (defaults to 443) final HttpHost explicitHttps = new HttpHost("https", "example.com", 443); final HttpHost implicitHttps = new HttpHost("https", "example.com", -1); Assertions.assertTrue(redirectStrategy.isRedirectAllowed( explicitHttps, implicitHttps, BasicRequestBuilder.get("/") .addHeader(HttpHeaders.AUTHORIZATION, "token") .build(), null)); Assertions.assertTrue(redirectStrategy.isRedirectAllowed( implicitHttps, explicitHttps, BasicRequestBuilder.get("/") .addHeader(HttpHeaders.COOKIE, "cookie=123") .build(), null)); final HttpHost explicitHttp = new HttpHost("http", "example.org", 80); final HttpHost implicitHttp = new HttpHost("http", "example.org", -1); Assertions.assertTrue(redirectStrategy.isRedirectAllowed( explicitHttp, implicitHttp, BasicRequestBuilder.get("/") .addHeader(HttpHeaders.AUTHORIZATION, "token123") .build(), null)); Assertions.assertTrue(redirectStrategy.isRedirectAllowed( implicitHttp, explicitHttp, BasicRequestBuilder.get("/") .addHeader(HttpHeaders.COOKIE, "cookie=abc") .build(), null)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/TestDefaultConnKeepAliveStrategy.java0100664 0000000 0000000 00000011255 14704162040 031646 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.apache.hc.client5.http.ConnectionKeepAliveStrategy; import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.protocol.HttpClientContext; import org.apache.hc.core5.http.HttpResponse; import org.apache.hc.core5.http.HttpStatus; import org.apache.hc.core5.http.message.BasicHttpResponse; import org.apache.hc.core5.util.TimeValue; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Simple tests for {@link DefaultConnectionKeepAliveStrategy}. */ class TestDefaultConnKeepAliveStrategy { @Test void testIllegalResponseArg() { final HttpClientContext context = HttpClientContext.create(); final ConnectionKeepAliveStrategy keepAliveStrat = new DefaultConnectionKeepAliveStrategy(); Assertions.assertThrows(NullPointerException.class, () -> keepAliveStrat.getKeepAliveDuration(null, context)); } @Test void testNoKeepAliveHeader() { final HttpClientContext context = HttpClientContext.create(); context.setRequestConfig( RequestConfig.custom() .setConnectionKeepAlive(TimeValue.NEG_ONE_MILLISECOND) .build()); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_OK); final ConnectionKeepAliveStrategy keepAliveStrat = new DefaultConnectionKeepAliveStrategy(); final TimeValue d = keepAliveStrat.getKeepAliveDuration(response, context); Assertions.assertEquals(TimeValue.NEG_ONE_MILLISECOND, d); } @Test void testEmptyKeepAliveHeader() { final HttpClientContext context = HttpClientContext.create(); context.setRequestConfig( RequestConfig.custom() .setConnectionKeepAlive(TimeValue.NEG_ONE_MILLISECOND) .build()); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_OK); response.addHeader("Keep-Alive", "timeout, max=20"); final ConnectionKeepAliveStrategy keepAliveStrat = new DefaultConnectionKeepAliveStrategy(); final TimeValue d = keepAliveStrat.getKeepAliveDuration(response, context); Assertions.assertEquals(TimeValue.NEG_ONE_MILLISECOND, d); } @Test void testInvalidKeepAliveHeader() { final HttpClientContext context = HttpClientContext.create(); context.setRequestConfig( RequestConfig.custom() .setConnectionKeepAlive(TimeValue.NEG_ONE_MILLISECOND) .build()); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_OK); response.addHeader("Keep-Alive", "timeout=whatever, max=20"); final ConnectionKeepAliveStrategy keepAliveStrat = new DefaultConnectionKeepAliveStrategy(); final TimeValue d = keepAliveStrat.getKeepAliveDuration(response, context); Assertions.assertEquals(TimeValue.NEG_ONE_MILLISECOND, d); } @Test void testKeepAliveHeader() { final HttpClientContext context = HttpClientContext.create(); context.setRequestConfig( RequestConfig.custom() .setConnectionKeepAlive(TimeValue.NEG_ONE_MILLISECOND) .build()); final HttpResponse response = new BasicHttpResponse(HttpStatus.SC_OK); response.addHeader("Keep-Alive", "timeout=300, max=20"); final ConnectionKeepAliveStrategy keepAliveStrat = new DefaultConnectionKeepAliveStrategy(); final TimeValue d = keepAliveStrat.getKeepAliveDuration(response, context); Assertions.assertEquals(TimeValue.ofSeconds(300), d); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/cookie/0040775 0000000 0000000 00000000000 15005672035 023705 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/impl/cookie/TestBasicCookieStore.java0100664 0000000 0000000 00000010126 15005672016 030574 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import java.time.Instant; import java.time.temporal.ChronoUnit; import java.util.List; import org.apache.hc.client5.http.cookie.BasicCookieStore; import org.apache.hc.client5.http.cookie.Cookie; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Unit tests for {@link BasicCookieStore}. */ class TestBasicCookieStore { @Test void testBasics() { final BasicCookieStore store = new BasicCookieStore(); store.addCookie(new BasicClientCookie("name1", "value1")); store.addCookies(new BasicClientCookie[] {new BasicClientCookie("name2", "value2")}); List list = store.getCookies(); Assertions.assertNotNull(list); Assertions.assertEquals(2, list.size()); Assertions.assertEquals("name1", list.get(0).getName()); Assertions.assertEquals("name2", list.get(1).getName()); store.clear(); list = store.getCookies(); Assertions.assertNotNull(list); Assertions.assertEquals(0, list.size()); } @Test void testExpiredCookie() { final BasicCookieStore store = new BasicCookieStore(); final BasicClientCookie cookie = new BasicClientCookie("name1", "value1"); final Instant minus_10_days = Instant.now().minus(10, ChronoUnit.DAYS); cookie.setExpiryDate(minus_10_days); store.addCookie(cookie); final List list = store.getCookies(); Assertions.assertNotNull(list); Assertions.assertEquals(0, list.size()); } @Test void testSerialization() throws Exception { final BasicCookieStore orig = new BasicCookieStore(); orig.addCookie(new BasicClientCookie("name1", "value1")); orig.addCookie(new BasicClientCookie("name2", "value2")); final ByteArrayOutputStream outbuffer = new ByteArrayOutputStream(); final ObjectOutputStream outStream = new ObjectOutputStream(outbuffer); outStream.writeObject(orig); outStream.close(); final byte[] raw = outbuffer.toByteArray(); final ByteArrayInputStream inBuffer = new ByteArrayInputStream(raw); final ObjectInputStream inStream = new ObjectInputStream(inBuffer); final BasicCookieStore clone = (BasicCookieStore) inStream.readObject(); final List expected = orig.getCookies(); final List clones = clone.getCookies(); Assertions.assertNotNull(expected); Assertions.assertNotNull(clones); Assertions.assertEquals(expected.size(), clones.size()); for (int i = 0; i < expected.size(); i++) { Assertions.assertEquals(expected.get(i).getName(), clones.get(i).getName()); Assertions.assertEquals(expected.get(i).getValue(), clones.get(i).getValue()); } } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/cookie/TestRFC6265CookieSpec.java0100664 0000000 0000000 00000036472 15005672035 030323 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.util.Arrays; import java.util.Collections; import java.util.List; import org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.message.BasicHeader; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; import org.mockito.ArgumentMatchers; import org.mockito.Mockito; class TestRFC6265CookieSpec { @Test void testParseCookieBasics() throws Exception { final CommonCookieAttributeHandler h1 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h1.getAttributeName()).thenReturn("this"); final CommonCookieAttributeHandler h2 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h2.getAttributeName()).thenReturn("that"); final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(h1, h2); final Header header = new BasicHeader("Set-Cookie", "name = value ; this = stuff;"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final List cookies = cookiespec.parse(header, origin); Assertions.assertEquals(1, cookies.size()); final Cookie cookie = cookies.get(0); Assertions.assertEquals("name", cookie.getName()); Assertions.assertEquals("value", cookie.getValue()); Assertions.assertEquals("/path", cookie.getPath()); Assertions.assertEquals("host", cookie.getDomain()); Assertions.assertEquals("stuff", cookie.getAttribute("this")); Assertions.assertNull(cookie.getAttribute("that")); Mockito.verify(h1).parse(ArgumentMatchers.any(), ArgumentMatchers.eq("stuff")); Mockito.verify(h2, Mockito.never()).parse(ArgumentMatchers.any(), ArgumentMatchers.anyString()); } @Test void testParseCookieQuotedValue() throws Exception { final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(); final Header header = new BasicHeader("Set-Cookie", "name = \" one, two, three; four \" ; this = stuff;"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final List cookies = cookiespec.parse(header, origin); Assertions.assertEquals(1, cookies.size()); final Cookie cookie = cookies.get(0); Assertions.assertEquals("name", cookie.getName()); Assertions.assertEquals(" one, two, three; four ", cookie.getValue()); Assertions.assertEquals("stuff", cookie.getAttribute("this")); } @Test void testParseCookieWrongHeader() { final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(); final Header header = new BasicHeader("Set-Cookie2", "blah"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); Assertions.assertThrows(MalformedCookieException.class, () -> cookiespec.parse(header, origin)); } @Test void testParseCookieMissingName() throws Exception { final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(); final Header header = new BasicHeader("Set-Cookie", "=blah ; this = stuff;"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final List cookies = cookiespec.parse(header, origin); Assertions.assertEquals(0, cookies.size()); } @Test void testParseCookieMissingValue1() throws Exception { final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(); final Header header = new BasicHeader("Set-Cookie", "blah"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final List cookies = cookiespec.parse(header, origin); Assertions.assertEquals(0, cookies.size()); } @Test void testParseCookieMissingValue2() { final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(); final Header header = new BasicHeader("Set-Cookie", "blah;"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); Assertions.assertThrows(MalformedCookieException.class, () -> cookiespec.parse(header, origin)); } @Test void testParseCookieEmptyValue() throws Exception { final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(); final Header header = new BasicHeader("Set-Cookie", "blah=;"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final List cookies = cookiespec.parse(header, origin); Assertions.assertEquals(1, cookies.size()); final Cookie cookie = cookies.get(0); Assertions.assertEquals("blah", cookie.getName()); Assertions.assertEquals("", cookie.getValue()); } @Test void testParseCookieWithAttributes() throws Exception { final CommonCookieAttributeHandler h1 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h1.getAttributeName()).thenReturn("this"); final CommonCookieAttributeHandler h2 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h2.getAttributeName()).thenReturn("that"); final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(h1, h2); final Header header = new BasicHeader("Set-Cookie", "name = value ; p1 = v ; p2 = v,0; p3 ; p4"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final List cookies = cookiespec.parse(header, origin); Assertions.assertEquals(1, cookies.size()); final Cookie cookie = cookies.get(0); Assertions.assertEquals("name", cookie.getName()); Assertions.assertEquals("value", cookie.getValue()); Assertions.assertEquals("v", cookie.getAttribute("p1")); Assertions.assertEquals("v,0", cookie.getAttribute("p2")); Assertions.assertTrue(cookie.containsAttribute("p3")); Assertions.assertTrue(cookie.containsAttribute("p4")); Assertions.assertFalse(cookie.containsAttribute("p5")); } @Test void testParseCookieWithAttributes2() throws Exception { final CommonCookieAttributeHandler h1 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h1.getAttributeName()).thenReturn("this"); final CommonCookieAttributeHandler h2 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h2.getAttributeName()).thenReturn("that"); final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(h1, h2); final Header header = new BasicHeader("Set-Cookie", "name = value ; p1 = v"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final List cookies = cookiespec.parse(header, origin); Assertions.assertEquals(1, cookies.size()); final Cookie cookie = cookies.get(0); Assertions.assertEquals("name", cookie.getName()); Assertions.assertEquals("value", cookie.getValue()); Assertions.assertEquals("v", cookie.getAttribute("p1")); } @Test void testParseCookieWithAttributes3() throws Exception { final CommonCookieAttributeHandler h1 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h1.getAttributeName()).thenReturn("this"); final CommonCookieAttributeHandler h2 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h2.getAttributeName()).thenReturn("that"); final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(h1, h2); final Header header = new BasicHeader("Set-Cookie", "name = value ; p1 ="); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final List cookies = cookiespec.parse(header, origin); Assertions.assertEquals(1, cookies.size()); final Cookie cookie = cookies.get(0); Assertions.assertEquals("name", cookie.getName()); Assertions.assertEquals("value", cookie.getValue()); Assertions.assertEquals("", cookie.getAttribute("p1")); } @Test void testParseCookieWithHttpOnly() throws Exception { final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(); final Header header = new BasicHeader("Set-Cookie", "name = value ; HttpOnly"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final List cookies = cookiespec.parse(header, origin); Assertions.assertEquals(1, cookies.size()); final Cookie cookie = cookies.get(0); Assertions.assertTrue(cookie.containsAttribute(Cookie.HTTP_ONLY_ATTR)); } @Test void testValidateCookieBasics() throws Exception { final CommonCookieAttributeHandler h1 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h1.getAttributeName()).thenReturn("this"); final CommonCookieAttributeHandler h2 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h2.getAttributeName()).thenReturn("that"); final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(h1, h2); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final BasicClientCookie cookie = new BasicClientCookie("name", "value"); cookiespec.validate(cookie, origin); Mockito.verify(h1).validate(cookie, origin); Mockito.verify(h2).validate(cookie, origin); } @Test void testMatchCookie() { final CommonCookieAttributeHandler h1 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h1.getAttributeName()).thenReturn("this"); final CommonCookieAttributeHandler h2 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h2.getAttributeName()).thenReturn("that"); final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(h1, h2); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final BasicClientCookie cookie = new BasicClientCookie("name", "value"); Mockito.when(h1.match(cookie, origin)).thenReturn(true); Mockito.when(h2.match(cookie, origin)).thenReturn(true); Assertions.assertTrue(cookiespec.match(cookie, origin)); Mockito.verify(h1).match(cookie, origin); Mockito.verify(h2).match(cookie, origin); } @Test void testMatchCookieNoMatch() { final CommonCookieAttributeHandler h1 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h1.getAttributeName()).thenReturn("this"); final CommonCookieAttributeHandler h2 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h2.getAttributeName()).thenReturn("that"); final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(h1, h2); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); final BasicClientCookie cookie = new BasicClientCookie("name", "value"); Mockito.when(h1.match(cookie, origin)).thenReturn(false); Mockito.when(h2.match(cookie, origin)).thenReturn(false); Assertions.assertFalse(cookiespec.match(cookie, origin)); Mockito.verify(h1).match(cookie, origin); Mockito.verify(h2, Mockito.never()).match(cookie, origin); } @Test void testFormatCookiesBasics() { final Cookie cookie1 = new BasicClientCookie("name1", "value"); final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(); final List
headers = cookiespec.formatCookies(Collections.singletonList(cookie1)); Assertions.assertNotNull(headers); Assertions.assertEquals(1, headers.size()); final Header header = headers.get(0); Assertions.assertEquals("Cookie", header.getName()); Assertions.assertEquals("name1=value", header.getValue()); } @Test void testFormatCookiesIllegalCharsInValue() { final Cookie cookie1 = new BasicClientCookie("name1", "value"); final Cookie cookie2 = new BasicClientCookie("name2", "some value"); final Cookie cookie3 = new BasicClientCookie("name3", "\"\\\""); final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(); final List
headers = cookiespec.formatCookies(Arrays.asList(cookie1, cookie2, cookie3)); Assertions.assertNotNull(headers); Assertions.assertEquals(1, headers.size()); final Header header = headers.get(0); Assertions.assertEquals("Cookie", header.getName()); Assertions.assertEquals("name1=value; name2=\"some value\"; name3=\"\\\"\\\\\\\"\"", header.getValue()); } @Test void testParseCookieMultipleAttributes() throws Exception { final CommonCookieAttributeHandler h1 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h1.getAttributeName()).thenReturn("this"); final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(h1); final Header header = new BasicHeader("Set-Cookie", "name = value ; this = stuff; this = morestuff;"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); cookiespec.parse(header, origin); Mockito.verify(h1).parse(ArgumentMatchers.any(), ArgumentMatchers.eq("morestuff")); Mockito.verify(h1, Mockito.times(1)).parse(ArgumentMatchers.any(), ArgumentMatchers.anyString()); } @Test void testParseCookieMaxAgeOverExpires() throws Exception { final CommonCookieAttributeHandler h1 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h1.getAttributeName()).thenReturn("Expires"); final CommonCookieAttributeHandler h2 = Mockito.mock(CommonCookieAttributeHandler.class); Mockito.when(h2.getAttributeName()).thenReturn("Max-Age"); final RFC6265CookieSpec cookiespec = new RFC6265CookieSpec(h1, h2); final Header header = new BasicHeader("Set-Cookie", "name = value ; expires = stuff; max-age = otherstuff;"); final CookieOrigin origin = new CookieOrigin("host", 80, "/path/", true); cookiespec.parse(header, origin); Mockito.verify(h1, Mockito.never()).parse(ArgumentMatchers.any(), ArgumentMatchers.anyString()); Mockito.verify(h2).parse(ArgumentMatchers.any(), ArgumentMatchers.eq("otherstuff")); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/cookie/TestBasicCookieAttribHandlers.java0100664 0000000 0000000 00000041710 14704162040 032405 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.Instant; import java.util.Arrays; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieAttributeHandler; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.psl.DomainType; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.apache.hc.client5.http.utils.DateUtils; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestBasicCookieAttribHandlers { @Test void testBasicDomainParse() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; h.parse(cookie, "www.somedomain.com"); Assertions.assertEquals("www.somedomain.com", cookie.getDomain()); } @Test void testBasicDomainParseInvalid1() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "")); } @Test void testBasicDomainParseInvalid2() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, null)); } @Test void testBasicDomainValidate1() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("www.somedomain.com", 80, "/", false); final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; cookie.setDomain(".somedomain.com"); h.validate(cookie, origin); cookie.setDomain(".otherdomain.com"); Assertions.assertThrows(MalformedCookieException.class, () -> h.validate(cookie, origin)); cookie.setDomain("www.otherdomain.com"); Assertions.assertThrows(MalformedCookieException.class, () -> h.validate(cookie, origin)); } @Test void testBasicDomainValidate2() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("somehost", 80, "/", false); final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; cookie.setDomain("somehost"); h.validate(cookie, origin); cookie.setDomain("otherhost"); Assertions.assertThrows(MalformedCookieException.class, () -> h.validate(cookie, origin)); } @Test void testBasicDomainValidate3() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("somedomain.com", 80, "/", false); final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; cookie.setDomain(".somedomain.com"); h.validate(cookie, origin); } @Test void testBasicDomainValidate4() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("somedomain.com", 80, "/", false); final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; cookie.setDomain(null); Assertions.assertThrows(MalformedCookieException.class, () -> h.validate(cookie, origin)); } @Test void testBasicDomainMatch1() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("somedomain.com", 80, "/", false); final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; cookie.setDomain("somedomain.com"); cookie.setAttribute(Cookie.DOMAIN_ATTR, "somedomain.com"); Assertions.assertTrue(h.match(cookie, origin)); cookie.setDomain(".somedomain.com"); Assertions.assertTrue(h.match(cookie, origin)); } @Test void testBasicDomainMatch2() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("www.somedomain.com", 80, "/", false); final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; cookie.setDomain("somedomain.com"); cookie.setAttribute(Cookie.DOMAIN_ATTR, "somedomain.com"); Assertions.assertTrue(h.match(cookie, origin)); cookie.setDomain(".somedomain.com"); Assertions.assertTrue(h.match(cookie, origin)); cookie.setDomain(null); Assertions.assertFalse(h.match(cookie, origin)); } @Test void testBasicDomainMatchOneLetterPrefix() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("a.somedomain.com", 80, "/", false); final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; cookie.setDomain("somedomain.com"); cookie.setAttribute(Cookie.DOMAIN_ATTR, "somedomain.com"); Assertions.assertTrue(h.match(cookie, origin)); } @Test void testBasicDomainMatchMixedCase() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("a.SomeDomain.com", 80, "/", false); final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; cookie.setDomain("somedoMain.Com"); cookie.setAttribute(Cookie.DOMAIN_ATTR, "somedoMain.Com"); Assertions.assertTrue(h.match(cookie, origin)); } @Test void testBasicDomainInvalidInput() { final CookieAttributeHandler h = BasicDomainHandler.INSTANCE; Assertions.assertThrows(NullPointerException.class, () -> h.parse(null, null)); Assertions.assertThrows(NullPointerException.class, () -> h.validate(null, null)); Assertions.assertThrows(NullPointerException.class, () -> h.validate(new BasicClientCookie("name", "value"), null)); Assertions.assertThrows(NullPointerException.class, () -> h.match(null, null)); Assertions.assertThrows(NullPointerException.class, () -> h.match(new BasicClientCookie("name", "value"), null)); } @Test void testBasicPathParse() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = BasicPathHandler.INSTANCE; h.parse(cookie, "stuff"); Assertions.assertEquals("stuff", cookie.getPath()); h.parse(cookie, ""); Assertions.assertEquals("/", cookie.getPath()); h.parse(cookie, null); Assertions.assertEquals("/", cookie.getPath()); } @Test void testBasicPathMatch1() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("somehost", 80, "/stuff", false); final CookieAttributeHandler h = BasicPathHandler.INSTANCE; cookie.setPath("/stuff"); Assertions.assertTrue(h.match(cookie, origin)); } @Test void testBasicPathMatch2() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("somehost", 80, "/stuff/", false); final CookieAttributeHandler h = BasicPathHandler.INSTANCE; cookie.setPath("/stuff"); Assertions.assertTrue(h.match(cookie, origin)); } @Test void testBasicPathMatch3() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("somehost", 80, "/stuff/more-stuff", false); final CookieAttributeHandler h = BasicPathHandler.INSTANCE; cookie.setPath("/stuff"); Assertions.assertTrue(h.match(cookie, origin)); } @Test void testBasicPathMatch4() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("somehost", 80, "/stuffed", false); final CookieAttributeHandler h = BasicPathHandler.INSTANCE; cookie.setPath("/stuff"); Assertions.assertFalse(h.match(cookie, origin)); } @Test void testBasicPathMatch5() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("somehost", 80, "/otherstuff", false); final CookieAttributeHandler h = BasicPathHandler.INSTANCE; cookie.setPath("/stuff"); Assertions.assertFalse(h.match(cookie, origin)); } @Test void testBasicPathMatch6() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("somehost", 80, "/stuff", false); final CookieAttributeHandler h = BasicPathHandler.INSTANCE; cookie.setPath("/stuff/"); Assertions.assertTrue(h.match(cookie, origin)); } @Test void testBasicPathMatch7() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieOrigin origin = new CookieOrigin("somehost", 80, "/stuff", false); final CookieAttributeHandler h = BasicPathHandler.INSTANCE; Assertions.assertTrue(h.match(cookie, origin)); } @Test void testBasicPathInvalidInput() { final CookieAttributeHandler h = BasicPathHandler.INSTANCE; Assertions.assertThrows(NullPointerException.class, () -> h.parse(null, null)); Assertions.assertThrows(NullPointerException.class, () -> h.match(null, null)); Assertions.assertThrows(NullPointerException.class, () -> h.match(new BasicClientCookie("name", "value"), null)); } @Test void testBasicMaxAgeParse() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = BasicMaxAgeHandler.INSTANCE; h.parse(cookie, "2000"); Assertions.assertNotNull(cookie.getExpiryInstant()); } @Test void testBasicMaxAgeParseInvalid() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = BasicMaxAgeHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "garbage")); Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, null)); } @Test void testBasicMaxAgeInvalidInput() { final CookieAttributeHandler h = BasicMaxAgeHandler.INSTANCE; Assertions.assertThrows(NullPointerException.class, () -> h.parse(null, null)); } @Test void testBasicSecureParse() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = BasicSecureHandler.INSTANCE; h.parse(cookie, "whatever"); Assertions.assertTrue(cookie.isSecure()); h.parse(cookie, null); Assertions.assertTrue(cookie.isSecure()); } @Test void testBasicSecureMatch() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = BasicSecureHandler.INSTANCE; final CookieOrigin origin1 = new CookieOrigin("somehost", 80, "/stuff", false); cookie.setSecure(false); Assertions.assertTrue(h.match(cookie, origin1)); cookie.setSecure(true); Assertions.assertFalse(h.match(cookie, origin1)); final CookieOrigin origin2 = new CookieOrigin("somehost", 80, "/stuff", true); cookie.setSecure(false); Assertions.assertTrue(h.match(cookie, origin2)); cookie.setSecure(true); Assertions.assertTrue(h.match(cookie, origin2)); } @Test void testBasicSecureInvalidInput() { final CookieAttributeHandler h = new BasicSecureHandler(); Assertions.assertThrows(NullPointerException.class, () -> h.parse(null, null)); Assertions.assertThrows(NullPointerException.class, () -> h.match(null, null)); Assertions.assertThrows(NullPointerException.class, () -> h.match(new BasicClientCookie("name", "value"), null)); } @Test void testBasicExpiresParse() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = new BasicExpiresHandler(DateUtils.FORMATTER_RFC1123); h.parse(cookie, DateUtils.formatStandardDate(Instant.now())); Assertions.assertNotNull(cookie.getExpiryInstant()); } @Test void testBasicExpiresParseInvalid() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = new BasicExpiresHandler(DateUtils.FORMATTER_RFC1123); Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "garbage")); Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, null)); } @SuppressWarnings("unused") @Test void testBasicExpiresInvalidInput() { final CookieAttributeHandler h = new BasicExpiresHandler(DateUtils.FORMATTER_RFC1123); Assertions.assertThrows(NullPointerException.class, () -> h.parse(null, null)); } @Test void testPublicSuffixFilter() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final PublicSuffixMatcher matcher = new PublicSuffixMatcher(DomainType.ICANN, Arrays.asList("co.uk", "com"), null); final PublicSuffixDomainFilter h = new PublicSuffixDomainFilter(BasicDomainHandler.INSTANCE, matcher); cookie.setDomain(".co.uk"); cookie.setAttribute(Cookie.DOMAIN_ATTR, ".co.uk"); Assertions.assertFalse(h.match(cookie, new CookieOrigin("apache.co.uk", 80, "/stuff", false))); cookie.setDomain("co.uk"); cookie.setAttribute(Cookie.DOMAIN_ATTR, "co.uk"); Assertions.assertFalse(h.match(cookie, new CookieOrigin("apache.co.uk", 80, "/stuff", false))); cookie.setDomain(".co.com"); cookie.setAttribute(Cookie.DOMAIN_ATTR, ".co.com"); Assertions.assertTrue(h.match(cookie, new CookieOrigin("apache.co.com", 80, "/stuff", false))); cookie.setDomain("co.com"); cookie.setAttribute(Cookie.DOMAIN_ATTR, "co.com"); Assertions.assertTrue(h.match(cookie, new CookieOrigin("apache.co.com", 80, "/stuff", false))); cookie.setDomain(".com"); cookie.setAttribute(Cookie.DOMAIN_ATTR, ".com"); Assertions.assertFalse(h.match(cookie, new CookieOrigin("apache.com", 80, "/stuff", false))); cookie.setDomain("com"); cookie.setAttribute(Cookie.DOMAIN_ATTR, "com"); Assertions.assertFalse(h.match(cookie, new CookieOrigin("apache.com", 80, "/stuff", false))); cookie.setDomain("apache.com"); cookie.setAttribute(Cookie.DOMAIN_ATTR, "apache.com"); Assertions.assertTrue(h.match(cookie, new CookieOrigin("apache.com", 80, "/stuff", false))); cookie.setDomain(".apache.com"); cookie.setAttribute(Cookie.DOMAIN_ATTR, ".apache.com"); Assertions.assertTrue(h.match(cookie, new CookieOrigin("www.apache.com", 80, "/stuff", false))); cookie.setDomain("localhost"); cookie.setAttribute(Cookie.DOMAIN_ATTR, "localhost"); Assertions.assertTrue(h.match(cookie, new CookieOrigin("localhost", 80, "/stuff", false))); } @Test void testBasicHttpOnlyParse() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = new BasicHttpOnlyHandler(); h.parse(cookie, "true"); Assertions.assertTrue(cookie.isHttpOnly()); h.parse(cookie, "anyone"); Assertions.assertTrue(cookie.isHttpOnly()); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/cookie/TestBasicClientCookie.java0100664 0000000 0000000 00000007216 14704162040 030720 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.ObjectInputStream; import java.io.ObjectOutputStream; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Unit tests for {@link BasicClientCookie}. */ class TestBasicClientCookie { @SuppressWarnings("unused") @Test void testConstructor() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); Assertions.assertEquals("name", cookie.getName()); Assertions.assertEquals("value", cookie.getValue()); Assertions.assertThrows(NullPointerException.class, () -> new BasicClientCookie(null, null)); } @Test void testCloning() throws Exception { final BasicClientCookie orig = new BasicClientCookie("name", "value"); orig.setDomain("domain"); orig.setPath("/"); orig.setAttribute("attrib", "stuff"); final BasicClientCookie clone = (BasicClientCookie) orig.clone(); Assertions.assertEquals(orig.getName(), clone.getName()); Assertions.assertEquals(orig.getValue(), clone.getValue()); Assertions.assertEquals(orig.getDomain(), clone.getDomain()); Assertions.assertEquals(orig.getPath(), clone.getPath()); Assertions.assertEquals(orig.getAttribute("attrib"), clone.getAttribute("attrib")); } @Test void testSerialization() throws Exception { final BasicClientCookie orig = new BasicClientCookie("name", "value"); orig.setDomain("domain"); orig.setPath("/"); orig.setAttribute("attrib", "stuff"); final ByteArrayOutputStream outbuffer = new ByteArrayOutputStream(); final ObjectOutputStream outStream = new ObjectOutputStream(outbuffer); outStream.writeObject(orig); outStream.close(); final byte[] raw = outbuffer.toByteArray(); final ByteArrayInputStream inBuffer = new ByteArrayInputStream(raw); final ObjectInputStream inStream = new ObjectInputStream(inBuffer); final BasicClientCookie clone = (BasicClientCookie) inStream.readObject(); Assertions.assertEquals(orig.getName(), clone.getName()); Assertions.assertEquals(orig.getValue(), clone.getValue()); Assertions.assertEquals(orig.getDomain(), clone.getDomain()); Assertions.assertEquals(orig.getPath(), clone.getPath()); Assertions.assertEquals(orig.getAttribute("attrib"), clone.getAttribute("attrib")); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/cookie/TestLaxCookieAttribHandlers.java0100664 0000000 0000000 00000044557 14704162040 032124 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.time.LocalDateTime; import java.time.temporal.ChronoField; import org.apache.hc.client5.http.cookie.CookieAttributeHandler; import org.apache.hc.client5.http.cookie.MalformedCookieException; import org.apache.hc.client5.http.utils.DateUtils; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class TestLaxCookieAttribHandlers { @Test void testParseMaxAge() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxMaxAgeHandler.INSTANCE; h.parse(cookie, "2000"); Assertions.assertNotNull(cookie.getExpiryInstant()); } @Test void testParseMaxNegative() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxMaxAgeHandler.INSTANCE; h.parse(cookie, "-2000"); Assertions.assertNotNull(cookie.getExpiryInstant()); } @Test void testParseMaxZero() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxMaxAgeHandler.INSTANCE; h.parse(cookie, "0000"); Assertions.assertNotNull(cookie.getExpiryInstant()); } @Test void testBasicMaxAgeParseEmpty() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxMaxAgeHandler.INSTANCE; h.parse(cookie, " "); Assertions.assertNull(cookie.getExpiryInstant()); } @Test void testBasicMaxAgeParseInvalid() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxMaxAgeHandler.INSTANCE; h.parse(cookie, "garbage"); Assertions.assertNull(cookie.getExpiryInstant()); } @Test void testBasicMaxAgeInvalidInput() { final CookieAttributeHandler h = LaxMaxAgeHandler.INSTANCE; Assertions.assertThrows(NullPointerException.class, () -> h.parse(null, "stuff")); } @Test void testExpiryGarbage() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, ";;blah,blah;yada ")); } @Test void testParseExpiry() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "1:0:12 8-jan-2012"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(2012, expiryDate.get(ChronoField.YEAR)); Assertions.assertEquals(1, expiryDate.get(ChronoField.MONTH_OF_YEAR)); Assertions.assertEquals(8, expiryDate.get(ChronoField.DAY_OF_MONTH)); Assertions.assertEquals(1, expiryDate.get(ChronoField.HOUR_OF_DAY)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MINUTE_OF_HOUR)); Assertions.assertEquals(12, expiryDate.get(ChronoField.SECOND_OF_MINUTE)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MILLI_OF_SECOND)); } @Test void testParseExpiryInstant() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "1:0:12 8-jan-2012"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(2012, expiryDate.get(ChronoField.YEAR)); Assertions.assertEquals(1, expiryDate.get(ChronoField.MONTH_OF_YEAR)); Assertions.assertEquals(8, expiryDate.get(ChronoField.DAY_OF_MONTH)); Assertions.assertEquals(1, expiryDate.get(ChronoField.HOUR_OF_DAY)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MINUTE_OF_HOUR)); Assertions.assertEquals(12, expiryDate.get(ChronoField.SECOND_OF_MINUTE)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MILLI_OF_SECOND)); } @Test void testParseExpiryInvalidTime0() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, null); Assertions.assertNull(cookie.getExpiryInstant()); } @Test void testParseExpiryInvalidTime1() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "1:0:122 8 dec 1980")); } @Test void testParseExpiryInvalidTime2() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "24:00:00 8 dec 1980")); } @Test void testParseExpiryInvalidTime3() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "23:60:00 8 dec 1980")); } @Test void testParseExpiryInvalidTime4() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "23:00:60 8 dec 1980")); } @Test void testParseExpiryFunnyTime() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "1:59:00blah; 8-feb-2000"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(2000, expiryDate.get(ChronoField.YEAR_OF_ERA)); Assertions.assertEquals(2, expiryDate.get(ChronoField.MONTH_OF_YEAR)); Assertions.assertEquals(8, expiryDate.get(ChronoField.DAY_OF_MONTH)); Assertions.assertEquals(1, expiryDate.get(ChronoField.HOUR_OF_DAY)); Assertions.assertEquals(59, expiryDate.get(ChronoField.MINUTE_OF_HOUR)); Assertions.assertEquals(0, expiryDate.get(ChronoField.SECOND_OF_MINUTE)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MILLI_OF_SECOND)); } @Test void testParseExpiryFunnyTimeInstant() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "1:59:00blah; 8-feb-2000"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(2000, expiryDate.get(ChronoField.YEAR_OF_ERA)); Assertions.assertEquals(2, expiryDate.get(ChronoField.MONTH_OF_YEAR)); Assertions.assertEquals(8, expiryDate.get(ChronoField.DAY_OF_MONTH)); Assertions.assertEquals(1, expiryDate.get(ChronoField.HOUR_OF_DAY)); Assertions.assertEquals(59, expiryDate.get(ChronoField.MINUTE_OF_HOUR)); Assertions.assertEquals(0, expiryDate.get(ChronoField.SECOND_OF_MINUTE)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MILLI_OF_SECOND)); } @Test void testParseExpiryInvalidDayOfMonth1() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "12:00:00 888 mar 1880")); } @Test void testParseExpiryInvalidDayOfMonth2() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "12:00:00 0 mar 1880")); } @Test void testParseExpiryInvalidDayOfMonth3() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "12:00:00 32 mar 1880")); } @Test void testParseExpiryFunnyDayOfMonth() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "12:00:00 8blah;mar;1880"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(1880, expiryDate.get(ChronoField.YEAR)); Assertions.assertEquals(3, expiryDate.get(ChronoField.MONTH_OF_YEAR)); Assertions.assertEquals(8, expiryDate.get(ChronoField.DAY_OF_MONTH)); Assertions.assertEquals(12, expiryDate.get(ChronoField.HOUR_OF_DAY)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MINUTE_OF_HOUR)); Assertions.assertEquals(0, expiryDate.get(ChronoField.SECOND_OF_MINUTE)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MILLI_OF_SECOND)); } @Test void testParseExpiryFunnyDayOfMonthInstant() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "12:00:00 8blah;mar;1880"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(1880, expiryDate.get(ChronoField.YEAR)); Assertions.assertEquals(3, expiryDate.get(ChronoField.MONTH_OF_YEAR)); Assertions.assertEquals(8, expiryDate.get(ChronoField.DAY_OF_MONTH)); Assertions.assertEquals(12, expiryDate.get(ChronoField.HOUR_OF_DAY)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MINUTE_OF_HOUR)); Assertions.assertEquals(0, expiryDate.get(ChronoField.SECOND_OF_MINUTE)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MILLI_OF_SECOND)); } @Test void testParseExpiryInvalidMonth() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "1:00:00 8 dek 80")); } @Test void testParseExpiryFunnyMonth() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "23:59:59; 1-ApriLLLLL-2008"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(2008, expiryDate.get(ChronoField.YEAR)); Assertions.assertEquals(4, expiryDate.get(ChronoField.MONTH_OF_YEAR)); Assertions.assertEquals(1, expiryDate.get(ChronoField.DAY_OF_MONTH)); Assertions.assertEquals(23, expiryDate.get(ChronoField.HOUR_OF_DAY)); Assertions.assertEquals(59, expiryDate.get(ChronoField.MINUTE_OF_HOUR)); Assertions.assertEquals(59, expiryDate.get(ChronoField.SECOND_OF_MINUTE)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MILLI_OF_SECOND)); } @Test void testParseExpiryFunnyMonthInstant() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "23:59:59; 1-ApriLLLLL-2008"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(2008, expiryDate.get(ChronoField.YEAR)); Assertions.assertEquals(4, expiryDate.get(ChronoField.MONTH_OF_YEAR)); Assertions.assertEquals(1, expiryDate.get(ChronoField.DAY_OF_MONTH)); Assertions.assertEquals(23, expiryDate.get(ChronoField.HOUR_OF_DAY)); Assertions.assertEquals(59, expiryDate.get(ChronoField.MINUTE_OF_HOUR)); Assertions.assertEquals(59, expiryDate.get(ChronoField.SECOND_OF_MINUTE)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MILLI_OF_SECOND)); } @Test void testParseExpiryInvalidYearTooShort() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "1:00:00 8 dec 8")); } @Test void testParseExpiryInvalidYearTooLong() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "1:00:00 8 dec 88888")); } @Test void testParseExpiryInvalidYearTooLongAgo() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; Assertions.assertThrows(MalformedCookieException.class, () -> h.parse(cookie, "1:00:00 8 dec 1600")); } @Test void testParseExpiryFunnyYear() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "23:59:59; 1-Apr-2008blah"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(2008, expiryDate.get(ChronoField.YEAR)); Assertions.assertEquals(4, expiryDate.get(ChronoField.MONTH_OF_YEAR)); Assertions.assertEquals(1, expiryDate.get(ChronoField.DAY_OF_MONTH)); Assertions.assertEquals(23, expiryDate.get(ChronoField.HOUR_OF_DAY)); Assertions.assertEquals(59, expiryDate.get(ChronoField.MINUTE_OF_HOUR)); Assertions.assertEquals(59, expiryDate.get(ChronoField.SECOND_OF_MINUTE)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MILLI_OF_SECOND)); } @Test void testParseExpiryFunnyYearInstant() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "23:59:59; 1-Apr-2008blah"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(2008, expiryDate.get(ChronoField.YEAR)); Assertions.assertEquals(4, expiryDate.get(ChronoField.MONTH_OF_YEAR)); Assertions.assertEquals(1, expiryDate.get(ChronoField.DAY_OF_MONTH)); Assertions.assertEquals(23, expiryDate.get(ChronoField.HOUR_OF_DAY)); Assertions.assertEquals(59, expiryDate.get(ChronoField.MINUTE_OF_HOUR)); Assertions.assertEquals(59, expiryDate.get(ChronoField.SECOND_OF_MINUTE)); Assertions.assertEquals(0, expiryDate.get(ChronoField.MILLI_OF_SECOND)); } @Test void testParseExpiryYearTwoDigit1() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "23:59:59; 1-Apr-70"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(1970, expiryDate.get(ChronoField.YEAR)); } @Test void testParseExpiryYearTwoDigit2() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "23:59:59; 1-Apr-99"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(1999, expiryDate.get(ChronoField.YEAR)); } @Test void testParseExpiryYearTwoDigit3() throws Exception { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); final CookieAttributeHandler h = LaxExpiresHandler.INSTANCE; h.parse(cookie, "23:59:59; 1-Apr-00"); final LocalDateTime expiryDate = DateUtils.toUTC(cookie.getExpiryInstant()); Assertions.assertNotNull(expiryDate); Assertions.assertEquals(2000, expiryDate.get(ChronoField.YEAR)); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/cookie/TestPublicSuffixListParser.java0100664 0000000 0000000 00000013210 14704162040 032011 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl.cookie; import java.io.InputStream; import java.io.InputStreamReader; import java.nio.charset.StandardCharsets; import org.apache.hc.client5.http.cookie.Cookie; import org.apache.hc.client5.http.cookie.CookieOrigin; import org.apache.hc.client5.http.psl.PublicSuffixList; import org.apache.hc.client5.http.psl.PublicSuffixListParser; import org.apache.hc.client5.http.psl.PublicSuffixMatcher; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class TestPublicSuffixListParser { private static final String SOURCE_FILE = "suffixlist.txt"; private PublicSuffixDomainFilter filter; @BeforeEach void setUp() throws Exception { final ClassLoader classLoader = getClass().getClassLoader(); final PublicSuffixList suffixList; try (InputStream in = classLoader.getResourceAsStream(SOURCE_FILE)) { Assertions.assertNotNull(in, SOURCE_FILE); final PublicSuffixListParser parser = PublicSuffixListParser.INSTANCE; suffixList = parser.parse(new InputStreamReader(in, StandardCharsets.UTF_8)); } final PublicSuffixMatcher matcher = new PublicSuffixMatcher(suffixList.getRules(), suffixList.getExceptions()); this.filter = new PublicSuffixDomainFilter(BasicDomainHandler.INSTANCE, matcher); } @Test void testParse() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); cookie.setAttribute(Cookie.DOMAIN_ATTR, ".jp"); cookie.setDomain(".jp"); Assertions.assertFalse(filter.match(cookie, new CookieOrigin("apache.jp", 80, "/stuff", false))); cookie.setDomain(".ac.jp"); Assertions.assertFalse(filter.match(cookie, new CookieOrigin("apache.ac.jp", 80, "/stuff", false))); cookie.setDomain(".any.tokyo.jp"); Assertions.assertFalse(filter.match(cookie, new CookieOrigin("apache.any.tokyo.jp", 80, "/stuff", false))); // exception cookie.setDomain(".metro.tokyo.jp"); Assertions.assertTrue(filter.match(cookie, new CookieOrigin("apache.metro.tokyo.jp", 80, "/stuff", false))); } @Test void testParseLocal() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); cookie.setDomain("localhost"); cookie.setAttribute(Cookie.DOMAIN_ATTR, "localhost"); Assertions.assertTrue(filter.match(cookie, new CookieOrigin("localhost", 80, "/stuff", false))); cookie.setDomain("somehost"); cookie.setAttribute(Cookie.DOMAIN_ATTR, "somehost"); Assertions.assertTrue(filter.match(cookie, new CookieOrigin("somehost", 80, "/stuff", false))); cookie.setDomain(".localdomain"); cookie.setAttribute(Cookie.DOMAIN_ATTR, ".localdomain"); Assertions.assertTrue(filter.match(cookie, new CookieOrigin("somehost.localdomain", 80, "/stuff", false))); cookie.setDomain(".local."); cookie.setAttribute(Cookie.DOMAIN_ATTR, ".local."); Assertions.assertTrue(filter.match(cookie, new CookieOrigin("somehost.local.", 80, "/stuff", false))); cookie.setDomain(".localhost."); cookie.setAttribute(Cookie.DOMAIN_ATTR, ".localhost."); Assertions.assertTrue(filter.match(cookie, new CookieOrigin("somehost.localhost.", 80, "/stuff", false))); cookie.setDomain(".local"); cookie.setAttribute(Cookie.DOMAIN_ATTR, ".local"); Assertions.assertTrue(filter.match(cookie, new CookieOrigin("somehost.local", 80, "/stuff", false))); cookie.setDomain(".blah"); cookie.setAttribute(Cookie.DOMAIN_ATTR, ".blah"); Assertions.assertFalse(filter.match(cookie, new CookieOrigin("somehost.blah", 80, "/stuff", false))); } @Test void testUnicode() { final BasicClientCookie cookie = new BasicClientCookie("name", "value"); cookie.setDomain(".h\u00E5.no"); // \u00E5 is Assertions.assertFalse(filter.match(cookie, new CookieOrigin("apache.h\u00E5.no", 80, "/stuff", false))); cookie.setDomain(".xn--h-2fa.no"); Assertions.assertFalse(filter.match(cookie, new CookieOrigin("apache.xn--h-2fa.no", 80, "/stuff", false))); cookie.setDomain(".h\u00E5.no"); Assertions.assertFalse(filter.match(cookie, new CookieOrigin("apache.xn--h-2fa.no", 80, "/stuff", false))); cookie.setDomain(".xn--h-2fa.no"); Assertions.assertFalse(filter.match(cookie, new CookieOrigin("apache.h\u00E5.no", 80, "/stuff", false))); } } httpclient5/src/test/java/org/apache/hc/client5/http/impl/ExecSupportTest.java0100664 0000000 0000000 00000003145 14704162040 026413 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.impl; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; class ExecSupportTest { @Test void testGetNextExchangeId() { final long base = ExecSupport.getNextExecNumber(); for (int i = 1; i <= 1_000_000; i++) { Assertions.assertEquals( String.format("ex-%010d", i + base), ExecSupport.getNextExchangeId()); } } } httpclient5/src/test/java/org/apache/hc/client5/http/cookie/0040775 0000000 0000000 00000000000 14704162040 022737 5ustar000000000 0000000 httpclient5/src/test/java/org/apache/hc/client5/http/cookie/TestCookieOrigin.java0100664 0000000 0000000 00000005372 14704162040 027027 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Test cases for {@link CookieOrigin}. */ class TestCookieOrigin { @Test void testConstructor() { final CookieOrigin origin = new CookieOrigin("www.apache.org", 80, "/", false); Assertions.assertEquals("www.apache.org", origin.getHost()); Assertions.assertEquals(80, origin.getPort()); Assertions.assertEquals("/", origin.getPath()); Assertions.assertFalse(origin.isSecure()); } @Test void testNullHost() { Assertions.assertThrows(NullPointerException.class, () -> new CookieOrigin(null, 80, "/", false)); } @Test void testEmptyHost() { Assertions.assertThrows(IllegalArgumentException.class, () -> new CookieOrigin(" ", 80, "/", false)); } @Test void testNegativePort() { Assertions.assertThrows(IllegalArgumentException.class, () -> new CookieOrigin("www.apache.org", -80, "/", false)); } @Test void testNullPath() { Assertions.assertThrows(NullPointerException.class, () -> new CookieOrigin("www.apache.org", 80, null, false)); } @Test void testEmptyPath() { final CookieOrigin origin = new CookieOrigin("www.apache.org", 80, "", false); Assertions.assertEquals("www.apache.org", origin.getHost()); Assertions.assertEquals(80, origin.getPort()); Assertions.assertEquals("/", origin.getPath()); Assertions.assertFalse(origin.isSecure()); } } httpclient5/src/test/java/org/apache/hc/client5/http/cookie/TestCookiePriorityComparator.java0100664 0000000 0000000 00000010522 14704162040 031442 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.time.Instant; import java.util.Comparator; import org.apache.hc.client5.http.impl.cookie.BasicClientCookie; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; /** * Test cases for {@link org.apache.hc.client5.http.cookie.CookiePriorityComparator}. */ class TestCookiePriorityComparator { private Comparator comparator; @BeforeEach void setup() { comparator = CookiePriorityComparator.INSTANCE; } @Test void testUnequality() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath("/a/b/"); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/a/"); Assertions.assertTrue(comparator.compare(cookie1, cookie2) < 0); Assertions.assertTrue(comparator.compare(cookie2, cookie1) > 0); } @Test void testEquality() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath("/a"); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/a"); Assertions.assertEquals(0, comparator.compare(cookie1, cookie2)); Assertions.assertEquals(0, comparator.compare(cookie2, cookie1)); } @Test void testUnequalityTrailingSlash() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath("/a/"); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/a"); Assertions.assertTrue(comparator.compare(cookie1, cookie2) < 0); Assertions.assertTrue(comparator.compare(cookie2, cookie1) > 0); } @Test void testEqualityNullPath() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath(null); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/"); Assertions.assertEquals(0, comparator.compare(cookie1, cookie2)); Assertions.assertEquals(0, comparator.compare(cookie2, cookie1)); } @Test void testEqualitySameLength() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath("/this"); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/that"); Assertions.assertEquals(0, comparator.compare(cookie1, cookie2)); Assertions.assertEquals(0, comparator.compare(cookie2, cookie1)); } @Test void testUnequalityCreationDate() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath("/blah"); cookie1.setCreationDate(Instant.now().minusMillis(200000)); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/blah"); cookie2.setCreationDate(Instant.now()); Assertions.assertTrue(comparator.compare(cookie1, cookie2) < 0); Assertions.assertTrue(comparator.compare(cookie2, cookie1) > 0); } } httpclient5/src/test/java/org/apache/hc/client5/http/cookie/TestCookiePathComparator.java0100664 0000000 0000000 00000010566 14704162040 030525 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http.cookie; import java.util.Comparator; import org.apache.hc.client5.http.impl.cookie.BasicClientCookie; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Test cases for {@link CookiePathComparator}. */ class TestCookiePathComparator { @Test void testUnequality1() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath("/a/b/"); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/a/"); final Comparator comparator = new CookiePathComparator(); Assertions.assertTrue(comparator.compare(cookie1, cookie2) < 0); Assertions.assertTrue(comparator.compare(cookie2, cookie1) > 0); } @Test void testUnequality2() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath("/a/b"); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/a"); final Comparator comparator = new CookiePathComparator(); Assertions.assertTrue(comparator.compare(cookie1, cookie2) < 0); Assertions.assertTrue(comparator.compare(cookie2, cookie1) > 0); } @Test void testEquality1() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath("/a"); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/a"); final Comparator comparator = new CookiePathComparator(); Assertions.assertEquals(0, comparator.compare(cookie1, cookie2)); Assertions.assertEquals(0, comparator.compare(cookie2, cookie1)); } @Test void testEquality2() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath("/a/"); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/a"); final Comparator comparator = new CookiePathComparator(); Assertions.assertEquals(0, comparator.compare(cookie1, cookie2)); Assertions.assertEquals(0, comparator.compare(cookie2, cookie1)); } @Test void testEquality3() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath(null); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/"); final Comparator comparator = new CookiePathComparator(); Assertions.assertEquals(0, comparator.compare(cookie1, cookie2)); Assertions.assertEquals(0, comparator.compare(cookie2, cookie1)); } @Test void testEquality4() { final BasicClientCookie cookie1 = new BasicClientCookie("name1", "value"); cookie1.setPath("/this"); final BasicClientCookie cookie2 = new BasicClientCookie("name1", "value"); cookie2.setPath("/that"); final Comparator comparator = new CookiePathComparator(); Assertions.assertEquals(0, comparator.compare(cookie1, cookie2)); Assertions.assertEquals(0, comparator.compare(cookie2, cookie1)); } } httpclient5/src/test/java/org/apache/hc/client5/http/TestHttpRoute.java0100664 0000000 0000000 00000054411 15063503632 025136 0ustar000000000 0000000 /* * ==================================================================== * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . * */ package org.apache.hc.client5.http; import java.net.InetAddress; import java.util.HashSet; import java.util.Set; import org.apache.hc.client5.http.RouteInfo.LayerType; import org.apache.hc.client5.http.RouteInfo.TunnelType; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.net.URIAuthority; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; /** * Tests for {@link HttpRoute}. */ class TestHttpRoute { // a selection of constants for generating routes public final static HttpHost TARGET1 = new HttpHost("target1.test.invalid", 80); public final static HttpHost TARGET2 = new HttpHost("target2.test.invalid", 8080); // It is not necessary to have extra targets for https. // The 'layered' and 'secure' flags are specified explicitly // for routes, they will not be determined from the scheme. public final static HttpHost PROXY1 = new HttpHost("proxy1.test.invalid"); public final static HttpHost PROXY2 = new HttpHost("proxy2.test.invalid", 1080); public final static HttpHost PROXY3 = new HttpHost("proxy3.test.invalid", 88); public final static InetAddress LOCAL41; public final static InetAddress LOCAL42; public final static InetAddress LOCAL61; public final static InetAddress LOCAL62; // need static initializer to deal with exceptions static { try { LOCAL41 = InetAddress.getByAddress(new byte[]{ 127, 0, 0, 1 }); LOCAL42 = InetAddress.getByAddress(new byte[]{ 127, 0, 0, 2 }); LOCAL61 = InetAddress.getByAddress(new byte[]{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 }); LOCAL62 = InetAddress.getByAddress(new byte[]{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2 }); } catch (final Exception x) { throw new ExceptionInInitializerError(x); } } @Test void testCstrFullRoute() { // create a route with all arguments and check the details final HttpHost[] chain3 = { PROXY1, PROXY2, PROXY3 }; final HttpRoute route = new HttpRoute(TARGET1, LOCAL41, chain3, false, TunnelType.PLAIN, LayerType.PLAIN); Assertions.assertEquals(TARGET1, route.getTargetHost(), "wrong target"); Assertions.assertEquals(LOCAL41, route.getLocalAddress(), "wrong local address"); Assertions.assertEquals(PROXY1, route.getProxyHost(), "wrong proxy host"); Assertions.assertEquals(4, route.getHopCount(), "wrong hop count"); Assertions.assertEquals(PROXY1, route.getHopTarget(0), "wrong hop 0"); Assertions.assertEquals(PROXY2, route.getHopTarget(1), "wrong hop 1"); Assertions.assertEquals(PROXY3, route.getHopTarget(2), "wrong hop 2"); Assertions.assertEquals(TARGET1, route.getHopTarget(3), "wrong hop 3"); Assertions.assertFalse(route.isSecure(), "wrong flag: secured"); Assertions.assertFalse(route.isTunnelled(), "wrong flag: tunnelled"); Assertions.assertFalse(route.isLayered(), "wrong flag: layered"); final String routestr = route.toString(); Assertions.assertTrue(routestr.contains(TARGET1.getHostName()), "missing target in toString"); Assertions.assertTrue(routestr.contains(LOCAL41.toString()), "missing local address in toString"); Assertions.assertTrue(routestr.contains(PROXY1.getHostName()), "missing proxy 1 in toString"); Assertions.assertTrue(routestr.contains(PROXY2.getHostName()), "missing proxy 2 in toString"); Assertions.assertTrue(routestr.contains(PROXY3.getHostName()), "missing proxy 3 in toString"); } @Test void testCstrFullFlags() { // tests the flag parameters in the full-blown constructor final HttpHost[] chain3 = { PROXY1, PROXY2, PROXY3 }; final HttpRoute routefff = new HttpRoute (TARGET1, LOCAL41, chain3, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute routefft = new HttpRoute (TARGET1, LOCAL41, chain3, false, TunnelType.PLAIN, LayerType.LAYERED); final HttpRoute routeftf = new HttpRoute (TARGET1, LOCAL41, chain3, false, TunnelType.TUNNELLED, LayerType.PLAIN); final HttpRoute routeftt = new HttpRoute (TARGET1, LOCAL41, chain3, false, TunnelType.TUNNELLED, LayerType.LAYERED); final HttpRoute routetff = new HttpRoute (TARGET1, LOCAL41, chain3, true, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute routetft = new HttpRoute (TARGET1, LOCAL41, chain3, true, TunnelType.PLAIN, LayerType.LAYERED); final HttpRoute routettf = new HttpRoute (TARGET1, LOCAL41, chain3, true, TunnelType.TUNNELLED, LayerType.PLAIN); final HttpRoute routettt = new HttpRoute (TARGET1, LOCAL41, chain3, true, TunnelType.TUNNELLED, LayerType.LAYERED); Assertions.assertFalse(routefff.isSecure(), "routefff.secure"); Assertions.assertFalse(routefff.isTunnelled(), "routefff.tunnel"); Assertions.assertFalse(routefff.isLayered(), "routefff.layer"); Assertions.assertFalse(routefft.isSecure(), "routefft.secure"); Assertions.assertFalse(routefft.isTunnelled(), "routefft.tunnel"); Assertions.assertTrue (routefft.isLayered(), "routefft.layer"); Assertions.assertFalse(routeftf.isSecure(), "routeftf.secure"); Assertions.assertTrue (routeftf.isTunnelled(), "routeftf.tunnel"); Assertions.assertFalse(routeftf.isLayered(), "routeftf.layer"); Assertions.assertFalse(routeftt.isSecure(), "routeftt.secure"); Assertions.assertTrue (routeftt.isTunnelled(), "routeftt.tunnel"); Assertions.assertTrue (routeftt.isLayered(), "routeftt.layer"); Assertions.assertTrue (routetff.isSecure(), "routetff.secure"); Assertions.assertFalse(routetff.isTunnelled(), "routetff.tunnel"); Assertions.assertFalse(routetff.isLayered(), "routetff.layer"); Assertions.assertTrue (routetft.isSecure(), "routetft.secure"); Assertions.assertFalse(routetft.isTunnelled(), "routetft.tunnel"); Assertions.assertTrue (routetft.isLayered(), "routetft.layer"); Assertions.assertTrue (routettf.isSecure(), "routettf.secure"); Assertions.assertTrue (routettf.isTunnelled(), "routettf.tunnel"); Assertions.assertFalse(routettf.isLayered(), "routettf.layer"); Assertions.assertTrue (routettt.isSecure(), "routettt.secure"); Assertions.assertTrue (routettt.isTunnelled(), "routettt.tunnel"); Assertions.assertTrue (routettt.isLayered(), "routettt.layer"); } @Test void testInvalidArguments() { final HttpHost[] chain1 = { PROXY1 }; // for reference: this one should succeed final HttpRoute route = new HttpRoute(TARGET1, null, chain1, false, TunnelType.TUNNELLED, LayerType.PLAIN); Assertions.assertNotNull(route); Assertions.assertThrows(NullPointerException.class, () -> new HttpRoute(null, null, chain1, false,TunnelType.TUNNELLED, LayerType.PLAIN)); Assertions.assertThrows(IllegalArgumentException.class, () -> new HttpRoute(TARGET1, null, (HttpHost[]) null, false, TunnelType.TUNNELLED, LayerType.PLAIN)); } @Test void testNullEnums() { // tests the default values for the enum parameters // also covers the accessors for the enum attributes final HttpRoute route = new HttpRoute(TARGET1, null, PROXY1, false, null, null); // here are defaults Assertions.assertFalse(route.isTunnelled(), "default tunnelling"); Assertions.assertEquals(TunnelType.PLAIN, route.getTunnelType(), "untunnelled"); Assertions.assertFalse(route.isLayered(), "default layering"); Assertions.assertEquals(LayerType.PLAIN, route.getLayerType(), "unlayered"); } @Test void testEqualsHashcodeClone() throws CloneNotSupportedException { final HttpHost[] chain0 = { }; final HttpHost[] chain1 = { PROXY1 }; final HttpHost[] chain3 = { PROXY1, PROXY2, PROXY3 }; final HttpHost[] chain4 = { PROXY1, PROXY3, PROXY2 }; // create some identical routes final HttpRoute route1a = new HttpRoute(TARGET1, LOCAL41, chain3, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route1b = new HttpRoute(TARGET1, LOCAL41, chain3, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route1c = (HttpRoute) route1a.clone(); Assertions.assertEquals(route1a, route1a, "1a 1a"); Assertions.assertEquals(route1a, route1b, "1a 1b"); Assertions.assertEquals(route1a, route1c, "1a 1c"); Assertions.assertEquals(route1a.hashCode(), route1a.hashCode(), "hashcode 1a"); Assertions.assertEquals(route1a.hashCode(), route1b.hashCode(), "hashcode 1b"); Assertions.assertEquals(route1a.hashCode(), route1c.hashCode(), "hashcode 1c"); Assertions.assertEquals(route1a.toString(), route1b.toString(), "toString 1b"); Assertions.assertEquals(route1a.toString(), route1a.toString(), "toString 1a"); Assertions.assertEquals(route1a.toString(), route1c.toString(), "toString 1c"); // now create some differing routes final HttpRoute route2a = new HttpRoute(TARGET2, LOCAL41, chain3, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route2b = new HttpRoute(TARGET1, LOCAL42, chain3, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route2c = new HttpRoute(TARGET1, LOCAL61, chain3, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route2d = new HttpRoute(TARGET1, null, chain3, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route2e = new HttpRoute(TARGET1, LOCAL41, (HttpHost[]) null, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route2f = new HttpRoute(TARGET1, LOCAL41, chain0, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route2g = new HttpRoute(TARGET1, LOCAL41, chain1, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route2h = new HttpRoute(TARGET1, LOCAL41, chain4, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route2i = new HttpRoute(TARGET1, LOCAL41, chain3, true, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route2j = new HttpRoute(TARGET1, LOCAL41, chain3, false, TunnelType.TUNNELLED, LayerType.PLAIN); final HttpRoute route2k = new HttpRoute(TARGET1, LOCAL41, chain3, false, TunnelType.PLAIN, LayerType.LAYERED); final HttpRoute route2m = new HttpRoute(TARGET2, new URIAuthority(TARGET2.getHostName(), TARGET2.getPort()), LOCAL41, chain3, false, TunnelType.PLAIN, LayerType.PLAIN); // check a special case first: 2f should be the same as 2e Assertions.assertEquals(route2e, route2f, "2e 2f"); Assertions.assertEquals(route2e.hashCode(), route2f.hashCode(), "hashcode 2e 2f"); Assertions.assertEquals(route2e.toString(), route2f.toString(), "toString 2e 2f"); Assertions.assertNotEquals(route1a, route2a, "1a 2a"); Assertions.assertNotEquals(route1a, route2b, "1a 2b"); Assertions.assertNotEquals(route1a, route2c, "1a 2c"); Assertions.assertNotEquals(route1a, route2d, "1a 2d"); Assertions.assertNotEquals(route1a, route2e, "1a 2e"); Assertions.assertNotEquals(route1a, route2f, "1a 2f"); Assertions.assertNotEquals(route1a, route2g, "1a 2g"); Assertions.assertNotEquals(route1a, route2h, "1a 2h"); Assertions.assertNotEquals(route1a, route2i, "1a 2i"); Assertions.assertNotEquals(route1a, route2j, "1a 2j"); Assertions.assertNotEquals(route1a, route2k, "1a 2k"); Assertions.assertNotEquals(route1a, route2m, "1a 2k"); // repeat the checks in the other direction // there could be problems with detecting null attributes Assertions.assertNotEquals(route2b, route1a, "2b 1a"); Assertions.assertNotEquals(route2c, route1a, "2c 1a"); Assertions.assertNotEquals(route2d, route1a, "2d 1a"); Assertions.assertNotEquals(route2e, route1a, "2e 1a"); Assertions.assertNotEquals(route2a, route1a, "2a 1a"); Assertions.assertNotEquals(route2f, route1a, "2f 1a"); Assertions.assertNotEquals(route2g, route1a, "2g 1a"); Assertions.assertNotEquals(route2h, route1a, "2h 1a"); Assertions.assertNotEquals(route2i, route1a, "2i 1a"); Assertions.assertNotEquals(route2j, route1a, "2j 1a"); Assertions.assertNotEquals(route2k, route1a, "2k 1a"); Assertions.assertNotEquals(route2m, route1a, "2k 1a"); // don't check hashCode, it's not guaranteed to be different Assertions.assertNotEquals(route1a.toString(), route2a.toString(), "toString 1a 2a"); Assertions.assertNotEquals(route1a.toString(), route2b.toString(), "toString 1a 2b"); Assertions.assertNotEquals(route1a.toString(), route2c.toString(), "toString 1a 2c"); Assertions.assertNotEquals(route1a.toString(), route2d.toString(), "toString 1a 2d"); Assertions.assertNotEquals(route1a.toString(), route2e.toString(), "toString 1a 2e"); Assertions.assertNotEquals(route1a.toString(), route2f.toString(), "toString 1a 2f"); Assertions.assertNotEquals(route1a.toString(), route2g.toString(), "toString 1a 2g"); Assertions.assertNotEquals(route1a.toString(), route2h.toString(), "toString 1a 2h"); Assertions.assertNotEquals(route1a.toString(), route2i.toString(), "toString 1a 2i"); Assertions.assertNotEquals(route1a.toString(), route2j.toString(), "toString 1a 2j"); Assertions.assertNotEquals(route1a.toString(), route2k.toString(), "toString 1a 2k"); Assertions.assertNotEquals(route1a.toString(), route2m.toString(), "toString 1a 2k"); // now check that all of the routes are different from eachother // except for those that aren't :-) final Set routes = new HashSet<>(); routes.add(route1a); routes.add(route2a); routes.add(route2b); routes.add(route2c); routes.add(route2d); routes.add(route2e); //routes.add(route2f); // 2f is the same as 2e routes.add(route2g); routes.add(route2h); routes.add(route2i); routes.add(route2j); routes.add(route2k); routes.add(route2m); // and a run of cloning over the set for (final HttpRoute origin : routes) { final HttpRoute cloned = (HttpRoute) origin.clone(); Assertions.assertEquals(origin, cloned, "clone of " + origin); Assertions.assertTrue(routes.contains(cloned), "clone of " + origin); } // finally, compare with nonsense Assertions.assertNotEquals(null, route1a, "route equals null"); Assertions.assertNotEquals("route1a", route1a, "route equals string"); } @Test void testHopping() { // test getHopCount() and getHopTarget() with different proxy chains final HttpHost[] proxies = null; final HttpRoute route = new HttpRoute(TARGET1, null, proxies, true, TunnelType.PLAIN, LayerType.PLAIN); Assertions.assertEquals(1, route.getHopCount(), "A: hop count"); Assertions.assertEquals(TARGET1, route.getHopTarget(0), "A: hop 0"); Assertions.assertThrows(IllegalArgumentException.class, () -> route.getHopTarget(1)); Assertions.assertThrows(IllegalArgumentException.class, () -> route.getHopTarget(-1)); final HttpHost[] proxies2 = new HttpHost[]{PROXY3}; final HttpRoute route2 = new HttpRoute(TARGET1, LOCAL62, proxies2, false, TunnelType.TUNNELLED, LayerType.PLAIN); Assertions.assertEquals(2, route2.getHopCount(), "B: hop count"); Assertions.assertEquals(PROXY3, route2.getHopTarget(0), "B: hop 0"); Assertions.assertEquals(TARGET1, route2.getHopTarget(1), "B: hop 1"); Assertions.assertThrows(IllegalArgumentException.class, () -> route2.getHopTarget(2)); Assertions.assertThrows(IllegalArgumentException.class, () -> route2.getHopTarget(-2)); final HttpHost[] proxies3 = new HttpHost[]{PROXY3, PROXY1, PROXY2}; final HttpRoute route3 = new HttpRoute(TARGET1, LOCAL42, proxies3, false, TunnelType.PLAIN, LayerType.LAYERED); Assertions.assertEquals(4, route3.getHopCount(), "C: hop count"); Assertions.assertEquals(PROXY3, route3.getHopTarget(0), "C: hop 0"); Assertions.assertEquals(PROXY1, route3.getHopTarget(1), "C: hop 1"); Assertions.assertEquals(PROXY2, route3.getHopTarget(2), "C: hop 2"); Assertions.assertEquals(TARGET1, route3.getHopTarget(3), "C: hop 3"); Assertions.assertThrows(IllegalArgumentException.class, () -> route3.getHopTarget(4)); Assertions.assertThrows(IllegalArgumentException.class, () -> route3.getHopTarget(Integer.MIN_VALUE)); } @Test void testCstr1() { final HttpRoute route = new HttpRoute(TARGET2); final HttpRoute should = new HttpRoute (TARGET2, null, (HttpHost[]) null, false, TunnelType.PLAIN, LayerType.PLAIN); Assertions.assertEquals(route, should, "bad convenience route"); } @Test void testCstr3() { // test convenience constructor with 3 arguments HttpRoute route = new HttpRoute(TARGET2, LOCAL61, false); HttpRoute should = new HttpRoute (TARGET2, LOCAL61, (HttpHost[]) null, false, TunnelType.PLAIN, LayerType.PLAIN); Assertions.assertEquals(route, should, "bad convenience route 3/insecure"); route = new HttpRoute(TARGET2, null, true); should = new HttpRoute(TARGET2, null, (HttpHost[]) null, true, TunnelType.PLAIN, LayerType.PLAIN); Assertions.assertEquals(route, should, "bad convenience route 3/secure"); } @SuppressWarnings("unused") @Test void testCstr4() { // test convenience constructor with 4 arguments HttpRoute route = new HttpRoute(TARGET2, null, PROXY2, false); HttpRoute should = new HttpRoute (TARGET2, null, new HttpHost[]{ PROXY2 }, false, TunnelType.PLAIN, LayerType.PLAIN); Assertions.assertEquals(route, should, "bad convenience route 4/insecure"); route = new HttpRoute(TARGET2, LOCAL42, PROXY1, true); should = new HttpRoute (TARGET2, LOCAL42, new HttpHost[]{ PROXY1 }, true, TunnelType.TUNNELLED, LayerType.LAYERED); Assertions.assertEquals(route, should, "bad convenience route 4/secure"); // this constructor REQUIRES a proxy to be specified Assertions.assertThrows(NullPointerException.class, () -> new HttpRoute(TARGET1, LOCAL61, null, false)); } @Test void testCstr6() { // test convenience constructor with 6 arguments HttpRoute route = new HttpRoute (TARGET2, null, PROXY2, true, TunnelType.TUNNELLED, LayerType.PLAIN); HttpRoute should = new HttpRoute (TARGET2, null, new HttpHost[]{ PROXY2 }, true, TunnelType.TUNNELLED, LayerType.PLAIN); Assertions.assertEquals(route, should, "bad convenience route 6/proxied"); route = new HttpRoute (TARGET2, null, (HttpHost) null, true, TunnelType.PLAIN, LayerType.LAYERED); should = new HttpRoute (TARGET2, null, (HttpHost[]) null, true, TunnelType.PLAIN, LayerType.LAYERED); Assertions.assertEquals(route, should, "bad convenience route 6/direct"); // handling of null vs. empty chain is checked in the equals tests } @Test void testImmutable() throws CloneNotSupportedException { final HttpHost[] proxies = new HttpHost[]{ PROXY1, PROXY2, PROXY3 }; final HttpRoute route1 = new HttpRoute(TARGET1, null, proxies, false, TunnelType.PLAIN, LayerType.PLAIN); final HttpRoute route2 = (HttpRoute) route1.clone(); final HttpRoute route3 = new HttpRoute(TARGET1, null, proxies.clone(), false, TunnelType.PLAIN, LayerType.PLAIN); // modify the array that was passed to the constructor of route1 proxies[1] = PROXY3; proxies[2] = PROXY2; Assertions.assertEquals(route2, route1, "route differs from clone"); Assertions.assertEquals(route3, route1, "route was modified"); } } httpclient5/pom.xml0100664 0000000 0000000 00000013674 15064565770 013421 0ustar000000000 0000000 4.0.0 org.apache.httpcomponents.client5 httpclient5-parent 5.5.1 httpclient5 Apache HttpClient Apache HttpComponents Client jar org.apache.httpcomponents.client5.httpclient5 org.apache.httpcomponents.core5 httpcore5 org.apache.httpcomponents.core5 httpcore5-h2 org.slf4j slf4j-api org.conscrypt conscrypt-openjdk-uber true org.apache.httpcomponents.core5 httpcore5-reactive test io.reactivex.rxjava2 rxjava test org.apache.logging.log4j log4j-slf4j-impl test org.apache.logging.log4j log4j-core test org.brotli dec true org.junit.jupiter junit-jupiter test org.hamcrest hamcrest test org.mockito mockito-core test src/main/resources true **/*.properties src/main/resources **/*.dat com.googlecode.maven-download-plugin download-maven-plugin 1.13.0 download-public-suffix-list generate-resources wget https://publicsuffix.org/list/effective_tld_names.dat ${project.basedir}/src/main/resources/org/publicsuffix/list org.apache.maven.plugins maven-jar-plugin test-jar maven-project-info-reports-plugin false index dependencies dependency-info summary apache-release com.googlecode.maven-download-plugin download-maven-plugin true true SECURITY.md0100664 0000000 0000000 00000002126 15012321476 011402 0ustar000000000 0000000 # HttpComponents Security The HttpComponents Security process and model are on our website's [Security](https://hc.apache.org/security.html) page. If you believe you found a vulnerability in Apache HttpClient, please contact the [Apache Security Team](https://www.apache.org/security/). README.md0100664 0000000 0000000 00000012560 15021303406 011064 0ustar000000000 0000000 Apache HttpComponents Client ============================ Welcome to the HttpClient component of the Apache HttpComponents project. [![GitHub Actions Status](https://github.com/apache/httpcomponents-client/workflows/Java%20CI/badge.svg)](https://github.com/apache/httpcomponents-client/actions) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.httpcomponents.client5/httpclient5/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.httpcomponents.client5/httpclient5) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) Building Instructions --------------------- For building from source instructions please refer to [BUILDING.txt](./BUILDING.txt). Dependencies ------------ HttpClient main module requires Java 8 compatible runtime and depends on the following external libraries: * [Apache HttpComponents HttpCore](https://github.com/apache/httpcomponents-core) * [SLF4J API](http://www.slf4j.org/) Other dependencies are optional. (for detailed information on external dependencies please see [pom.xml](./pom.xml)) Protocol conformance -------------------- - [RFC 9110](https://datatracker.ietf.org/doc/html/rfc9110) - HTTP Semantics - [RFC 9111](https://datatracker.ietf.org/doc/html/rfc9111) - HTTP Caching - [RFC 9112](https://datatracker.ietf.org/doc/html/rfc9112) - Hypertext Transfer Protocol Version 1.1 (HTTP/1.1) - [RFC 7540](https://datatracker.ietf.org/doc/html/rfc7540) - Hypertext Transfer Protocol Version 2 (HTTP/2) - [RFC 7541](https://datatracker.ietf.org/doc/html/rfc7541) - HPACK: Header Compression for HTTP/2 - [RFC 1945](https://datatracker.ietf.org/doc/html/rfc1945) - Hypertext Transfer Protocol -- HTTP/1.0 - [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) - Uniform Resource Identifier (URI): Generic Syntax - [RFC 6265](https://datatracker.ietf.org/doc/html/rfc6265) - HTTP State Management Mechanism (Cookies) - [RFC 7616](https://datatracker.ietf.org/doc/html/rfc7616) - HTTP Digest Access Authentication - [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617) - HTTP 'Basic' Authentication Scheme - [RFC 5861](https://datatracker.ietf.org/doc/html/rfc5861) - HTTP Cache-Control Extensions for Stale Content - [RFC 2817](https://datatracker.ietf.org/doc/html/rfc2817) - Upgrading to TLS Within HTTP/1.1 Licensing --------- Apache HttpComponents Client is licensed under the Apache License 2.0. See the files [LICENSE.txt](./LICENSE.txt) and [NOTICE.txt](./NOTICE.txt) for more information. Contact ------- - For general information visit the main project site at https://hc.apache.org/ - For current status information visit the status page at https://hc.apache.org/status.html - If you want to contribute visit https://hc.apache.org/get-involved.html Cryptographic Software Notice ----------------------------- This distribution may include software that has been designed for use with cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See https://www.wassenaar.org/ for more information. The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code. The following provides more details on the included software that may be subject to export controls on cryptographic software: > Apache HttpComponents Client interfaces with the > Java Secure Socket Extension (JSSE) API to provide > - HTTPS support > > Apache HttpComponents Client does not include any > implementation of JSSE. pom.xml0100664 0000000 0000000 00000040446 15064565770 011153 0ustar000000000 0000000 org.apache.httpcomponents httpcomponents-parent 14 4.0.0 org.apache.httpcomponents.client5 httpclient5-parent Apache HttpComponents Client Parent 5.5.1 Apache HttpComponents Client is a library of components for building client side HTTP services https://hc.apache.org/httpcomponents-client-5.5.x/${project.version}/ 1999 pom Jira https://issues.apache.org/jira/browse/HTTPCLIENT scm:git:https://gitbox.apache.org/repos/asf/httpcomponents-client.git scm:git:https://gitbox.apache.org/repos/asf/httpcomponents-client.git https://github.com/apache/httpcomponents-client/tree/${project.scm.tag} 5.5.1 apache.website Apache HttpComponents Website scm:svn:https://svn.apache.org/repos/asf/httpcomponents/site/components/httpcomponents-client-5.5.x/LATEST/ 1.8 1.8 5.3.6 2.24.3 0.1.2 2.5.2 3.10.8 2.12.3 1.7.36 5.13.0 3.0 4.11.0 1 2.2.21 1.21.1 5.3 javax.net.ssl.SSLEngine,javax.net.ssl.SSLParameters,java.nio.ByteBuffer,java.nio.CharBuffer org.apache.httpcomponents.core5 httpcore5 ${httpcore.version} org.apache.httpcomponents.core5 httpcore5-h2 ${httpcore.version} org.apache.httpcomponents.core5 httpcore5-testing ${httpcore.version} org.apache.httpcomponents.core5 httpcore5-reactive ${httpcore.version} org.apache.httpcomponents.client5 httpclient5 ${project.version} org.apache.httpcomponents.client5 httpclient5 ${project.version} tests org.apache.httpcomponents.client5 httpclient5-cache ${project.version} org.apache.httpcomponents.client5 httpclient5-fluent ${project.version} org.slf4j slf4j-api ${slf4j.version} org.apache.logging.log4j log4j-slf4j-impl ${log4j.version} org.apache.logging.log4j log4j-core ${log4j.version} org.brotli dec ${brotli.version} org.conscrypt conscrypt-openjdk-uber ${conscrypt.version} org.ehcache.modules ehcache-api ${ehcache.version} net.spy spymemcached ${memcached.version} io.reactivex.rxjava2 rxjava ${rxjava.version} test org.junit junit-bom ${junit.version} pom import org.mockito mockito-core ${mockito.version} test org.hamcrest hamcrest ${hamcrest.version} test org.testcontainers testcontainers ${testcontainers.version} org.testcontainers junit-jupiter ${testcontainers.version} httpclient5 httpclient5-fluent httpclient5-cache httpclient5-testing clean verify maven-jar-plugin ${Automatic-Module-Name} ${project.url} maven-javadoc-plugin https://hc.apache.org/httpcomponents-core-5.0.x/httpcore5/apidocs/ https://hc.apache.org/httpcomponents-core-5.0.x/httpcore5-h2/apidocs/ ${project.url}/httpclient5/apidocs/ org.apache.maven.plugins maven-checkstyle-plugin validate-main validate hc-stylecheck/default.xml hc-stylecheck/asl2.header true true false ${basedir}/src/main checkstyle validate-test validate hc-stylecheck/default.xml hc-stylecheck/asl2.header true true false ${basedir}/src/test checkstyle com.github.siom79.japicmp japicmp-maven-plugin ${project.groupId} ${project.artifactId} ${api.comparison.version} jar ${project.build.directory}/${project.artifactId}-${project.version}.${project.packaging} true true METHOD_NEW_DEFAULT true true @org.apache.hc.core5.annotation.Internal true verify cmp org.apache.rat apache-rat-plugin verify check src/docbkx/resources/** src/test/resources/*.truststore src/test/resources/*.serialized .checkstyle .externalToolBuilders/** maven-eclipse.xml **/serial **/index.txt maven-project-info-reports-plugin false index dependency-info dependency-management issue-management licenses mailing-lists scm summary maven-javadoc-plugin true true https://hc.apache.org/httpcomponents-core-5.0.x/httpcore5/apidocs/ https://hc.apache.org/httpcomponents-core-5.0.x/httpcore5-h2/apidocs/ ${project.url}/httpclient5/apidocs/ Apache HttpClient org.apache.hc.client5.http* Apache HttpClient Cache org.apache.hc.client5.http.cache*:org.apache.hc.client5.http.impl.cache*:org.apache.hc.client5.http.schedule:org.apache.hc.client5.http.impl.schedule* Apache HttpClient Fluent org.apache.hc.client5.http.fluent* Apache HttpClient Testing org.apache.hc.client5.testing* Apache HttpClient Windows features org.apache.hc.client5.http.impl.win* javadoc aggregate com.github.siom79.japicmp japicmp-maven-plugin cmp-report ${project.groupId} ${project.artifactId} ${api.comparison.version} jar ${project.build.directory}/${project.artifactId}-${project.version}.${project.packaging} @org.apache.hc.core5.annotation.Internal true maven-jxr-plugin maven-surefire-report-plugin doap_HttpComponents_Client.rdf0100664 0000000 0000000 00000013264 14666635064 015620 0ustar000000000 0000000 2007-11-15 Apache HttpComponents Client Java library implementing an HTTP client based on HttpCore components. HttpClient is a library for client-side HTTP communication built on HttpCore. It provides connection management, cookie management, and authentication. This is the successor to the widely used Jakarta Commons HttpClient 3.1. Java Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing IETF RFC 7230 Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content IETF RFC 7231 Hypertext Transfer Protocol (HTTP/1.1): Authentication IETF RFC 7235 Hypertext Transfer Protocol Version 2 (HTTP/2) IETF RFC 7540 HPACK: Header Compression for HTTP/2 IETF RFC 7541 Hypertext Transfer Protocol -- HTTP/1.0 IETF RFC 1945 Upgrading to TLS Within HTTP/1.1 IETF RFC 2817 HTTP Over TLS IETF RFC 2818 HTTP State Management Mechanism IETF RFC 6265 mvnw0100775 0000000 0000000 00000024653 15016633414 010541 0ustar000000000 0000000 #!/bin/sh # ---------------------------------------------------------------------------- # Licensed to the Apache Software Foundation (ASF) under one # or more contributor license agreements. See the NOTICE file # distributed with this work for additional information # regarding copyright ownership. The ASF licenses this file # to you under the Apache License, Version 2.0 (the # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. # ---------------------------------------------------------------------------- # ---------------------------------------------------------------------------- # Apache Maven Wrapper startup batch script, version 3.3.2 # # Optional ENV vars # ----------------- # JAVA_HOME - location of a JDK home dir, required when download maven via java source # MVNW_REPOURL - repo url base for downloading maven distribution # MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven # MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output # ---------------------------------------------------------------------------- set -euf [ "${MVNW_VERBOSE-}" != debug ] || set -x # OS specific support. native_path() { printf %s\\n "$1"; } case "$(uname)" in CYGWIN* | MINGW*) [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" native_path() { cygpath --path --windows "$1"; } ;; esac # set JAVACMD and JAVACCMD set_java_home() { # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched if [ -n "${JAVA_HOME-}" ]; then if [ -x "$JAVA_HOME/jre/sh/java" ]; then # IBM's JDK on AIX uses strange locations for the executables JAVACMD="$JAVA_HOME/jre/sh/java" JAVACCMD="$JAVA_HOME/jre/sh/javac" else JAVACMD="$JAVA_HOME/bin/java" JAVACCMD="$JAVA_HOME/bin/javac" if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 return 1 fi fi else JAVACMD="$( 'set' +e 'unset' -f command 2>/dev/null 'command' -v java )" || : JAVACCMD="$( 'set' +e 'unset' -f command 2>/dev/null 'command' -v javac )" || : if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 return 1 fi fi } # hash string like Java String::hashCode hash_string() { str="${1:-}" h=0 while [ -n "$str" ]; do char="${str%"${str#?}"}" h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) str="${str#?}" done printf %x\\n $h } verbose() { :; } [ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } die() { printf %s\\n "$1" >&2 exit 1 } trim() { # MWRAPPER-139: # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. # Needed for removing poorly interpreted newline sequences when running in more # exotic environments such as mingw bash on Windows. printf "%s" "${1}" | tr -d '[:space:]' } # parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties while IFS="=" read -r key value; do case "${key-}" in distributionUrl) distributionUrl=$(trim "${value-}") ;; distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; esac done <"${0%/*}/.mvn/wrapper/maven-wrapper.properties" [ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in ${0%/*}/.mvn/wrapper/maven-wrapper.properties" case "${distributionUrl##*/}" in maven-mvnd-*bin.*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; :Linux*x86_64*) distributionPlatform=linux-amd64 ;; *) echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 distributionPlatform=linux-amd64 ;; esac distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" ;; maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; *) MVN_CMD="mvn${0##*/mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; esac # apply MVNW_REPOURL and calculate MAVEN_HOME # maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ [ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" distributionUrlName="${distributionUrl##*/}" distributionUrlNameMain="${distributionUrlName%.*}" distributionUrlNameMain="${distributionUrlNameMain%-bin}" MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" exec_maven() { unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" } if [ -d "$MAVEN_HOME" ]; then verbose "found existing MAVEN_HOME at $MAVEN_HOME" exec_maven "$@" fi case "${distributionUrl-}" in *?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; *) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; esac # prepare tmp dir if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } trap clean HUP INT TERM EXIT else die "cannot create temp dir" fi mkdir -p -- "${MAVEN_HOME%/*}" # Download and Install Apache Maven verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." verbose "Downloading from: $distributionUrl" verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" # select .zip or .tar.gz if ! command -v unzip >/dev/null; then distributionUrl="${distributionUrl%.zip}.tar.gz" distributionUrlName="${distributionUrl##*/}" fi # verbose opt __MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' [ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v # normalize http auth case "${MVNW_PASSWORD:+has-password}" in '') MVNW_USERNAME='' MVNW_PASSWORD='' ;; has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; esac if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then verbose "Found wget ... using wget" wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then verbose "Found curl ... using curl" curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" elif set_java_home; then verbose "Falling back to use Java to download" javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" cat >"$javaSource" <<-END public class Downloader extends java.net.Authenticator { protected java.net.PasswordAuthentication getPasswordAuthentication() { return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); } public static void main( String[] args ) throws Exception { setDefault( new Downloader() ); java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); } } END # For Cygwin/MinGW, switch paths to Windows format before running javac and java verbose " - Compiling Downloader.java ..." "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" verbose " - Running Downloader.java ..." "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" fi # If specified, validate the SHA-256 sum of the Maven distribution zip file if [ -n "${distributionSha256Sum-}" ]; then distributionSha256Result=false if [ "$MVN_CMD" = mvnd.sh ]; then echo "Checksum validation is not supported for maven-mvnd." >&2 echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 exit 1 elif command -v sha256sum >/dev/null; then if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then distributionSha256Result=true fi elif command -v shasum >/dev/null; then if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then distributionSha256Result=true fi else echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 exit 1 fi if [ $distributionSha256Result = false ]; then echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 exit 1 fi fi # unzip and move if command -v unzip >/dev/null; then unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" else tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" fi printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/mvnw.url" mv -- "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" clean || : exec_maven "$@" test-CA/newcerts/0040775 0000000 0000000 00000000000 14705726657 012727 5ustar000000000 0000000