From 0937e8182435054a745009d03123e9a1926d942c Mon Sep 17 00:00:00 2001 From: Gregory Oschwald Date: Fri, 29 May 2026 19:56:51 +0000 Subject: [PATCH 1/3] Update Anonymizer javadoc to current Insights service name Replace references to "GeoIP2 Precision Insights" with "GeoIP2 Insights", matching the wording already used in the other GeoIP2 client libraries. Co-Authored-By: Claude Opus 4.8 (1M context) --- src/main/java/com/maxmind/geoip2/record/Anonymizer.java | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/java/com/maxmind/geoip2/record/Anonymizer.java b/src/main/java/com/maxmind/geoip2/record/Anonymizer.java index 621201c2..b68e1937 100644 --- a/src/main/java/com/maxmind/geoip2/record/Anonymizer.java +++ b/src/main/java/com/maxmind/geoip2/record/Anonymizer.java @@ -9,12 +9,12 @@ * Contains data for the anonymizer record associated with an IP address. *

*

- * This record is returned by the GeoIP2 Precision Insights web service. + * This record is returned by the GeoIP2 Insights web service. *

* * @param confidence A score ranging from 1 to 99 that is our percent confidence that the * network is currently part of an actively used VPN service. This is only - * available from the GeoIP2 Precision Insights web service. + * available from the GeoIP2 Insights web service. * @param isAnonymous Whether the IP address belongs to any sort of anonymous network. * @param isAnonymousVpn Whether the IP address is registered to an anonymous VPN provider. If a * VPN provider does not register subnets under names associated with them, @@ -26,10 +26,10 @@ * belongs to a residential ISP. * @param isTorExitNode Whether the IP address is a Tor exit node. * @param networkLastSeen The last day that the network was sighted in our analysis of anonymized - * networks. This is only available from the GeoIP2 Precision Insights web + * networks. This is only available from the GeoIP2 Insights web * service. * @param providerName The name of the VPN provider (e.g., NordVPN, SurfShark, etc.) associated - * with the network. This is only available from the GeoIP2 Precision Insights + * with the network. This is only available from the GeoIP2 Insights * web service. */ public record Anonymizer( From 27b214a9358d709c83a01967ea883e1aa3e1f53d Mon Sep 17 00:00:00 2001 From: Gregory Oschwald Date: Fri, 29 May 2026 20:24:29 +0000 Subject: [PATCH 2/3] Use 'GeoIP'/'GeoLite' branding in documentation and prose MaxMind no longer ships the legacy products, so refer to the products as 'GeoIP' and 'GeoLite' rather than 'GeoIP2'/'GeoLite2' in prose. Technical identifiers (packages, class names, filenames, edition IDs, hostnames, URLs) are unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) --- CLAUDE.md | 8 +-- README.md | 50 +++++++++---------- docs/hugo.toml | 2 +- pom.xml | 2 +- .../com/maxmind/geoip2/DatabaseProvider.java | 34 ++++++------- .../com/maxmind/geoip2/DatabaseReader.java | 30 +++++------ .../com/maxmind/geoip2/GeoIp2Provider.java | 2 +- .../com/maxmind/geoip2/JsonSerializable.java | 2 +- .../com/maxmind/geoip2/WebServiceClient.java | 12 ++--- .../maxmind/geoip2/WebServiceProvider.java | 2 +- .../geoip2/exception/GeoIp2Exception.java | 4 +- .../exception/InvalidRequestException.java | 2 +- .../geoip2/model/AnonymousIpResponse.java | 2 +- .../com/maxmind/geoip2/model/AsnResponse.java | 2 +- .../maxmind/geoip2/model/CityResponse.java | 2 +- .../geoip2/model/ConnectionTypeResponse.java | 2 +- .../maxmind/geoip2/model/CountryResponse.java | 2 +- .../maxmind/geoip2/model/DomainResponse.java | 2 +- .../geoip2/model/EnterpriseResponse.java | 2 +- .../geoip2/model/InsightsResponse.java | 2 +- .../maxmind/geoip2/model/IpRiskResponse.java | 2 +- .../com/maxmind/geoip2/model/IspResponse.java | 10 ++-- .../com/maxmind/geoip2/record/Anonymizer.java | 8 +-- .../java/com/maxmind/geoip2/record/City.java | 4 +- .../com/maxmind/geoip2/record/Country.java | 4 +- .../com/maxmind/geoip2/record/Postal.java | 4 +- .../geoip2/record/RepresentedCountry.java | 4 +- .../maxmind/geoip2/record/Subdivision.java | 4 +- 28 files changed, 103 insertions(+), 103 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 11507a8e..9e893205 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,12 +1,12 @@ -# CLAUDE.md - GeoIP2 Java API +# CLAUDE.md - GeoIP Java API This document contains guidance for Claude (and other AI assistants) when working with the GeoIP2-java codebase. It captures architectural patterns, conventions, and lessons learned to help maintain consistency and quality. ## Project Overview **GeoIP2-java** is MaxMind's official Java client library for: -- **GeoIP2/GeoLite2 Web Services**: Country, City, and Insights endpoints -- **GeoIP2/GeoLite2 Databases**: Local MMDB file reading for various database types (City, Country, ASN, Anonymous IP, ISP, etc.) +- **GeoIP/GeoLite Web Services**: Country, City Plus, and Insights endpoints +- **GeoIP/GeoLite Databases**: Local MMDB file reading for various database types (City, Country, ASN, Anonymous IP, ISP, etc.) The library provides both web service clients and database readers that return strongly-typed model objects containing geographic, ISP, anonymizer, and other IP-related data. @@ -397,7 +397,7 @@ public interface JsonSerializable { ## Additional Resources - [API Documentation](https://maxmind.github.io/GeoIP2-java/) -- [GeoIP2 Web Services Docs](https://dev.maxmind.com/geoip/docs/web-services) +- [GeoIP Web Services Docs](https://dev.maxmind.com/geoip/docs/web-services) - [MaxMind DB Format](https://maxmind.github.io/MaxMind-DB/) - GitHub Issues: https://github.com/maxmind/GeoIP2-java/issues diff --git a/README.md b/README.md index 78bfe7e7..9cfcdfcb 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# GeoIP2 Java API # +# GeoIP Java API # ## Description ## -This distribution provides an API for the GeoIP2 and GeoLite2 [web +This distribution provides an API for the GeoIP and GeoLite [web services](https://dev.maxmind.com/geoip/docs/web-services?lang=en) and [databases](https://dev.maxmind.com/geoip/docs/databases?lang=en). @@ -43,16 +43,16 @@ file and its dependencies in your classpath. Download the JAR files from the ## IP Geolocation Usage ## IP geolocation is inherently imprecise. Locations are often near the center of -the population. Any location provided by a GeoIP2 database or web service +the population. Any location provided by a GeoIP database or web service should not be used to identify a particular address or household. ## Web Service Usage ## To use the web service API, you must create a new `WebServiceClient` using the `WebServiceClient.Builder`. You must provide the `Builder` constructor your -MaxMind `accountId` and `licenseKey`. To use the GeoLite2 web services instead -of GeoIP2, set the `host` method on the builder to `geolite.info`. To use -the Sandbox GeoIP2 web services instead of the production GeoIP2 web +MaxMind `accountId` and `licenseKey`. To use the GeoLite web services instead +of GeoIP, set the `host` method on the builder to `geolite.info`. To use +the Sandbox GeoIP web services instead of the production GeoIP web services, set the `host` method on the builder to `sandbox.maxmind.com`. You may also set a `timeout` or set the `locales` fallback order using the methods on the `Builder`. After you have created the `WebServiceClient`, @@ -122,10 +122,10 @@ before any intermediary does so. // connections alive for future requests. // // Replace "42" with your account ID and "license_key" with your license key. -// To use the GeoLite2 web service instead of the GeoIP2 web service, call the +// To use the GeoLite web service instead of the GeoIP web service, call the // host method on the builder with "geolite.info", e.g. // new WebServiceClient.Builder(42, "license_key").host("geolite.info").build() -// To use the Sandbox GeoIP2 web service instead of the production GeoIP2 +// To use the Sandbox GeoIP web service instead of the production GeoIP // web service, call the host method on the builder with // "sandbox.maxmind.com", e.g. // new WebServiceClient.Builder(42, "license_key").host("sandbox.maxmind.com").build() @@ -151,10 +151,10 @@ System.out.println(country.names().get("zh-CN")); // '美国' // connections alive for future requests. // // Replace "42" with your account ID and "license_key" with your license key. -// To use the GeoLite2 web service instead of the GeoIP2 web service, call the +// To use the GeoLite web service instead of the GeoIP web service, call the // host method on the builder with "geolite.info", e.g. // new WebServiceClient.Builder(42, "license_key").host("geolite.info").build() -// To use the Sandbox GeoIP2 web service instead of the production GeoIP2 +// To use the Sandbox GeoIP web service instead of the production GeoIP // web service, call the host method on the builder with // "sandbox.maxmind.com", e.g. // new WebServiceClient.Builder(42, "license_key").host("sandbox.maxmind.com").build() @@ -194,8 +194,8 @@ System.out.println(location.longitude()); // -93.2323 // connections alive for future requests. // // Replace "42" with your account ID and "license_key" with your license key. -// Please note that the GeoLite2 web service does not support Insights. -// To use the Sandbox GeoIP2 web service instead of the production GeoIP2 +// Please note that the GeoLite web service does not support Insights. +// To use the Sandbox GeoIP web service instead of the production GeoIP // web service, call the host method on the builder with // "sandbox.maxmind.com", e.g. // new WebServiceClient.Builder(42, "license_key").host("sandbox.maxmind.com").build() @@ -239,7 +239,7 @@ System.out.println(response.traits().userType()); // 'college' To use the database API, you must create a new `DatabaseReader` using the `DatabaseReader.Builder`. You must provide the `Builder` constructor either an -`InputStream` or `File` for your GeoIP2 database. You may also specify the +`InputStream` or `File` for your GeoIP database. You may also specify the `fileMode` and the `locales` fallback order using the methods on the `Builder` object. @@ -254,7 +254,7 @@ method will be slightly faster as they do not need to construct and throw an exception. These methods otherwise behave the same. If the lookup succeeds, the method call will return a response class for the -GeoIP2 lookup. The class in turn contains multiple record classes, each of +GeoIP lookup. The class in turn contains multiple record classes, each of which represents part of the data returned by the database. We recommend reusing the `DatabaseReader` object rather than creating a new @@ -291,7 +291,7 @@ thrown when querying the database. ### City ### ```java -// A File object pointing to your GeoIP2 or GeoLite2 database +// A File object pointing to your GeoIP or GeoLite database File database = new File("/path/to/GeoIP2-City.mmdb"); // This creates the DatabaseReader object. To improve performance, reuse @@ -327,7 +327,7 @@ try (DatabaseReader reader = new DatabaseReader.Builder(database).build()) { ### Anonymous IP ### ```java -// A File object pointing to your GeoIP2 Anonymous IP database +// A File object pointing to your GeoIP Anonymous IP database File database = new File("/path/to/GeoIP2-Anonymous-IP.mmdb"); // This creates the DatabaseReader object. To improve performance, reuse @@ -349,7 +349,7 @@ try (DatabaseReader reader = new DatabaseReader.Builder(database).build()) { ### Anonymous Plus ### ```java -// A File object pointing to your GeoIP2 Anonymous Plus database +// A File object pointing to your GeoIP Anonymous Plus database File database = new File("/path/to/GeoIP-Anonymous-Plus.mmdb"); // This creates the DatabaseReader object. To improve performance, reuse @@ -374,7 +374,7 @@ try (DatabaseReader reader = new DatabaseReader.Builder(database).build()) { ### ASN ### ```java -// A File object pointing to your GeoLite2 ASN database +// A File object pointing to your GeoLite ASN database File database = new File("/path/to/GeoLite2-ASN.mmdb"); // This creates the DatabaseReader object. To improve performance, reuse @@ -393,7 +393,7 @@ try (DatabaseReader reader = new DatabaseReader.Builder(database).build()) { ### Connection-Type ### ```java -// A File object pointing to your GeoIP2 Connection-Type database +// A File object pointing to your GeoIP Connection-Type database File database = new File("/path/to/GeoIP2-Connection-Type.mmdb"); // This creates the DatabaseReader object. To improve performance, reuse @@ -413,7 +413,7 @@ try (DatabaseReader reader = new DatabaseReader.Builder(database).build()) { ### Domain ### ```java -// A File object pointing to your GeoIP2 Domain database +// A File object pointing to your GeoIP Domain database File database = new File("/path/to/GeoIP2-Domain.mmdb"); // This creates the DatabaseReader object. To improve performance, reuse @@ -430,7 +430,7 @@ try (DatabaseReader reader = new DatabaseReader.Builder(database).build()) { ### Enterprise ### ```java -// A File object pointing to your GeoIP2 Enterprise database +// A File object pointing to your GeoIP Enterprise database File database = new File("/path/to/GeoIP2-Enterprise.mmdb"); // This creates the DatabaseReader object. To improve performance, reuse @@ -470,7 +470,7 @@ try (DatabaseReader reader = new DatabaseReader.Builder(database).build()) { ### ISP ### ```java -// A File object pointing to your GeoIP2 ISP database +// A File object pointing to your GeoIP ISP database File database = new File("/path/to/GeoIP2-ISP.mmdb"); // This creates the DatabaseReader object. To improve performance, reuse @@ -490,7 +490,7 @@ try (DatabaseReader reader = new DatabaseReader.Builder(database).build()) { ## Exceptions ## For details on the possible errors returned by the web service itself, [see -the GeoIP2 web service +the GeoIP web service documentation](https://dev.maxmind.com/geoip/docs/web-services?lang=en). If the web service returns an explicit error document, this is thrown as an @@ -550,7 +550,7 @@ databases with data on geographical features around the world, including populated places. They offer both free and paid premium data. Each feature is uniquely identified by a `geonameId`, which is an integer. -Many of the records returned by the GeoIP2 web services and databases +Many of the records returned by the GeoIP web services and databases include a `geonameId()` method. This is the ID of a geographical feature (city, region, country, etc.) in the GeoNames database. @@ -596,7 +596,7 @@ whenever possible. ## Versioning ## -The GeoIP2 Java API uses [Semantic Versioning](https://semver.org/). +The GeoIP Java API uses [Semantic Versioning](https://semver.org/). ## Copyright and License ## diff --git a/docs/hugo.toml b/docs/hugo.toml index 0f2027fe..587bf7e5 100644 --- a/docs/hugo.toml +++ b/docs/hugo.toml @@ -1,4 +1,4 @@ -title = "GeoIP2 Java API" +title = "GeoIP Java API" disableKinds = ["taxonomy", "term", "RSS"] [[cascade]] diff --git a/pom.xml b/pom.xml index 7a4d8150..9110de7f 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ 5.1.0 jar MaxMind GeoIP2 API - GeoIP2 webservice client and database reader + GeoIP webservice client and database reader https://dev.maxmind.com/geoip?lang=en diff --git a/src/main/java/com/maxmind/geoip2/DatabaseProvider.java b/src/main/java/com/maxmind/geoip2/DatabaseProvider.java index 68f75d49..45f11180 100644 --- a/src/main/java/com/maxmind/geoip2/DatabaseProvider.java +++ b/src/main/java/com/maxmind/geoip2/DatabaseProvider.java @@ -16,7 +16,7 @@ import java.util.Optional; /** - * Interface for GeoIP2 database providers. + * Interface for GeoIP database providers. */ public interface DatabaseProvider extends GeoIp2Provider { @@ -39,7 +39,7 @@ Optional tryCity(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 Anonymous IP. + * Look up an IP address in a GeoIP Anonymous IP. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a AnonymousIpResponse for the requested IP address. @@ -50,7 +50,7 @@ AnonymousIpResponse anonymousIp(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 Anonymous IP. + * Look up an IP address in a GeoIP Anonymous IP. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a AnonymousIpResponse for the requested IP address or empty if it is not in the DB. @@ -61,7 +61,7 @@ Optional tryAnonymousIp(InetAddress ipAddress) throws IOExc GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 Anonymous Plus. + * Look up an IP address in a GeoIP Anonymous Plus. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a AnonymousPlusResponse for the requested IP address. @@ -72,7 +72,7 @@ AnonymousPlusResponse anonymousPlus(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 Anonymous Plus. + * Look up an IP address in a GeoIP Anonymous Plus. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a AnonymousPlusResponse for the requested IP address or empty if it is not in the DB. @@ -83,7 +83,7 @@ Optional tryAnonymousPlus(InetAddress ipAddress) throws I GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 IP Risk database. + * Look up an IP address in a GeoIP IP Risk database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return an IpRiskResponse for the requested IP address. @@ -94,7 +94,7 @@ IpRiskResponse ipRisk(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 IP Risk database. + * Look up an IP address in a GeoIP IP Risk database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return an IPRiskResponse for the requested IP address or empty if it is not in the DB. @@ -105,7 +105,7 @@ Optional tryIpRisk(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoLite2 ASN database. + * Look up an IP address in a GeoLite ASN database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return an IspResponse for the requested IP address. @@ -116,7 +116,7 @@ AsnResponse asn(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoLite2 ASN database. + * Look up an IP address in a GeoLite ASN database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return an IspResponse for the requested IP address or empty if it is not in the DB. @@ -127,7 +127,7 @@ Optional tryAsn(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 Connection Type database. + * Look up an IP address in a GeoIP Connection Type database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a ConnectTypeResponse for the requested IP address. @@ -138,7 +138,7 @@ ConnectionTypeResponse connectionType(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 Connection Type database. + * Look up an IP address in a GeoIP Connection Type database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a ConnectTypeResponse for the requested IP address or empty if it is not in the DB. @@ -149,7 +149,7 @@ Optional tryConnectionType(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 Domain database. + * Look up an IP address in a GeoIP Domain database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a DomainResponse for the requested IP address. @@ -160,7 +160,7 @@ DomainResponse domain(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 Domain database. + * Look up an IP address in a GeoIP Domain database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a DomainResponse for the requested IP address or empty if it is not in the DB. @@ -171,7 +171,7 @@ Optional tryDomain(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 Enterprise database. + * Look up an IP address in a GeoIP Enterprise database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return an EnterpriseResponse for the requested IP address. @@ -182,7 +182,7 @@ EnterpriseResponse enterprise(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 Enterprise database. + * Look up an IP address in a GeoIP Enterprise database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return an EnterpriseResponse for the requested IP address or empty if it is not in the DB. @@ -193,7 +193,7 @@ Optional tryEnterprise(InetAddress ipAddress) throws IOExcep GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 ISP database. + * Look up an IP address in a GeoIP ISP database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return an IspResponse for the requested IP address. @@ -204,7 +204,7 @@ IspResponse isp(InetAddress ipAddress) throws IOException, GeoIp2Exception; /** - * Look up an IP address in a GeoIP2 ISP database. + * Look up an IP address in a GeoIP ISP database. * * @param ipAddress IPv4 or IPv6 address to look up or empty if it is not in the DB. * @return an IspResponse for the requested IP address. diff --git a/src/main/java/com/maxmind/geoip2/DatabaseReader.java b/src/main/java/com/maxmind/geoip2/DatabaseReader.java index aedfeb2e..500da8ad 100644 --- a/src/main/java/com/maxmind/geoip2/DatabaseReader.java +++ b/src/main/java/com/maxmind/geoip2/DatabaseReader.java @@ -29,14 +29,14 @@ /** *

