ph-web

Java library with common web stuff. It contains the following sub-projects:

• ph-dns (since v9.2.1)
  • DNS client side helper methods based on dnsjava
• ph-network
  • Contains general network related stuff like Authenticators, DNS helpers, port and proxy classes
• ph-http
  • Contains special HTTP related helpers
• ph-useragent
  • Contains User-Agent/Browser related helpers
• ph-servlet
  • Contains special javax.servlet related helpers
• ph-mail
  • Contains javax.mail related helpers
• ph-smtp
  • Contains helper classes for asynchronous mail (re-)sending
• ph-httpclient
  • Contains Apache HTTP client related helpers
• ph-web
  • Other high-level abstraction for servlets, file-upload and web scopes
• ph-sitemap (since v9.0.0)
  • Containing Sitemap generation helper
• ph-xservlet (since v9.0.0)
  • Contains an extended Servlet framework (XServlet is just a name I gave it internally and not an official name)
• ph-jsch (since v9.2.0)
  • Helper around JSch - for SSH, SCP and SFTP connections

Maven usage

Add the following to your pom.xml to use this artifact, replacing x.y.z with the effective version number:

<dependency>
  <groupId>com.helger.web</groupId>
  <artifactId>ph-web</artifactId>
  <version>x.y.z</version>
</dependency>

or to use it as a BOM put that in your <dependencyManagement> section:

<dependency>
  <groupId>com.helger.web</groupId>
  <artifactId>ph-web-parent-pom</artifactId>
  <version>x.y.z</version>
  <type>pom</type>
  <scope>import</scope>
</dependency>

Note: prior to v9.3.0 the Maven groupId was com.helger.

News and noteworthy

• v10.3.1 - work in progress
  • Added new classes ResponseHandlerJsonObject and ResponseHandlerJsonArray
• v10.3.0 - 2025-02-03
  • Updated to dnsjava 3.6.3
  • Reversed the dependency between ph-servlet and ph-useragent (incompatible change)
  • Removed the deprecated methods in RequestHelper and IRequestWebScopeWithoutResponse and UnifiedResponse related to the user agent
  • Created new classes UAProfileHeaderProviderHttpServletRequest and UAServletHelper
• v10.2.0 - 2025-01-21
  • Updated to Apache HttpClient v5.4.x
  • Replaced HttpClient ConnectionSocketFactory with TlsSocketStrategy
  • Modified API of HttpclientFactory to use TlsSocketStrategy
• v10.1.9 - 2024-07-29
  • Updated to dnsjava 3.6.0 fixing CVE-2024-25638
• v10.1.8 - 2024-03-27
  • Updated to ph-commons 11.1.5
  • Created Java 21 compatibility
• v10.1.7 - 2024-01-07
  • Fixed the DNS query type in NonCachingDnsResolver.createDefaultLookup() to not use ANY
• v10.1.6 - 2024-01-05
  • Updated to Apache HttpClient v5.3
  • HttpClientFactory.createConnectionManager now returns a logging version if HttpDebugger.isEnabled ()
  • Deprecated all methods regarding IUserAgent and BrowserInfo in the request and response helpers - they are out of date and the inclusion in the base API will be removed
• v10.1.5 - 2023-08-06
  • Wrapped additional HttpServletRequest methods in ServletHelper
• v10.1.4 - 2023-07-31
  • Updated to ph-commons 11.1
• v10.1.3 - 2023-07-26
  • Introduced ServletHelper.getHeader to work around a Tomcat error
• v10.1.2 - 2023-07-24
  • Updated to ph-commons 11.0.5
  • Introduced ServletHelper.getAttribute to work around a Tomcat error
• v10.1.1 - 2023-04-29
  • Updated to ph-commons 11.0.4
  • Improved handling of Surrogate characters in request parameters
• v10.1.0 - 2023-02-24
  • Using Servlet API 5.0.0 as the baseline: JakartaEE 9, Java 11+, Apache Tomcat v10.0.x, Jetty 11.x
  • Using Eclipse Angus 2.0.1 for mailing
  • Switched all namespaces from javax.servlet to jakarta.servlet
• v10.0.1 - 2023-02-05
  • Using Servlet API 4.0.1 as the baseline: JakartaEE 8, Java 11+, Apache Tomcat v9.x, Jetty 10.x
  • Using Jakarta Mail 2.0.1 (because Bouncycastle is not yet available for Eclipse Angus)
