Avant de commencer Utilisation du pilote DataStax Java Plugin d'authentification pour Java 4.x Plugin d'authentification pour Java 3.x

Utilisation d'un pilote client Cassandra Java pour accéder à Amazon Keyspaces par programmation

Cette section explique comment vous connecter à Amazon Keyspaces à l'aide d'un pilote client Java.

Note

Java 17 et le pilote DataStax Java 4.17 ne sont actuellement pris en charge que par la version bêta. Pour plus d’informations, consultez https://docs.datastax.com/en/developer/java-driver/4.17/upgrade_guide/.

Pour fournir aux utilisateurs et aux applications des informations d'identification leur permettant d'accéder par programmation aux ressources Amazon Keyspaces, vous pouvez effectuer l'une des opérations suivantes :

Créez des informations d'identification spécifiques au service associées à un utilisateur AWS Identity and Access Management (IAM) spécifique.
Pour renforcer la sécurité, nous recommandons de créer des clés d'accès IAM pour les identités IAM qui sont utilisées dans tous les AWS services. Le plugin d'authentification Amazon Keyspaces SigV4 pour les pilotes clients Cassandra vous permet d'authentifier les appels vers Amazon Keyspaces à l'aide de clés d'accès IAM plutôt que de votre nom d'utilisateur et de votre mot de passe. Pour plus d’informations, consultez Comment créer et configurer des AWS informations d'identification pour Amazon Keyspaces.

Note

Pour un exemple d'utilisation d'Amazon Keyspaces avec Spring Boot, consultez. https://github.com/aws-samples/amazon-keyspaces-examples/tree/main/java/datastax-v4/spring

Rubriques

Avant de commencer
Un tep-by-step tutoriel pour se connecter à Amazon Keyspaces à l'aide du pilote DataStax Java pour Apache Cassandra à l'aide d'informations d'identification spécifiques au service
Un tep-by-step tutoriel pour se connecter à Amazon Keyspaces à l'aide du pilote DataStax Java 4.x pour Apache Cassandra et du plugin d'authentification SigV4
Connectez-vous à Amazon Keyspaces à l'aide du pilote DataStax Java 3.x pour Apache Cassandra et du plugin d'authentification SigV4

Avant de commencer

Pour vous connecter à Amazon Keyspaces, vous devez effectuer les tâches suivantes avant de pouvoir commencer.

Amazon Keyspaces nécessite l'utilisation du protocole TLS (Transport Layer Security) pour sécuriser les connexions avec les clients.

Téléchargez le certificat numérique Starfield à l'aide de la commande suivante et enregistrez-le sf-class2-root.crt localement ou dans votre répertoire personnel.
```
curl https://certs.secureserver.net/repository/sf-class2-root.crt -O
```
Note
Vous pouvez également utiliser le certificat numérique Amazon pour vous connecter à Amazon Keyspaces et continuer à le faire si votre client se connecte correctement à Amazon Keyspaces. Le certificat Starfield fournit une rétrocompatibilité supplémentaire aux clients utilisant des autorités de certification plus anciennes.

Convertissez le certificat numérique Starfield en fichier TrustStore.


openssl x509 -outform der -in sf-class2-root.crt -out temp_file.der
keytool -import -alias cassandra -keystore cassandra_truststore.jks -file temp_file.der

Au cours de cette étape, vous devez créer un mot de passe pour le keystore et faire confiance à ce certificat. La commande interactive ressemble à ceci.


Enter keystore password:
Re-enter new password:
Owner: OU=Starfield Class 2 Certification Authority, O="Starfield Technologies, Inc.", C=US
Issuer: OU=Starfield Class 2 Certification Authority, O="Starfield Technologies, Inc.", C=US
Serial number: 0
Valid from: Tue Jun 29 17:39:16 UTC 2004 until: Thu Jun 29 17:39:16 UTC 2034
Certificate fingerprints:
	 MD5:  32:4A:4B:BB:C8:63:69:9B:BE:74:9A:C6:DD:1D:46:24
	 SHA1: AD:7E:1C:28:B0:64:EF:8F:60:03:40:20:14:C3:D0:E3:37:0E:B5:8A
	 SHA256: 14:65:FA:20:53:97:B8:76:FA:A6:F0:A9:95:8E:55:90:E4:0F:CC:7F:AA:4F:B7:C2:C8:67:75:21:FB:5F:B6:58