- * The class {@code DatabaseReader} provides a reader for the GeoIP2 database + * The class {@code DatabaseReader} provides a reader for the GeoIP database * format. *

*

Usage

*

* To use the database API, you must create a new {@code DatabaseReader} using * the {@code DatabaseReader.Builder}. You must provide the {@code Builder} - * constructor either an {@code InputStream} or {@code File} for your GeoIP2 + * constructor either an {@code InputStream} or {@code File} for your GeoIP * database. You may also specify the {@code fileMode} and the {@code locales} * fallback order using the methods on the {@code Builder} object. *

@@ -54,7 +54,7 @@ *

*

* If the lookup succeeds, the method call will return a response class for - * the GeoIP2 lookup. The class in turn contains multiple record classes, + * the GeoIP lookup. The class in turn contains multiple record classes, * each of which represents part of the data returned by the database. *

*

@@ -158,7 +158,7 @@ private int getDatabaseType() { /** *

* Constructs a Builder for the {@code DatabaseReader}. The file passed to - * it must be a valid GeoIP2 database file. + * it must be a valid GeoIP database file. *

*

* {@code Builder} creates instances of {@code DatabaseReader} @@ -177,7 +177,7 @@ public static final class Builder { NodeCache cache = NoCache.getInstance(); /** - * @param stream the stream containing the GeoIP2 database to use. + * @param stream the stream containing the GeoIP database to use. */ public Builder(InputStream stream) { this.stream = stream; @@ -185,7 +185,7 @@ public Builder(InputStream stream) { } /** - * @param database the GeoIP2 database file to use. + * @param database the GeoIP database file to use. */ public Builder(File database) { this.database = database; @@ -212,7 +212,7 @@ public Builder withCache(NodeCache cache) { } /** - * @param val The file mode used to open the GeoIP2 database + * @param val The file mode used to open the GeoIP database * @return Builder object * @throws java.lang.IllegalArgumentException if you initialized the Builder with a URL, * which uses {@link FileMode#MEMORY}, but you @@ -349,7 +349,7 @@ public Optional tryCity(InetAddress ipAddress) throws IOException, } /** - * Look up an IP address in a GeoIP2 Anonymous IP. + * Look up an IP address in a GeoIP Anonymous IP. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a AnonymousIpResponse for the requested IP address. @@ -376,7 +376,7 @@ public Optional tryAnonymousIp(InetAddress ipAddress) throw } /** - * Look up an IP address in a GeoIP2 Anonymous Plus. + * Look up an IP address in a GeoIP Anonymous Plus. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a AnonymousPlusResponse for the requested IP address. @@ -405,7 +405,7 @@ public Optional tryAnonymousPlus(InetAddress ipAddress) /** - * Look up an IP address in a GeoIP2 IP Risk database. + * Look up an IP address in a GeoIP IP Risk database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a IPRiskResponse for the requested IP address. @@ -427,7 +427,7 @@ public Optional tryIpRisk(InetAddress ipAddress) throws IOExcept } /** - * Look up an IP address in a GeoLite2 ASN database. + * Look up an IP address in a GeoLite ASN database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return an AsnResponse for the requested IP address. @@ -449,7 +449,7 @@ public Optional tryAsn(InetAddress ipAddress) throws IOException, } /** - * Look up an IP address in a GeoIP2 Connection Type database. + * Look up an IP address in a GeoIP Connection Type database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a ConnectTypeResponse for the requested IP address. @@ -476,7 +476,7 @@ public Optional tryConnectionType(InetAddress ipAddress) } /** - * Look up an IP address in a GeoIP2 Domain database. + * Look up an IP address in a GeoIP Domain database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return a DomainResponse for the requested IP address. @@ -498,7 +498,7 @@ public Optional tryDomain(InetAddress ipAddress) throws IOExcept } /** - * Look up an IP address in a GeoIP2 Enterprise database. + * Look up an IP address in a GeoIP Enterprise database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return an EnterpriseResponse for the requested IP address. @@ -526,7 +526,7 @@ public Optional tryEnterprise(InetAddress ipAddress) throws } /** - * Look up an IP address in a GeoIP2 ISP database. + * Look up an IP address in a GeoIP ISP database. * * @param ipAddress IPv4 or IPv6 address to lookup. * @return an IspResponse for the requested IP address. diff --git a/src/main/java/com/maxmind/geoip2/GeoIp2Provider.java b/src/main/java/com/maxmind/geoip2/GeoIp2Provider.java index 62ba9731..3e60879a 100644 --- a/src/main/java/com/maxmind/geoip2/GeoIp2Provider.java +++ b/src/main/java/com/maxmind/geoip2/GeoIp2Provider.java @@ -7,7 +7,7 @@ import java.net.InetAddress; /** - * Interface for GeoIP2 providers. + * Interface for GeoIP providers. */ public interface GeoIp2Provider { diff --git a/src/main/java/com/maxmind/geoip2/JsonSerializable.java b/src/main/java/com/maxmind/geoip2/JsonSerializable.java index a10a6a88..6ae122ec 100644 --- a/src/main/java/com/maxmind/geoip2/JsonSerializable.java +++ b/src/main/java/com/maxmind/geoip2/JsonSerializable.java @@ -15,7 +15,7 @@ public interface JsonSerializable { /** * @return JSON representation of this object. The structure is the same as - * the JSON provided by the GeoIP2 web service. + * the JSON provided by the GeoIP web service. * @throws IOException if there is an error serializing the object to JSON. */ default String toJson() throws IOException { diff --git a/src/main/java/com/maxmind/geoip2/WebServiceClient.java b/src/main/java/com/maxmind/geoip2/WebServiceClient.java index 3b7ea79c..80ba873f 100644 --- a/src/main/java/com/maxmind/geoip2/WebServiceClient.java +++ b/src/main/java/com/maxmind/geoip2/WebServiceClient.java @@ -43,7 +43,7 @@ /** *

- * The {@code WebServiceClient} class provides a client API for all the GeoIP2 + * The {@code WebServiceClient} class provides a client API for all the GeoIP * web services. The services are Country, City Plus, and Insights. Each * service returns a different set of data about an IP address, with Country * returning the least data and Insights the most. @@ -66,9 +66,9 @@ * To use the web service API, you must create a new {@code WebServiceClient} * using the {@code WebServiceClient.Builder}. You must provide the * {@code Builder} constructor your MaxMind {@code accountId} and - * {@code licenseKey}. To use the GeoLite2 web services instead of GeoIP2, set + * {@code licenseKey}. To use the GeoLite web services instead of GeoIP, set * the {@code host} method on the builder to {@code geolite.info}. To use the - * Sandbox GeoIP2 web services instead of the production GeoIP2 web services, + * Sandbox GeoIP web services instead of the production GeoIP web services, * set the {@code host} method on the builder to {@code sandbox.maxmind.com}. * You may also set a {@code timeout} or set the {@code locales} fallback order * using the methods on the {@code Builder}. After you have created the {@code @@ -91,7 +91,7 @@ *

Exceptions

*

* For details on the possible errors returned by the web service itself, see the GeoIP2 web + * href="https://dev.maxmind.com/geoip/docs/web-services?lang=en">the GeoIP web * service documentation. *

*

@@ -226,9 +226,9 @@ public WebServiceClient.Builder disableHttps() { /** * @param val The host to use. Set this to {@code geolite.info} to use the - * GeoLite2 web services instead of the GeoIP2 web services. + * GeoLite web services instead of the GeoIP web services. * Set this to {@code sandbox.maxmind.com} to use the Sandbox - * GeoIP2 web services instead of the production GeoIP2 web + * GeoIP web services instead of the production GeoIP web * services. The sandbox allows you to experiment with the * API without affecting your production data. * @return Builder object diff --git a/src/main/java/com/maxmind/geoip2/WebServiceProvider.java b/src/main/java/com/maxmind/geoip2/WebServiceProvider.java index ce2ddbc2..63140512 100644 --- a/src/main/java/com/maxmind/geoip2/WebServiceProvider.java +++ b/src/main/java/com/maxmind/geoip2/WebServiceProvider.java @@ -8,7 +8,7 @@ import java.net.InetAddress; /** - * Interface for GeoIP2 web service providers. + * Interface for GeoIP web service providers. */ public interface WebServiceProvider extends GeoIp2Provider { /** diff --git a/src/main/java/com/maxmind/geoip2/exception/GeoIp2Exception.java b/src/main/java/com/maxmind/geoip2/exception/GeoIp2Exception.java index 24afd18d..dc5bda46 100644 --- a/src/main/java/com/maxmind/geoip2/exception/GeoIp2Exception.java +++ b/src/main/java/com/maxmind/geoip2/exception/GeoIp2Exception.java @@ -1,8 +1,8 @@ package com.maxmind.geoip2.exception; /** - * This class represents a generic GeoIP2 error. All other exceptions thrown by - * the GeoIP2 API subclass this exception + * This class represents a generic GeoIP error. All other exceptions thrown by + * the GeoIP API subclass this exception */ public sealed class GeoIp2Exception extends Exception permits AddressNotFoundException, diff --git a/src/main/java/com/maxmind/geoip2/exception/InvalidRequestException.java b/src/main/java/com/maxmind/geoip2/exception/InvalidRequestException.java index 1acd388e..f6eeb795 100644 --- a/src/main/java/com/maxmind/geoip2/exception/InvalidRequestException.java +++ b/src/main/java/com/maxmind/geoip2/exception/InvalidRequestException.java @@ -3,7 +3,7 @@ import java.net.URI; /** - * This class represents a non-specific error returned by MaxMind's GeoIP2 web + * This class represents a non-specific error returned by MaxMind's GeoIP web * service. This occurs when the web service is up and responding to requests, * but the request sent was invalid in some way. */ diff --git a/src/main/java/com/maxmind/geoip2/model/AnonymousIpResponse.java b/src/main/java/com/maxmind/geoip2/model/AnonymousIpResponse.java index c8a22226..fe0981ef 100644 --- a/src/main/java/com/maxmind/geoip2/model/AnonymousIpResponse.java +++ b/src/main/java/com/maxmind/geoip2/model/AnonymousIpResponse.java @@ -13,7 +13,7 @@ import java.net.InetAddress; /** - * This class provides the GeoIP2 Anonymous IP model. + * This class provides the GeoIP Anonymous IP model. * * @param ipAddress The IP address that the data in the model is for. * @param isAnonymous Whether the IP address belongs to any sort of anonymous network. diff --git a/src/main/java/com/maxmind/geoip2/model/AsnResponse.java b/src/main/java/com/maxmind/geoip2/model/AsnResponse.java index 0dea5f03..0072f33c 100644 --- a/src/main/java/com/maxmind/geoip2/model/AsnResponse.java +++ b/src/main/java/com/maxmind/geoip2/model/AsnResponse.java @@ -13,7 +13,7 @@ import java.net.InetAddress; /** - * This class provides the GeoLite2 ASN model. + * This class provides the GeoLite ASN model. * * @param autonomousSystemNumber The autonomous system number associated with the IP address. * @param autonomousSystemOrganization The organization associated with the registered autonomous diff --git a/src/main/java/com/maxmind/geoip2/model/CityResponse.java b/src/main/java/com/maxmind/geoip2/model/CityResponse.java index f6f35254..f93997d3 100644 --- a/src/main/java/com/maxmind/geoip2/model/CityResponse.java +++ b/src/main/java/com/maxmind/geoip2/model/CityResponse.java @@ -40,7 +40,7 @@ * to most specific (smallest). If the response did not contain any * subdivisions, this is an empty list. * @param traits Record for the traits of the requested IP address. - * @see GeoIP2 Web + * @see GeoIP Web * Services */ public record CityResponse( diff --git a/src/main/java/com/maxmind/geoip2/model/ConnectionTypeResponse.java b/src/main/java/com/maxmind/geoip2/model/ConnectionTypeResponse.java index 40b492c9..0fa09310 100644 --- a/src/main/java/com/maxmind/geoip2/model/ConnectionTypeResponse.java +++ b/src/main/java/com/maxmind/geoip2/model/ConnectionTypeResponse.java @@ -16,7 +16,7 @@ import java.net.InetAddress; /** - * This class provides the GeoIP2 Connection-Type model. + * This class provides the GeoIP Connection-Type model. * * @param connectionType The connection type of the IP address. * @param ipAddress The IP address that the data in the model is for. diff --git a/src/main/java/com/maxmind/geoip2/model/CountryResponse.java b/src/main/java/com/maxmind/geoip2/model/CountryResponse.java index 23c3c3f2..1d20f2e6 100644 --- a/src/main/java/com/maxmind/geoip2/model/CountryResponse.java +++ b/src/main/java/com/maxmind/geoip2/model/CountryResponse.java @@ -25,7 +25,7 @@ * represented country is used for things like military bases. It is * only present when the represented country differs from the country. * @param traits Record for the traits of the requested IP address. - * @see GeoIP2 Web + * @see GeoIP Web * Services */ public record CountryResponse( diff --git a/src/main/java/com/maxmind/geoip2/model/DomainResponse.java b/src/main/java/com/maxmind/geoip2/model/DomainResponse.java index 347f255c..120bc866 100644 --- a/src/main/java/com/maxmind/geoip2/model/DomainResponse.java +++ b/src/main/java/com/maxmind/geoip2/model/DomainResponse.java @@ -13,7 +13,7 @@ import java.net.InetAddress; /** - * This class provides the GeoIP2 Domain model. + * This class provides the GeoIP Domain model. * * @param domain The second level domain associated with the IP address. This will be something * like "example.com" or "example.co.uk", not "foo.example.com". diff --git a/src/main/java/com/maxmind/geoip2/model/EnterpriseResponse.java b/src/main/java/com/maxmind/geoip2/model/EnterpriseResponse.java index 5cc60ef6..5cb741f8 100644 --- a/src/main/java/com/maxmind/geoip2/model/EnterpriseResponse.java +++ b/src/main/java/com/maxmind/geoip2/model/EnterpriseResponse.java @@ -18,7 +18,7 @@ /** *

- * This class provides a model for the data returned by the GeoIP2 Enterprise + * This class provides a model for the data returned by the GeoIP Enterprise * database *

* diff --git a/src/main/java/com/maxmind/geoip2/model/InsightsResponse.java b/src/main/java/com/maxmind/geoip2/model/InsightsResponse.java index c5e67aa3..f8462583 100644 --- a/src/main/java/com/maxmind/geoip2/model/InsightsResponse.java +++ b/src/main/java/com/maxmind/geoip2/model/InsightsResponse.java @@ -43,7 +43,7 @@ * to most specific (smallest). If the response did not contain any * subdivisions, this is an empty list. * @param traits Record for the traits of the requested IP address. - * @see GeoIP2 Web + * @see GeoIP Web * Services */ public record InsightsResponse( diff --git a/src/main/java/com/maxmind/geoip2/model/IpRiskResponse.java b/src/main/java/com/maxmind/geoip2/model/IpRiskResponse.java index b137e4e2..ae29dc65 100644 --- a/src/main/java/com/maxmind/geoip2/model/IpRiskResponse.java +++ b/src/main/java/com/maxmind/geoip2/model/IpRiskResponse.java @@ -13,7 +13,7 @@ import java.net.InetAddress; /** - * This class provides the GeoIP2 IP Risk model. + * This class provides the GeoIP IP Risk model. * * @param ipAddress The IP address that the data in the model is for. * @param isAnonymous Whether the IP address belongs to any sort of anonymous network. diff --git a/src/main/java/com/maxmind/geoip2/model/IspResponse.java b/src/main/java/com/maxmind/geoip2/model/IspResponse.java index 612816b4..7cb25d6f 100644 --- a/src/main/java/com/maxmind/geoip2/model/IspResponse.java +++ b/src/main/java/com/maxmind/geoip2/model/IspResponse.java @@ -13,7 +13,7 @@ import java.net.InetAddress; /** - * This class provides the GeoIP2 ISP model. + * This class provides the GeoIP ISP model. * * @param autonomousSystemNumber The autonomous system number associated with the IP address. * @param autonomousSystemOrganization The organization associated with the registered autonomous @@ -23,11 +23,11 @@ * @param mobileCountryCode The * mobile country code (MCC) associated with the IP address and ISP. * This property is available from the City and Insights web services and - * the GeoIP2 Enterprise database. + * the GeoIP Enterprise database. * @param mobileNetworkCode The * mobile network code (MNC) associated with the IP address and ISP. * This property is available from the City and Insights web services and - * the GeoIP2 Enterprise database. + * the GeoIP Enterprise database. * @param organization The name of the organization associated with the IP address. * @param network The network associated with the record. In particular, this is the largest * network where all the fields besides IP address have the same value. @@ -113,7 +113,7 @@ public String getIsp() { * @return The * mobile country code (MCC) associated with the IP address and ISP. * This property is available from the City and Insights web services and - * the GeoIP2 Enterprise database. + * the GeoIP Enterprise database. * @deprecated Use {@link #mobileCountryCode()} instead. This method will be removed in 6.0.0. */ @Deprecated(since = "5.0.0", forRemoval = true) @@ -126,7 +126,7 @@ public String getMobileCountryCode() { * @return The * mobile network code (MNC) associated with the IP address and ISP. * This property is available from the City and Insights web services and - * the GeoIP2 Enterprise database. + * the GeoIP Enterprise database. * @deprecated Use {@link #mobileNetworkCode()} instead. This method will be removed in 6.0.0. */ @Deprecated(since = "5.0.0", forRemoval = true) diff --git a/src/main/java/com/maxmind/geoip2/record/Anonymizer.java b/src/main/java/com/maxmind/geoip2/record/Anonymizer.java index b68e1937..6c94527a 100644 --- a/src/main/java/com/maxmind/geoip2/record/Anonymizer.java +++ b/src/main/java/com/maxmind/geoip2/record/Anonymizer.java @@ -9,12 +9,12 @@ * Contains data for the anonymizer record associated with an IP address. *

*

- * This record is returned by the GeoIP2 Insights web service. + * This record is returned by the GeoIP Insights web service. *

* * @param confidence A score ranging from 1 to 99 that is our percent confidence that the * network is currently part of an actively used VPN service. This is only - * available from the GeoIP2 Insights web service. + * available from the GeoIP Insights web service. * @param isAnonymous Whether the IP address belongs to any sort of anonymous network. * @param isAnonymousVpn Whether the IP address is registered to an anonymous VPN provider. If a * VPN provider does not register subnets under names associated with them, @@ -26,10 +26,10 @@ * belongs to a residential ISP. * @param isTorExitNode Whether the IP address is a Tor exit node. * @param networkLastSeen The last day that the network was sighted in our analysis of anonymized - * networks. This is only available from the GeoIP2 Insights web + * networks. This is only available from the GeoIP Insights web * service. * @param providerName The name of the VPN provider (e.g., NordVPN, SurfShark, etc.) associated - * with the network. This is only available from the GeoIP2 Insights + * with the network. This is only available from the GeoIP Insights * web service. */ public record Anonymizer( diff --git a/src/main/java/com/maxmind/geoip2/record/City.java b/src/main/java/com/maxmind/geoip2/record/City.java index 2ba14b2c..d8fad0e9 100644 --- a/src/main/java/com/maxmind/geoip2/record/City.java +++ b/src/main/java/com/maxmind/geoip2/record/City.java @@ -19,7 +19,7 @@ * @param locales The locales to use for retrieving localized names. * @param confidence A value from 0-100 indicating MaxMind's confidence that the city * is correct. This attribute is only available from the Insights - * web service and the GeoIP2 Enterprise database. + * web service and the GeoIP Enterprise database. * @param geonameId The GeoName ID for the city. * @param names A {@link Map} from locale codes to the name in that locale. */ @@ -77,7 +77,7 @@ public City( /** * @return A value from 0-100 indicating MaxMind's confidence that the city * is correct. This attribute is only available from the Insights - * web service and the GeoIP2 Enterprise database. + * web service and the GeoIP Enterprise database. * @deprecated Use {@link #confidence()} instead. This method will be removed in 6.0.0. */ @Deprecated(since = "5.0.0", forRemoval = true) diff --git a/src/main/java/com/maxmind/geoip2/record/Country.java b/src/main/java/com/maxmind/geoip2/record/Country.java index 17e4e699..b55958e4 100644 --- a/src/main/java/com/maxmind/geoip2/record/Country.java +++ b/src/main/java/com/maxmind/geoip2/record/Country.java @@ -19,7 +19,7 @@ * @param locales The locales to use for retrieving localized names. * @param confidence A value from 0-100 indicating MaxMind's confidence that the * country is correct. This attribute is only available from the - * Insights web service and the GeoIP2 Enterprise database. + * Insights web service and the GeoIP Enterprise database. * @param geonameId The GeoName ID for the country. * @param isInEuropeanUnion This is true if the country is a member state of the * European Union. @@ -91,7 +91,7 @@ public Country( /** * @return A value from 0-100 indicating MaxMind's confidence that the * country is correct. This attribute is only available from the - * Insights web service and the GeoIP2 Enterprise database. + * Insights web service and the GeoIP Enterprise database. * @deprecated Use {@link #confidence()} instead. This method will be removed in 6.0.0. */ @Deprecated(since = "5.0.0", forRemoval = true) diff --git a/src/main/java/com/maxmind/geoip2/record/Postal.java b/src/main/java/com/maxmind/geoip2/record/Postal.java index be7680a5..21c5bf07 100644 --- a/src/main/java/com/maxmind/geoip2/record/Postal.java +++ b/src/main/java/com/maxmind/geoip2/record/Postal.java @@ -14,7 +14,7 @@ * code. * @param confidence A value from 0-100 indicating MaxMind's confidence that the postal * code is correct. This attribute is only available from the Insights - * web service and the GeoIP2 Enterprise database. + * web service and the GeoIP Enterprise database. */ public record Postal( @JsonProperty("code") @@ -47,7 +47,7 @@ public String getCode() { /** * @return A value from 0-100 indicating MaxMind's confidence that the * postal code is correct. This attribute is only available from the - * Insights web service and the GeoIP2 Enterprise database. + * Insights web service and the GeoIP Enterprise database. * @deprecated Use {@link #confidence()} instead. This method will be removed in 6.0.0. */ @Deprecated(since = "5.0.0", forRemoval = true) diff --git a/src/main/java/com/maxmind/geoip2/record/RepresentedCountry.java b/src/main/java/com/maxmind/geoip2/record/RepresentedCountry.java index be9c0234..70cf73b7 100644 --- a/src/main/java/com/maxmind/geoip2/record/RepresentedCountry.java +++ b/src/main/java/com/maxmind/geoip2/record/RepresentedCountry.java @@ -24,7 +24,7 @@ * @param locales The locales to use for retrieving localized names. * @param confidence A value from 0-100 indicating MaxMind's confidence that the * country is correct. This attribute is only available from the - * Insights web service and the GeoIP2 Enterprise database. + * Insights web service and the GeoIP Enterprise database. * @param geonameId The GeoName ID for the country. * @param isInEuropeanUnion This is true if the country is a member state of the * European Union. @@ -115,7 +115,7 @@ public String getType() { /** * @return A value from 0-100 indicating MaxMind's confidence that the * country is correct. This attribute is only available from the - * Insights web service and the GeoIP2 Enterprise database. + * Insights web service and the GeoIP Enterprise database. * @deprecated Use {@link #confidence()} instead. This method will be removed in 6.0.0. */ @Deprecated(since = "5.0.0", forRemoval = true) diff --git a/src/main/java/com/maxmind/geoip2/record/Subdivision.java b/src/main/java/com/maxmind/geoip2/record/Subdivision.java index 460fc6f1..695396ed 100644 --- a/src/main/java/com/maxmind/geoip2/record/Subdivision.java +++ b/src/main/java/com/maxmind/geoip2/record/Subdivision.java @@ -19,7 +19,7 @@ * @param locales The locales to use for retrieving localized names. * @param confidence A value from 0-100 indicating MaxMind's confidence that the * subdivision is correct. This attribute is only available from - * the Insights web service and the GeoIP2 Enterprise database. + * the Insights web service and the GeoIP Enterprise database. * @param geonameId The GeoName ID for the subdivision. * @param isoCode A string up to three characters long containing the subdivision * portion of the ISO @@ -85,7 +85,7 @@ public Subdivision( /** * @return A value from 0-100 indicating MaxMind's confidence that * the subdivision is correct. This attribute is only available from - * the Insights web service and the GeoIP2 Enterprise database. + * the Insights web service and the GeoIP Enterprise database. * @deprecated Use {@link #confidence()} instead. This method will be removed in 6.0.0. */ @Deprecated(since = "5.0.0", forRemoval = true) From ab19d2201c6bed573ee660ad37c691d4518ceaa5 Mon Sep 17 00:00:00 2001 From: Gregory Oschwald Date: Fri, 29 May 2026 20:45:23 +0000 Subject: [PATCH 3/3] Update remaining GeoIP2 product prose to GeoIP Co-Authored-By: Claude Opus 4.8 (1M context) --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 9110de7f..288691c3 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ geoip2 5.1.0 jar - MaxMind GeoIP2 API + MaxMind GeoIP API GeoIP webservice client and database reader https://dev.maxmind.com/geoip?lang=en