• v10.0.0 - 2023-02-01
  • Using Java 11 as the baseline
  • Updated to ph-commons 11
  • Updated to Jakarta Mail 2.0.1
  • Updated to Apache HttpClient v5.2.x
  • Updated to dnsjava 3.5.2
  • Deprecated IHttpClientSettings.isUseSystemProperties
  • Removed all deprecated methods
  • Added TLS 1.3 as the preferred TLS method
  • Added new class HttpClientSettingsConfig to consistently configure HttpClientSettings via IConfig
• v9.7.2 - 2022-10-18
  • The class ResponseHandlerXml no longer uses ISO-8859-1 as the default charset if none was specified
  • The class ResponseHandlerMicroDom no longer uses ISO-8859-1 as the default charset if none was specified
  • The class ResponseHandlerString no has the possibility for a fallback charset
  • Improved the JSCH session handling code
• v9.7.1 - 2022-08-17
  • Changed in HttpClientSettings from *ConnectionTimout to *ConnectTimeout to be consistent
  • Added (set|is)RetryAlways in HttpClientSettings to allow to retry idempotent requests as well
• v9.7.0 - 2022-08-17
  • Updated to dnsjava 3.5.1
  • Updated to Apache HttpClient v5 - backwards incompatible change
  • Made MockServletContext and MockServletPool thread-safe. See phax/phase4#92
• v9.6.4 - 2022-05-09
  • Updated to dnsjava 3.5.0
  • The default value of UnifiedResponse.allowContentOnStatusCode is now true
  • Added the method AcceptMimeTypeList.getPreferredMimeType
  • Added the method HttpClientFactory.httpClientSettings
  • Extended the ExtendedHttpResponseException API
  • Fixed potential NPE in RequestHelper.getRequestURIEncoded
• v9.6.3 - 2022-01-04
  • Updated to Apache httpcore 4.4.15
  • Updated to dnsjava 3.4.3
  • Class ResponseHandlerJson now has a configurable fallback charset
  • Class UnifiedResponse now supports silent mode
• v9.6.2 - 2021-11-24
  • Updated to dnsjava 3.4.2
• v9.6.1 - 2021-05-31
  • Updated to ph-commons 10.1
  • Updated to Jakarta Mail 1.6.7
  • Usage of HTTP "keep-alive" can now be configured via the IHttpClientSettings
  • Created class RequestTrackerSettings to improve request tracking configuration
• v9.6.0 - 2021-03-22
  • Updated to ph-commons 10
• v9.5.3 - 2021-03-03
  • Extended MailTransport with default properties (e.g. for using other transport implementations)
• v9.5.2 - 2021-01-11
  • Updated to Apache httpcore 4.4.14
  • Fixed the NAPTR resolution to be compatible with https://issues.oasis-open.org/browse/BDXR-29
  • Made the ConnectionReuseStrategy customizable in HttpClientFactory
• v9.5.1 - 2020-11-25
  • Fixed an endless recursion in NonCachingDnsResolver
• v9.5.0 - 2020-11-18
  • Reverted back to Jakarta Mail 1.6.5 (because BouncyCastle is still on the old version)
  • Reverted back to Jakarta Activation 1.2.2 (because BouncyCastle is still on the old version)
  • Removed the default DNS servers for usage with the NAPTR record resolution
  • Added a new class NaptrLookup to provide a more flexible NAPTR resolution logic
  • The class NaptrResolver was changed to also use the builder pattern
