diff --git a/docs/antora.yml b/docs/antora.yml index fae89ba67..82039fd90 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -16,7 +16,7 @@ asciidoc: minor-version: '6.0-SNAPSHOT' # The snapshot version for installing with brew version-brew: '6.0.0-SNAPSHOT' - java-client-standalone-version: '5.5.0-BETA' + java-client-standalone-version: '5.5.0' # Allows us to use UI macros. See https://docs.asciidoctor.org/asciidoc/latest/macros/ui-macros/ experimental: true snapshot: true @@ -26,7 +26,7 @@ asciidoc: # Must be lowercase because this is how the version appears in the docs page-latest-supported-mc: '6.0-snapshot' page-latest-supported-java-client: '6.0.0-SNAPSHOT' - page-latest-supported-java-client-new: '5.5.0-BETA' + page-latest-supported-java-client-new: '5.5.0' # https://github.com/hazelcast/hazelcast-go-client/releases page-latest-supported-go-client: '1.4.2' # https://github.com/hazelcast/hazelcast-cpp-client/releases diff --git a/docs/modules/clients/pages/java.adoc b/docs/modules/clients/pages/java.adoc index 14af5cf1d..cc0ee930a 100644 --- a/docs/modules/clients/pages/java.adoc +++ b/docs/modules/clients/pages/java.adoc @@ -9,7 +9,7 @@ Hazelcast provides a {java-client} which you can use to connect to a Hazelcast cluster. `hazelcast-.jar` is bundled in the Hazelcast standard package, so just add `hazelcast-.jar` to your classpath and you can start using this client as if you are using the Hazelcast API. -If you are interested in using a standalone or lightweight Java client, you can try the {java-client-new}. This client is currently available as Beta functionality but can interact with a Hazelcast cluster without being a full member. Please note that the {java-client-new} doesn't have full feature parity with the {java-client} yet and is not recommended for production environments. For more info, see xref:java#java-client-standalone-beta[]. +If you are interested in using a standalone or lightweight Java client, you can try the {java-client-new}. This client can interact with a Hazelcast cluster without being a full member. For more info on features and differences between the clients, see xref:java#java-client-standalone[]. NOTE: Where there are specific differences between {java-client} and {java-client-new}, this documentation will specify the appropriate client. Otherwise you can assume that generic references to client refer to both versions of the Java client. @@ -17,13 +17,14 @@ NOTE: Where there are specific differences between {java-client} and {java-clien Both clients enable you to use the Hazelcast API, with this page explaining any differences or technical details that affect usage. This page should be read alongside the respective Javadoc-generated API documentation available from within your IDE and the following links: + * https://docs.hazelcast.org/docs/{page-latest-supported-java-client}/javadoc[Hazelcast {java-client} API documentation] * https://docs.hazelcast.org/hazelcast-java-client/{page-latest-supported-java-client-new}/javadoc[Hazelcast {java-client-new} API documentation] == Get started * xref:java#get-started-with-java-client-and-embedded-server[] -* xref:java#get-started-with-java-client-standalone-beta[] +* xref:java#get-started-with-java-client-standalone[] === Get started with {java-client} @@ -72,7 +73,7 @@ You can find {java-client} code samples in the https://github.com/hazelcast/haze TIP: For a tutorial on getting started with Java in an embedded topology, see xref:getting-started:get-started-java.adoc[]. -=== Get started with {java-client-new} (BETA) +=== Get started with {java-client-new} To get started using the {java-client-new}, you need to add the `hazelcast-java-client` dependency to your pom.xml, as shown below. You can then start using this client as if you are using the Hazelcast API. @@ -113,17 +114,15 @@ If you are using `hazelcast-enterprise-java-client`, you need to add the `hazelc To migrate an application from the {java-client} to the {java-client-new}, you only have to update the dependency as described above. [java-client-standalone] -==== {java-client-new} (BETA) - -The {java-client-new} is only available as a Beta release and does not have full feature parity with the {java-client}. Please note the following differences and restrictions: +==== {java-client-new} -// check standalone +The {java-client-new} supports all major features of the {java-client}, but with certain limitations outlined below: -* Hazelcast Cloud is not supported +* XA transactions are not supported +* Only built-in sources and sinks are supported by the Pipeline API. External connectors, such as those used for cloud storage (e.g. S3, Azure, GCP), databases (e.g. MongoDB, PostgreSQL, MySQL), streaming platforms (e.g. Kafka, Kinesis), and file formats (e.g. Avro, CSV), are not supported +* Cloud support includes Hazelcast Cloud, Kubernetes, AWS, Azure, and GCP. Other environments, such as Apache jclouds, Consul, Docker, etcd, Eureka, Heroku, VMware Tanzu (formerly Pivotal Cloud Foundry), and Zookeeper, are not supported +* Session replication with Spring Boot is not supported * You cannot use the {java-client} and the {java-client-new} on the same JVM -* Any methods that raise the`UnsupportedOperationException` exception are not available e.g. `addLocalEntryListener(@Nonnull MapListener listener)` -* MultiMap and Set are not supported data structures -* Some client system properties are not supported (see individual notes) === Client API The Client API is your gateway to access your Hazelcast cluster, including distributed objects and data pipelines (jobs). @@ -195,9 +194,7 @@ The `addLocalEntryListener()` and `localKeySet()` methods are not supported beca === Use MultiMap -NOTE: This section is only applicable to the {java-client}. - -You can use a distributed multiMap object with the {java-client}, as follows: +You can use a distributed multiMap object with the client, as follows: [source,java] ---- @@ -236,7 +233,7 @@ The logic is the same for both member and client side, so see the specific secti * xref:data-structures:replicated-map.adoc[Replicated Map] * xref:data-structures:list.adoc[List] -* xref:data-structures:set.adoc[Set] (not supported by {java-client-new}) +* xref:data-structures:set.adoc[Set] * xref:data-structures:iatomiclong.adoc[IAtomicLong] * xref:data-structures:iatomicreference.adoc[IAtomicReference] * xref:data-structures:icountdownlatch.adoc[ICountDownLatch] @@ -507,6 +504,7 @@ security: For more information, see the appropriate API documentation for your client: +// TODO: separate JavaDocs? * https://docs.hazelcast.org/docs/{full-version}/javadoc/com/hazelcast/client/config/ClientSecurityConfig.html[{java-client-new} ClientSecurityConfig API documentation] * https://docs.hazelcast.org/hazelcast-java-client/{page-latest-supported-java-client-new}/javadoc/com/hazelcast/client/config/ClientSecurityConfig.html[{java-client} ClientSecurityConfig API documentation] @@ -1659,9 +1657,7 @@ For a programmatic example, see this xref:java#programmatic-configuration-5[code === Configure Hazelcast {hazelcast-cloud} -NOTE: This section is only applicable to the {java-client}. - -You can connect the {java-client} to a {hazelcast-cloud} Standard cluster which is hosted on link:{url-cloud-signup}[{hazelcast-cloud}]. +You can connect the client to a {hazelcast-cloud} Standard cluster which is hosted on link:{url-cloud-signup}[{hazelcast-cloud}]. For this, you need to enable {hazelcast-cloud} and specify the cluster's discovery token provided while creating the cluster; this allows the cluster to discover your clients. See the following example configurations: @@ -1986,8 +1982,6 @@ NOTE: You need to restart clients after modifying system properties. |long |Token to use when discovering the cluster via {hazelcast-cloud}. -NOTE: Not supported by {java-client-new}. - |`hazelcast.client.concurrent.window.ms` |100 |int @@ -1999,8 +1993,6 @@ Setting it too high effectively disables the optimization because once concurren it will keep that way. Setting it too low could lead to suboptimal performance because the system will try to use write-through and other optimizations even though the system is concurrent. -NOTE: Not supported by {java-client-new}. - |`hazelcast.discovery.enabled` |false |bool @@ -2166,8 +2158,6 @@ increased performance and reduced memory usage. to the same member when this property is `true`. When it is set to `false`, the client tries to connect to the members in the given order. -NOTE: Not supported by {java-client-new}. - |`hazelcast.client.connectivity.logging.delay.seconds` |10 |int