Signature algorithm name: SHA1withRSA
Subject Public Key Algorithm: 2048-bit RSA key
Version: 3
Extensions:
#1: ObjectId: 2.5.29.35 Criticality=false
AuthorityKeyIdentifier [
KeyIdentifier [
0000: BF 5F B7 D1 CE DD 1F 86   F4 5B 55 AC DC D7 10 C2  ._.......[U.....
0010: 0E A9 88 E7                                        ....
]
[OU=Starfield Class 2 Certification Authority, O="Starfield Technologies, Inc.", C=US]
SerialNumber: [    00]
]
#2: ObjectId: 2.5.29.19 Criticality=false
BasicConstraints:[
  CA:true
  PathLen:2147483647
]
#3: ObjectId: 2.5.29.14 Criticality=false
SubjectKeyIdentifier [
KeyIdentifier [
0000: BF 5F B7 D1 CE DD 1F 86   F4 5B 55 AC DC D7 10 C2  ._.......[U.....
0010: 0E A9 88 E7                                        ....
]
]
Trust this certificate? [no]:  y

Joignez le fichier trustStore dans les arguments de la JVM :


-Djavax.net.ssl.trustStore=path_to_file/cassandra_truststore.jks 
-Djavax.net.ssl.trustStorePassword=my_password

Un tep-by-step tutoriel pour se connecter à Amazon Keyspaces à l'aide du pilote DataStax Java pour Apache Cassandra à l'aide d'informations d'identification spécifiques au service

Le step-by-step didacticiel suivant vous explique comment vous connecter à Amazon Keyspaces à l'aide d'un pilote Java pour Cassandra à l'aide d'informations d'identification spécifiques au service. Plus précisément, vous utiliserez la version 4.0 du pilote DataStax Java pour Apache Cassandra.

Rubriques

Étape 1 : Prérequis
Étape 2 : Configuration du pilote
Étape 3 : Exécuter l'exemple d'application

Étape 1 : Prérequis

Pour suivre ce didacticiel, vous devez générer des informations d'identification spécifiques au service et ajouter le pilote DataStax Java pour Apache Cassandra à votre projet Java.

Générez des informations d'identification spécifiques au service pour votre utilisateur Amazon Keyspaces IAM en suivant les étapes décrites dans. Générer des informations d'identification spécifiques au service Si vous préférez utiliser les clés d'accès IAM pour l'authentification, consultezUn tep-by-step tutoriel pour se connecter à Amazon Keyspaces à l'aide du pilote DataStax Java 4.x pour Apache Cassandra et du plugin d'authentification SigV4.
Ajoutez le pilote DataStax Java pour Apache Cassandra à votre projet Java. Assurez-vous que vous utilisez une version du pilote compatible avec Apache Cassandra 3.11.2. Pour plus d'informations, consultez la documentation du pilote DataStax Java pour Apache Cassandra.

Étape 2 : Configuration du pilote

Vous pouvez définir les paramètres du pilote DataStax Java Cassandra en créant un fichier de configuration pour votre application. Ce fichier de configuration remplace les paramètres par défaut et indique au pilote de se connecter au point de terminaison du service Amazon Keyspaces via le port 9142. Pour obtenir la liste des points de terminaison de service disponibles, consultezPoints de terminaison de service pour Amazon Keyspaces.

Créez un fichier de configuration et enregistrez-le dans le dossier des ressources de l'application, par exemple,. src/main/resources/application.conf Ouvrez application.conf et ajoutez les paramètres de configuration suivants.

Fournisseur d'authentification : créez le fournisseur d'authentification avec la PlainTextAuthProvider classe. ServiceUserLe nom ServicePassworddoit correspondre au nom d'utilisateur et au mot de passe que vous avez obtenus lorsque vous avez généré les informations d'identification spécifiques au service en suivant les étapes décrites dans. Générer des informations d'identification spécifiques au service

Note
Vous pouvez utiliser des informations d'identification à court terme en utilisant le plug-in d'authentification du pilote DataStax Java pour Apache Cassandra au lieu de les coder en dur dans le fichier de configuration du pilote. Pour en savoir plus, suivez les instructions duUn tep-by-step tutoriel pour se connecter à Amazon Keyspaces à l'aide du pilote DataStax Java 4.x pour Apache Cassandra et du plugin d'authentification SigV4.
Centre de données local : définissez la valeur local-datacenter pour la région à laquelle vous vous connectez. Par exemple, si l'application se connecte àcassandra.us-east-2.amazonaws.com, définissez le centre de données local surus-east-2. Pour toutes les options disponibles Régions AWS, voirPoints de terminaison de service pour Amazon Keyspaces. Paramétré slow-replica-avoidance = false pour équilibrer la charge en fonction d'un nombre réduit de nœuds.
SSL/TLS — Initialisez le SSL EngineFactory en ajoutant une section dans le fichier de configuration avec une seule ligne qui spécifie la classe avec. class = DefaultSslEngineFactory Indiquez le chemin d'accès au fichier TrustStore et le mot de passe que vous avez créés précédemment. Amazon Keyspaces ne prend pas en charge hostname-validation les pairs, alors définissez cette option sur false.


datastax-java-driver {

    basic.contact-points = [ "cassandra.us-east-2.amazonaws.com:9142"]
    advanced.auth-provider{
        class = PlainTextAuthProvider
        username = "ServiceUserName"
        password = "ServicePassword"
    }
    basic.load-balancing-policy {
        local-datacenter = "us-east-2"
        slow-replica-avoidance = false           
    }

    advanced.ssl-engine-factory {
        class = DefaultSslEngineFactory
        truststore-path = "./src/main/resources/cassandra_truststore.jks"
        truststore-password = "my_password"
        hostname-validation = false
      }
}

Note

Au lieu d'ajouter le chemin du TrustStore dans le fichier de configuration, vous pouvez également ajouter le chemin du TrustStore directement dans le code de l'application ou vous pouvez ajouter le chemin du TrustStore à vos arguments JVM.

Étape 3 : Exécuter l'exemple d'application

Cet exemple de code montre une application de ligne de commande simple qui crée un pool de connexions vers Amazon Keyspaces à l'aide du fichier de configuration que nous avons créé précédemment. Il confirme que la connexion est établie en exécutant une simple requête.


package <your package>;
// add the following imports to your project
import com.datastax.oss.driver.api.core.CqlSession;
import com.datastax.oss.driver.api.core.config.DriverConfigLoader;
import com.datastax.oss.driver.api.core.cql.ResultSet;
import com.datastax.oss.driver.api.core.cql.Row;

public class App 
{
    
    public static void main( String[] args )
    {
        //Use DriverConfigLoader to load your configuration file
        DriverConfigLoader loader = DriverConfigLoader.fromClasspath("application.conf");
        try (CqlSession session = CqlSession.builder()
                .withConfigLoader(loader)
                .build()) {

            ResultSet rs = session.execute("select * from system_schema.keyspaces");
            Row row = rs.one();
            System.out.println(row.getString("keyspace_name"));
        }
    }
}

Note

Utilisez un try bloc pour établir la connexion afin de garantir qu'elle est toujours fermée. Si vous n'utilisez pas de try blocage, pensez à fermer votre connexion pour éviter toute fuite de ressources.

Un tep-by-step tutoriel pour se connecter à Amazon Keyspaces à l'aide du pilote DataStax Java 4.x pour Apache Cassandra et du plugin d'authentification SigV4

La section suivante décrit comment utiliser le plug-in d'authentification SigV4 pour le pilote DataStax Java 4.x open source pour Apache Cassandra afin d'accéder à Amazon Keyspaces (pour Apache Cassandra). Le plugin est disponible dans le GitHubréférentiel.

Le plugin d'authentification SigV4 vous permet d'utiliser les informations d'identification IAM pour les utilisateurs ou les rôles lorsque vous vous connectez à Amazon Keyspaces. Au lieu de demander un nom d'utilisateur et un mot de passe, ce plugin signe les demandes d'API à l'aide de clés d'accès. Pour plus d’informations, consultez Comment créer et configurer des AWS informations d'identification pour Amazon Keyspaces.

Étape 1 : Prérequis

Pour suivre ce didacticiel, vous devez effectuer les tâches suivantes.

Si ce n'est pas déjà fait, créez des informations d'identification pour votre utilisateur ou rôle IAM en suivant les étapes décrites dansComment créer et configurer des AWS informations d'identification pour Amazon Keyspaces. Ce didacticiel part du principe que les clés d'accès sont stockées sous forme de variables d'environnement. Pour plus d’informations, consultez Comment gérer les clés d'accès pour les utilisateurs IAM.
Ajoutez le pilote DataStax Java pour Apache Cassandra à votre projet Java. Assurez-vous que vous utilisez une version du pilote compatible avec Apache Cassandra 3.11.2. Pour plus d'informations, consultez la documentation du pilote DataStax Java pour Apache Cassandra.
Ajoutez le plugin d'authentification à votre application. Le plugin d'authentification prend en charge la version 4.x du pilote DataStax Java pour Apache Cassandra. Si vous utilisez Apache Maven, ou un système de génération qui peut utiliser les dépendances Maven, ajoutez les dépendances suivantes à votre fichier pom.xml.

Important
Remplacez la version du plugin par la dernière version, comme indiqué dans le GitHub référentiel.
```
<dependency>
        <groupId>software.aws.mcs</groupId>
        <artifactId>aws-sigv4-auth-cassandra-java-driver-plugin</artifactId>
        <version>4.0.9</version>
</dependency>
```

Étape 2 : Configuration du pilote

Fournisseur d'authentification : définissez une nouvelle instance desoftware.aws.mcs.auth.SigV4AuthProvider. advanced.auth-provider.class Le SigV4 AuthProvider est le gestionnaire d'authentification fourni par le plugin pour effectuer l'authentification Sigv4.
Centre de données local : définissez la valeur local-datacenter pour la région à laquelle vous vous connectez. Par exemple, si l'application se connecte àcassandra.us-east-2.amazonaws.com, définissez le centre de données local surus-east-2. Pour toutes les options disponibles Régions AWS, voirPoints de terminaison de service pour Amazon Keyspaces. Réglé slow-replica-avoidance = false pour équilibrer la charge par rapport à tous les nœuds disponibles.
Idempotentie — Définissez la valeur par défaut idempotence pour que l'application configure le pilote pour qu'trueil réessaie toujours les demandes de lecture/écriture/préparation/exécution qui ont échoué. Il s'agit d'une bonne pratique pour les applications distribuées qui permet de gérer les défaillances transitoires en réessayant les demandes ayant échoué.
SSL/TLS — Initialisez le SSL EngineFactory en ajoutant une section dans le fichier de configuration avec une seule ligne qui spécifie la classe avec. class = DefaultSslEngineFactory Indiquez le chemin d'accès au fichier TrustStore et le mot de passe que vous avez créés précédemment. Amazon Keyspaces ne prend pas en charge hostname-validation les pairs, alors définissez cette option sur false.
Connexions — Créez au moins 3 connexions locales par point de terminaison en définissantlocal.size = 3. Il s'agit d'une bonne pratique qui aide votre application à gérer les surcharges et les pics de trafic. Pour plus d'informations sur le calcul du nombre de connexions locales par point de terminaison dont votre application a besoin en fonction des modèles de trafic attendus, consultezComment configurer les connexions dans Amazon Keyspaces.
Politique de nouvelle tentative — La AmazonKeyspacesExponentialRetryPolicy politique de nouvelle tentative d'Amazon Keyspaces est une alternative à celle fournie avec DefaultRetryPolicy le pilote Cassandra. La principale différence entre les deux politiques de nouvelle tentative est que vous pouvez configurer le nombre de tentatives en fonction AmazonKeyspacesExponentialRetryPolicy de vos besoins. Par défaut, le nombre de nouvelles tentatives pour le AmazonKeyspacesExponentialRetryPolicy est défini sur 3. En outre, la politique de réessai d'Amazon Keyspaces ne renvoie pas le générique. NoHostAvailableException La politique de nouvelles tentatives d'Amazon Keyspaces renvoie plutôt l'exception initiale renvoyée par le service. Pour plus d'exemples de code implémentant des politiques de nouvelle tentative, consultez les politiques de nouvelle tentative d'Amazon Keyspaces sur Github.
Instructions préparées : définissez la valeur prepare-on-all-nodes sur false pour optimiser l'utilisation du réseau.


datastax-java-driver {
    basic {
        contact-points = [ "cassandra.us-east-2.amazonaws.com:9142"]  
        request {
            timeout = 2 seconds
            consistency = LOCAL_QUORUM
            page-size = 1024
            default-idempotence = true
        }
        load-balancing-policy {
            local-datacenter = "us-east-2"
            class = DefaultLoadBalancingPolicy
            slow-replica-avoidance = false           
        }
    }
    advanced {
        auth-provider {
            class = software.aws.mcs.auth.SigV4AuthProvider
            aws-region = us-east-2
        }
        ssl-engine-factory {
            class = DefaultSslEngineFactory
            truststore-path = "./src/main/resources/cassandra_truststore.jks"
            truststore-password = "my_password"
            hostname-validation = false
        }
        connection {
	     connect-timeout = 5 seconds
	     max-requests-per-connection = 512
	     pool {
                local.size = 3
	     }
        }
       retry-policy {
           class =  com.aws.ssa.keyspaces.retry.AmazonKeyspacesExponentialRetryPolicy
	    max-attempts = 3
	    min-wait = 10 mills
	    max-wait = 100 mills
       }
       prepared-statements {
	    prepare-on-all-nodes = false
       }
    }
}

Note

Étape 3 : Exécuter l'application


package <your package>;
// add the following imports to your project
import com.datastax.oss.driver.api.core.CqlSession;
import com.datastax.oss.driver.api.core.config.DriverConfigLoader;
import com.datastax.oss.driver.api.core.cql.ResultSet;
import com.datastax.oss.driver.api.core.cql.Row;

public class App 
{
    
    public static void main( String[] args )
    {
        //Use DriverConfigLoader to load your configuration file
        DriverConfigLoader loader = DriverConfigLoader.fromClasspath("application.conf");
        try (CqlSession session = CqlSession.builder()
                .withConfigLoader(loader)
                .build()) {

            ResultSet rs = session.execute("select * from system_schema.keyspaces");
            Row row = rs.one();
            System.out.println(row.getString("keyspace_name"));
        }
    }
}

Note

Connectez-vous à Amazon Keyspaces à l'aide du pilote DataStax Java 3.x pour Apache Cassandra et du plugin d'authentification SigV4

La section suivante décrit comment utiliser le plug-in d'authentification SigV4 pour le pilote DataStax Java open source 3.x pour Apache Cassandra afin d'accéder à Amazon Keyspaces. Le plugin est disponible dans le GitHub référentiel.

Le plugin d'authentification SigV4 vous permet d'utiliser les informations d'identification IAM pour les utilisateurs et les rôles lorsque vous vous connectez à Amazon Keyspaces. Au lieu de demander un nom d'utilisateur et un mot de passe, ce plugin signe les demandes d'API à l'aide de clés d'accès. Pour plus d’informations, consultez Comment créer et configurer des AWS informations d'identification pour Amazon Keyspaces.

Étape 1 : Prérequis

Pour exécuter cet exemple de code, vous devez d'abord effectuer les tâches suivantes.

Créez des informations d'identification pour votre utilisateur ou rôle IAM en suivant les étapes décrites dansComment créer et configurer des AWS informations d'identification pour Amazon Keyspaces. Ce didacticiel part du principe que les clés d'accès sont stockées sous forme de variables d'environnement. Pour plus d’informations, consultez Comment gérer les clés d'accès pour les utilisateurs IAM.
Suivez les étapes décrites Avant de commencer pour télécharger le certificat numérique Starfield, le convertir en fichier TrustStore et joindre le fichier TrustStore dans les arguments de la JVM à votre application.
Ajoutez le pilote DataStax Java pour Apache Cassandra à votre projet Java. Assurez-vous que vous utilisez une version du pilote compatible avec Apache Cassandra 3.11.2. Pour plus d'informations, consultez la documentation du pilote DataStax Java pour Apache Cassandra.
Ajoutez le plugin d'authentification à votre application. Le plugin d'authentification prend en charge la version 3.x du pilote DataStax Java pour Apache Cassandra. Si vous utilisez Apache Maven, ou un système de génération qui peut utiliser les dépendances Maven, ajoutez les dépendances suivantes à votre fichier pom.xml. Remplacez la version du plugin par la dernière version, comme indiqué dans le GitHub référentiel.
```
<dependency>
        <groupId>software.aws.mcs</groupId>
        <artifactId>aws-sigv4-auth-cassandra-java-driver-plugin_3</artifactId>
        <version>3.0.3</version>
</dependency>
```

Étape 2 : Exécuter l'application

Cet exemple de code montre une application de ligne de commande simple qui crée un pool de connexions vers Amazon Keyspaces. Il confirme que la connexion est établie en exécutant une simple requête.


package <your package>;
// add the following imports to your project

import software.aws.mcs.auth.SigV4AuthProvider;  
import com.datastax.driver.core.Cluster;  
import com.datastax.driver.core.ResultSet;  
import com.datastax.driver.core.Row;  
import com.datastax.driver.core.Session;

public class App 
{
    
    public static void main( String[] args )
    {
        String endPoint = "cassandra.us-east-2.amazonaws.com";  
        int portNumber = 9142;
        Session session = Cluster.builder()  
	                                 .addContactPoint(endPoint)  
	                                 .withPort(portNumber)  
	                                 .withAuthProvider(new SigV4AuthProvider("us-east-2"))  
	                                 .withSSL()  
	                                 .build()  
	                                 .connect();

        ResultSet rs = session.execute("select * from system_schema.keyspaces");  
        Row row = rs.one();  
        System.out.println(row.getString("keyspace_name"));
    }
}

Remarques d'utilisation :

Pour obtenir la liste des points de terminaison disponibles, reportez-vous à la section Points de terminaison de service pour Amazon Keyspaces.

Consultez le référentiel suivant pour obtenir des politiques, des exemples et des meilleures pratiques utiles en matière de pilote Java lors de l'utilisation du pilote Java avec Amazon Keyspaces :. https://github.com/aws-samples/amazon-keyspaces-java-driver-helpers

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Utilisation d'un pilote client Cassandra

Utilisation d'un pilote client Cassandra Python

Utilisation d'un pilote client Cassandra Java pour accéder à Amazon Keyspaces par programmation

Note

Note

Rubriques

Avant de commencer

Note

Un tep-by-step tutoriel pour se connecter à Amazon Keyspaces à l'aide du pilote DataStax Java pour Apache Cassandra à l'aide d'informations d'identification spécifiques au service

Rubriques

Étape 1 : Prérequis

Étape 2 : Configuration du pilote

Note

Note

Étape 3 : Exécuter l'exemple d'application

Note

Un tep-by-step tutoriel pour se connecter à Amazon Keyspaces à l'aide du pilote DataStax Java 4.x pour Apache Cassandra et du plugin d'authentification SigV4

Étape 1 : Prérequis

Important

Étape 2 : Configuration du pilote

Note

Étape 3 : Exécuter l'application

Note

Connectez-vous à Amazon Keyspaces à l'aide du pilote DataStax Java 3.x pour Apache Cassandra et du plugin d'authentification SigV4

Étape 1 : Prérequis

Étape 2 : Exécuter l'application