• v9.4.0 - 2020-11-13 (don't use)
  • Updated to Apache httpclient 4.5.13
  • Updated to dnsjava 3.3.1
  • Updated to Jakarta Mail 2.0.0 (requiring Jakarta Activation as well)
  • Extended CSP directives to also support manifest-src, prefetch-src, worker-src and base-uri
  • Extended HttpBasicAuth API with a static method to create the header value
  • Extended the Accept*HeaderList classes to also provide the String representation via getAsHttpHeaderValue
• v9.3.4 - 2020-09-17
  • NaptrResolver received a more flexible service name resolution
  • Updated to Jakarta JAXB 2.3.3
• v9.3.3 - 2020-08-30
  • Updated to ph-commons 9.4.7
• v9.3.2 - 2020-08-18
  • Updated API in ph-xservlet
• v9.3.1 - 2020-07-15
  • Updated to ph-commons 9.4.6
  • Deprecated AcceptMimeTypeHandler.safeParseMimeType
  • Updated predefine MIME types list
  • Updated to dnsjava 3.2.2
• v9.3.0 - 2020-05-26
  • Extracted ph-dns as a separate subproject
  • Changed Maven groupId to com.helger.web
  • Removed deprecated methods from previous versions
• v9.2.0 - 2020-05-25
  • Updated to dnsjava 3.1.0
  • Updated to ph-commons 9.4.4
  • Extracted ph-jsch as a separate subproject
• v9.1.12 - 2020-03-30
  • Fixed a potential dead lock when shutting down RequestTracker
• v9.1.11 - 2020-03-29
  • Updated to Apache httpclient 4.5.12
  • Updated to Jakarta Mail 1.6.5
  • Updated the default TLS configuration modes to reflect the current situation
  • Changed ETLSConfigurationMode to ETLSConfigurationMode_2020_02 to indicate the date of effectiveness
  • LoggingLongRunningRequestCallback now logs the remote address of the request by default
  • Updated to ph-commons 9.4.0
• v9.1.10 - 2020-02-18
  • Updated to dnsjava 3.0.0
  • All getRequestURI and getRequestURL methods were split in ...Encoded and ...Decoded methods for improved handling of URL encoding
• v9.1.9 - 2020-02-16
  • Extended HttpClientSettings with a customizable user agent string
  • Added Apache HttpClient PrivateKeyStrategy and TrustStrategy implementations
  • Extended HttpClientSettings with "follow redirect" setting
  • Made HttpClientSettings clonable
  • Simplified public IEmailData API for the receivers to use mutable lists
  • XServlet filter and handler are no longer Serializable
• v9.1.8 - 2020-02-14
  • Extracted HttpClientSettings from HttpClientFactory
  • Extended customization options of HttpClientSettings
  • Improved error resilience
• v9.1.7 - 2020-02-13
  • Added explicit HttpClientFactory.setProxyCredentials method
  • HttpClientHelper.createRequest now also supports PATCH
  • XServletFilterConsistency has now a silent mode
  • Disabled the default debug logging in the HTTP ResponseHandler
• v9.1.6 - 2020-02-07
  • Updated to Apache httpcore 4.4.13
  • Updated to Apache httpclient 4.5.11
  • Enforcing commons-codec 1.14
  • Changed HttpClient to not use commons-codec but SLF4J instead
  • Improved error resilience
• v9.1.5 - 2019-12-11
  • Optimized logging
  • Updated the META-INF/mime.types file with the latest MIME types
  • ServletContextPathHolder uses the silent mode by default
  • Added new class PhMimetypesFileTypeMap to enforce the loading of "META-INF/mime.types" from this project
  • Removed "META-INF/mime.types" from "ph-smtp" and "ph-httpclient" projects
  • Fixed NPE in ProxySettingsManager
• v9.1.4 - 2019-10-08
  • Updated to Apache httpcore 4.4.12
  • Updated to Apache httpclient 4.5.10
  • Extended UnifiedRepsonse and UnifiedResponseDefaultSettings API to make HTTP header value unification and quoting customizable.
  • Updated to Jakarta dependencies
  • AbstractXServlet.destroy is no longer final
• v9.1.3 - 2019-08-28
  • Updated to Apache httpclient 4.5.9
  • Updated to ph-commons 9.3.6
  • Added new method IRequestWebScopeWithoutResponse.getURI()
  • HttpDebugger is disabled by default
  • AcceptMimeTypeHandler.safeParseMimeType now automatically tries to decode RFC 2616 encoded values
• v9.1.2 - 2019-06-05
  • Updated to Apache httpclient 4.5.8
  • Updated to ph-commons 9.3.3
  • Added new method LocalDateTime IWebScope.getScopeCreationDateTime ()
  • Added new class NetworkOnlineStatusDeterminator in ph-network
• v9.1.1 - 2019-02-17
  • Updated to JSch 0.1.55
  • Updated to Apache httpcore 4.4.11
  • Updated to Apache httpclient 4.5.7
  • XServletSettings got a setting to set the X-Frame-Options HTTP header with a default value of SAMEORIGIN
  • XServletFilterSecurityHttpReferrerPolicy adds the header before the request instead of afterwards
  • Removed deprecated methods in classes RequestField and SessionBackedRequestField
  • HttpClientFactory can now handle "non proxy hosts" as well
• v9.1.0 - 2018-11-22
  • Fixed potential NPE in EmailAttachmentMicroTypeConverter if the attachment cannot be read
  • By default all request param values are now also Unicode normalized
  • Added possibility to specify a custom "param value cleanser" using RequestWebScope.setParamValueCleanser
  • Requires ph-commons 9.2.0
• v9.0.5 - 2018-10-11
  • Changed IContentTransferEncoding to deliver a full codec and not just a decoder
  • Extended NetworkPortHelper with a remote port status checker
  • Added new package com.helger.http.tls with TLS version and configuration enums
• v9.0.4 - 2018-09-17
  • Added forbidden character check in request parameter value handling
• v9.0.3 - 2018-09-14
  • Added new class AbstractXFilterUnifiedResponse
  • IRequestParamMap was extended to easily retrieve trimmed values as well
  • Updated to javax.mail 1.6.2
  • Extended CSP2SourceList to support kyword 'none'
  • Extended CSP2Policy with new default directives
  • Fixed potential stack overflow in RequestParamMap
• v9.0.2 - 2018-07-24
  • Fixed OSGI ServiceProvider configuration
  • Requires ph-commons 9.1.3
  • Fixed XServlet status reset in case Servlet init failed
  • Added classes around RequestFieldDataMultiValue
  • Updated to Apache HttpCore 4.4.10
  • Reworked the ph-network/proxy handling (in an incompatible way)
  • Added IRequestParameter.getAsStringTrimmed
• v9.0.1 - 2018-04-18
  • Updated to javax.mail 1.6.1
  • Removed exclusion of javax.activation
  • AbstractXServlet is now derived from HttpServlet and no longer from GenericServlet
  • Extended HttpClientFactory methods slightly
• v9.0.0 - 2017-12-20
  • Updated to javax.mail 1.6.0
  • Updated to ph-commons 9.0.0
  • Added HTTP Referrer-Policy header support
  • Extracted ph-sitemap from ph-web
  • Added new sub-project ph-xservlet to contain an extended Servlet framework
  • HttpClientFactory supports customizable retry count
• v8.8.2 - 2017-07-04
  • Made debug flag in certain ResponseHandler* implementations customizable
  • ServletHelper caught Exception logging can now be enabled and disabled
  • Custom HostnameVerifier in HttpClientFactory
  • HttpDebugger has an afterRequest method now
• v8.8.1 - 2017-05-29
  • Improved exception handling in HTTP client helper
• v8.8.0 - 2017-05-10
  • New HTTP servlet class hierarchy for better separation of concerns
  • Started new Servlet base infrastructure
  • Added possibility to disable DNS client caching in HttpClient
• v8.7.4 - 2017-03-29
  • Improved PAC support to also handle IP6 addresses and dnsResolveEx
  • Updated to ph-commons 8.6.3
  • Updated to ph-schedule 3.6.1
• v8.7.3 - 2017-03-02
  • API extensions
  • Added package com.helger.servlet.logging based on https://github.com/librucha/servlet-logging-filter
• v8.7.2 - 2017-01-18
  • Request multipart parsing for uploaded files is now limited to MIME type "multipart/form-data"
• v8.7.1 - 2016-12-21
  • API extensions
  • Logging and JavaDoc improvements
• v8.7.0 - 2016-12-12
  • Binds to ph-commons 8.5.6
  • Extracted new subprojects ph-servlet and ph-useragent
• v8.6.3 - 2016-11-11
  • Binds to ph-commons 8.5.3
  • Work around some Tomcat/Jetty exceptions
• v8.6.2 - 2016-09-25
  • Added possibility to disable URL encoding (putting SESSION ID in URL) with WebSettings
• v8.6.1 - 2016-09-09
  • Binds to ph-commons 8.5.x
• v8.6.0 - 2016-08-21
  • Binds to ph-commons 8.4.x
• v8.5.0 - 2016-07-26
  • Binds to ph-commons 8.3.x

---

My personal Coding Styleguide | It is appreciated if you star the GitHub project if you like it.