Prima di iniziare Utilizzo del driver Java DataStax Plugin di autenticazione per Java 4.x Plugin di autenticazione per Java 3.x

Utilizzo di un driver client Java Cassandra per accedere ad Amazon Keyspaces a livello di programmazione

Questa sezione mostra come connettersi ad Amazon Keyspaces utilizzando un driver client Java.

Nota

Java 17 e DataStax Java Driver 4.17 sono attualmente supportati solo in versione beta. Per ulteriori informazioni, consulta https://docs.datastax.com/en/developer/java-driver/4.17/upgrade_guide/.

Per fornire agli utenti e alle applicazioni le credenziali per l'accesso programmatico alle risorse di Amazon Keyspaces, puoi effettuare una delle seguenti operazioni:

Crea credenziali specifiche del servizio associate a un utente specifico (IAM). AWS Identity and Access Management
Per una maggiore sicurezza, consigliamo di creare chiavi di accesso IAM per le identità IAM utilizzate in tutti i servizi. AWS Il plug-in di autenticazione Amazon Keyspaces SigV4 per i driver client Cassandra consente di autenticare le chiamate ad Amazon Keyspaces utilizzando chiavi di accesso IAM anziché nome utente e password. Per ulteriori informazioni, consulta Come creare e configurare AWS credenziali per Amazon Keyspaces.

Nota

Per un esempio di come usare Amazon Keyspaces con Spring Boot, vedi. https://github.com/aws-samples/amazon-keyspaces-examples/tree/main/java/datastax-v4/spring

Argomenti

Prima di iniziare
Un tep-by-step tutorial per connettersi ad Amazon Keyspaces utilizzando il driver DataStax Java per Apache Cassandra utilizzando credenziali specifiche del servizio
Un tep-by-step tutorial per connettersi ad Amazon Keyspaces utilizzando il driver DataStax Java 4.x per Apache Cassandra e il plug-in di autenticazione SigV4
Connect ad Amazon Keyspaces utilizzando il driver DataStax Java 3.x per Apache Cassandra e il plug-in di autenticazione SigV4

Prima di iniziare

Per connetterti ad Amazon Keyspaces, devi completare le seguenti attività prima di iniziare.

Amazon Keyspaces richiede l'uso di Transport Layer Security (TLS) per proteggere le connessioni con i client.

Scarica il certificato digitale Starfield utilizzando il seguente comando e salvalo sf-class2-root.crt localmente o nella tua home directory.
```
curl https://certs.secureserver.net/repository/sf-class2-root.crt -O
```
Nota
Puoi anche utilizzare il certificato digitale Amazon per connetterti ad Amazon Keyspaces e puoi continuare a farlo se il tuo client si connette ad Amazon Keyspaces con successo. Il certificato Starfield offre un'ulteriore compatibilità con le versioni precedenti per i client che utilizzano autorità di certificazione precedenti.

Converti il certificato digitale Starfield in un file 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

In questo passaggio, è necessario creare una password per il keystore e considerare attendibile questo certificato. Il comando interattivo ha il seguente aspetto.


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

Allega il file TrustStore negli argomenti JVM:


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

Un tep-by-step tutorial per connettersi ad Amazon Keyspaces utilizzando il driver DataStax Java per Apache Cassandra utilizzando credenziali specifiche del servizio

Il seguente step-by-step tutorial illustra come connettersi ad Amazon Keyspaces utilizzando un driver Java per Cassandra utilizzando credenziali specifiche del servizio. In particolare, utilizzerai la versione 4.0 del driver DataStax Java per Apache Cassandra.

Fase 1: prerequisiti

Per seguire questo tutorial, è necessario generare credenziali specifiche del servizio e aggiungere il driver DataStax Java per Apache Cassandra al progetto Java.

Genera credenziali specifiche del servizio per il tuo utente IAM di Amazon Keyspaces completando i passaggi indicati in. Genera credenziali specifiche per il servizio Se preferisci utilizzare le chiavi di accesso IAM per l'autenticazione, consulta. Un tep-by-step tutorial per connettersi ad Amazon Keyspaces utilizzando il driver DataStax Java 4.x per Apache Cassandra e il plug-in di autenticazione SigV4
Aggiungi il driver DataStax Java per Apache Cassandra al tuo progetto Java. Assicurati di utilizzare una versione del driver che supporti Apache Cassandra 3.11.2. Per ulteriori informazioni, consulta la documentazione del driver DataStax Java per Apache Cassandra.

Fase 2: Configurare il driver

È possibile specificare le impostazioni per il driver DataStax Java Cassandra creando un file di configurazione per l'applicazione. Questo file di configurazione sostituisce le impostazioni predefinite e indica al driver di connettersi all'endpoint del servizio Amazon Keyspaces utilizzando la porta 9142. Per un elenco degli endpoint di servizio disponibili, consulta. Endpoint di servizio per Amazon Keyspaces

Create un file di configurazione e salvatelo nella cartella delle risorse dell'applicazione, ad esempio. src/main/resources/application.conf Apri application.conf e aggiungi le seguenti impostazioni di configurazione.

Provider di autenticazione: crea il provider di autenticazione con la PlainTextAuthProvider classe. ServiceUserIl nome e la password ServicePassworddevono corrispondere al nome utente e alla password ottenuti al momento della generazione delle credenziali specifiche del servizio seguendo la procedura riportata di seguito. Genera credenziali specifiche per il servizio

Nota
È possibile utilizzare credenziali a breve termine utilizzando il plug-in di autenticazione per il driver DataStax Java per Apache Cassandra anziché codificare le credenziali nel file di configurazione del driver. Per ulteriori informazioni, segui le istruzioni per. Un tep-by-step tutorial per connettersi ad Amazon Keyspaces utilizzando il driver DataStax Java 4.x per Apache Cassandra e il plug-in di autenticazione SigV4
Data center locale: imposta il valore per la regione local-datacenter a cui ti stai connettendo. Ad esempio, se l'applicazione si connette acassandra.us-east-2.amazonaws.com, imposta il data center locale suus-east-2. Per tutte le opzioni disponibili Regioni AWS, vediEndpoint di servizio per Amazon Keyspaces. Impostato slow-replica-avoidance = false per bilanciare il carico su un minor numero di nodi.
SSL/TLS: inizializza l'SSL EngineFactory aggiungendo una sezione nel file di configurazione con una sola riga che specifica la classe con. class = DefaultSslEngineFactory Fornisci il percorso del file TrustStore e la password che hai creato in precedenza. Amazon Keyspaces non supporta hostname-validation i peer, quindi imposta questa opzione su 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
      }
}

Nota

Invece di aggiungere il percorso al TrustStore nel file di configurazione, puoi anche aggiungere il percorso TrustStore direttamente nel codice dell'applicazione oppure puoi aggiungere il percorso al TrustStore agli argomenti JVM.

Fase 3: Esegui l'applicazione di esempio

Questo esempio di codice mostra una semplice applicazione a riga di comando che crea un pool di connessioni ad Amazon Keyspaces utilizzando il file di configurazione creato in precedenza. Conferma che la connessione è stata stabilita eseguendo una semplice query.


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"));
        }
    }
}

Nota

Usa un try blocco per stabilire la connessione per assicurarti che sia sempre chiusa. Se non usi un try blocco, ricordati di chiudere la connessione per evitare perdite di risorse.

Un tep-by-step tutorial per connettersi ad Amazon Keyspaces utilizzando il driver DataStax Java 4.x per Apache Cassandra e il plug-in di autenticazione SigV4

La sezione seguente descrive come utilizzare il plug-in di autenticazione SigV4 per il driver DataStax Java 4.x open source per Apache Cassandra per accedere ad Amazon Keyspaces (per Apache Cassandra). Il plugin è disponibile nel repository. GitHub

Il plug-in di autenticazione SigV4 consente di utilizzare le credenziali IAM per utenti o ruoli durante la connessione ad Amazon Keyspaces. Invece di richiedere un nome utente e una password, questo plugin firma le richieste API utilizzando le chiavi di accesso. Per ulteriori informazioni, consulta Come creare e configurare AWS credenziali per Amazon Keyspaces.

Fase 1: prerequisiti

Per seguire questo tutorial, devi completare le seguenti attività.

Se non l'hai già fatto, crea le credenziali per il tuo utente o ruolo IAM seguendo la procedura riportata qui. Come creare e configurare AWS credenziali per Amazon Keyspaces Questo tutorial presuppone che le chiavi di accesso siano memorizzate come variabili di ambiente. Per ulteriori informazioni, consulta Come gestire le chiavi di accesso per gli utenti IAM.
Aggiungi il driver DataStax Java per Apache Cassandra al tuo progetto Java. Assicurati di utilizzare una versione del driver che supporti Apache Cassandra 3.11.2. Per ulteriori informazioni, consulta la documentazione del driver DataStax Java per Apache Cassandra.
Aggiungi il plugin di autenticazione alla tua applicazione. Il plugin di autenticazione supporta la versione 4.x del driver DataStax Java per Apache Cassandra. Se utilizzi Apache Maven o un sistema di compilazione in grado di utilizzare le dipendenze Maven, aggiungi le seguenti dipendenze al tuo file. pom.xml

Importante
Sostituisci la versione del plugin con la versione più recente, come mostrato nel repository. GitHub
```
<dependency>
        <groupId>software.aws.mcs</groupId>
        <artifactId>aws-sigv4-auth-cassandra-java-driver-plugin</artifactId>
        <version>4.0.9</version>
</dependency>
```

Fase 2: Configurare il driver

Provider di autenticazione: imposta una nuova istanza disoftware.aws.mcs.auth.SigV4AuthProvider. advanced.auth-provider.class SigV4 AuthProvider è il gestore di autenticazione fornito dal plugin per eseguire l'autenticazione SigV4.
Data center locale: imposta il valore per la regione local-datacenter a cui ti stai connettendo. Ad esempio, se l'applicazione si connette acassandra.us-east-2.amazonaws.com, imposta il data center locale suus-east-2. Per tutte le opzioni disponibili Regioni AWS, vediEndpoint di servizio per Amazon Keyspaces. Impostato slow-replica-avoidance = false per bilanciare il carico rispetto a tutti i nodi disponibili.
Idempotenza: imposta l'impostazione predefinita idempotence per l'applicazione in modo da configurare il driver in modo che riprovi sempre le true richieste di lettura/scrittura/preparazione/esecuzione non riuscite. Si tratta di una procedura ottimale per le applicazioni distribuite che consente di gestire gli errori temporanei riprovando le richieste non riuscite.
SSL/TLS: inizializza l'SSL EngineFactory aggiungendo una sezione nel file di configurazione con una sola riga che specifica la classe con. class = DefaultSslEngineFactory Fornisci il percorso del file TrustStore e la password che hai creato in precedenza. Amazon Keyspaces non supporta hostname-validation i peer, quindi imposta questa opzione su false.
Connessioni: crea almeno 3 connessioni locali per endpoint impostando. local.size = 3 Si tratta di una best practice che aiuta l'applicazione a gestire i sovraccarichi e i picchi di traffico. Per ulteriori informazioni su come calcolare il numero di connessioni locali per endpoint necessarie all'applicazione in base ai modelli di traffico previsti, consulta. Come configurare le connessioni in Amazon Keyspaces
Politica di riprova: la AmazonKeyspacesExponentialRetryPolicy politica di riprova di Amazon Keyspaces è un'alternativa a quella fornita con DefaultRetryPolicy il driver Cassandra. La differenza principale tra le due politiche di nuovi tentativi è che puoi configurare il numero di tentativi di nuovo tentativo in base alle tue esigenze. AmazonKeyspacesExponentialRetryPolicy Per impostazione predefinita, il numero di tentativi di nuovo tentativo AmazonKeyspacesExponentialRetryPolicy è impostato su 3. Inoltre, la politica di riprova di Amazon Keyspaces non restituisce il codice generico. NoHostAvailableException Al contrario, la politica di riprova di Amazon Keyspaces restituisce l'eccezione originale restituita dal servizio. Per altri esempi di codice che implementano le politiche di ripetizione dei tentativi, consulta le politiche di riprova di Amazon Keyspaces su Github.
Dichiarazioni preparate: imposta su false prepare-on-all-nodes per ottimizzare l'utilizzo della rete.


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
       }
    }
}

Nota

Passaggio 3: Esegui l'applicazione


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"));
        }
    }
}

Nota

Usa un try blocco per stabilire la connessione per assicurarti che sia sempre chiusa. Se non usi un try blocco, ricordati di chiudere la connessione per evitare perdite di risorse.

Connect ad Amazon Keyspaces utilizzando il driver DataStax Java 3.x per Apache Cassandra e il plug-in di autenticazione SigV4

La sezione seguente descrive come utilizzare il plug-in di autenticazione SigV4 per il driver DataStax Java open source 3.x per Apache Cassandra per accedere ad Amazon Keyspaces. Il plugin è disponibile nel repository. GitHub

Il plug-in di autenticazione SigV4 consente di utilizzare le credenziali IAM per utenti e ruoli durante la connessione ad Amazon Keyspaces. Invece di richiedere un nome utente e una password, questo plugin firma le richieste API utilizzando le chiavi di accesso. Per ulteriori informazioni, consulta Come creare e configurare AWS credenziali per Amazon Keyspaces.

Fase 1: prerequisiti

Per eseguire questo esempio di codice, è necessario innanzitutto completare le seguenti attività.

Crea le credenziali per il tuo utente o ruolo IAM seguendo la procedura descritta inCome creare e configurare AWS credenziali per Amazon Keyspaces. Questo tutorial presuppone che le chiavi di accesso siano memorizzate come variabili di ambiente. Per ulteriori informazioni, consulta Come gestire le chiavi di accesso per gli utenti IAM.
Segui i passaggi indicati Prima di iniziare per scaricare il certificato digitale Starfield, convertirlo in un file TrustStore e allegare il file TrustStore negli argomenti JVM all'applicazione.
Aggiungi il driver DataStax Java per Apache Cassandra al tuo progetto Java. Assicurati di utilizzare una versione del driver che supporti Apache Cassandra 3.11.2. Per ulteriori informazioni, consulta la documentazione del driver DataStax Java per Apache Cassandra.
Aggiungi il plugin di autenticazione alla tua applicazione. Il plugin di autenticazione supporta la versione 3.x del driver DataStax Java per Apache Cassandra. Se utilizzi Apache Maven o un sistema di compilazione in grado di utilizzare le dipendenze Maven, aggiungi le seguenti dipendenze al tuo file. pom.xml Sostituisci la versione del plugin con la versione più recente, come mostrato nel repository. GitHub
```
<dependency>
        <groupId>software.aws.mcs</groupId>
        <artifactId>aws-sigv4-auth-cassandra-java-driver-plugin_3</artifactId>
        <version>3.0.3</version>
</dependency>
```

Fase 2: Esegui l'applicazione

Questo esempio di codice mostra una semplice applicazione a riga di comando che crea un pool di connessioni ad Amazon Keyspaces. Conferma che la connessione è stata stabilita eseguendo una semplice query.


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"));
    }
}

Note d'uso:

Per un elenco degli endpoint disponibili, vedereEndpoint di servizio per Amazon Keyspaces.

Consulta il seguente repository per utili politiche, esempi e best practice dei driver Java per l'utilizzo del driver Java con Amazon https://github.com/aws-samples/amazon-keyspaces-java-driver-helpers Keyspaces:.

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Utilizzo di un driver client Cassandra

Utilizzo di un driver client Cassandra Python

Utilizzo di un driver client Java Cassandra per accedere ad Amazon Keyspaces a livello di programmazione

Nota

Nota

Argomenti

Prima di iniziare

Nota

Un tep-by-step tutorial per connettersi ad Amazon Keyspaces utilizzando il driver DataStax Java per Apache Cassandra utilizzando credenziali specifiche del servizio

Argomenti

Fase 1: prerequisiti

Fase 2: Configurare il driver

Nota

Nota

Fase 3: Esegui l'applicazione di esempio

Nota

Un tep-by-step tutorial per connettersi ad Amazon Keyspaces utilizzando il driver DataStax Java 4.x per Apache Cassandra e il plug-in di autenticazione SigV4

Fase 1: prerequisiti

Importante

Fase 2: Configurare il driver

Nota

Passaggio 3: Esegui l'applicazione

Nota

Connect ad Amazon Keyspaces utilizzando il driver DataStax Java 3.x per Apache Cassandra e il plug-in di autenticazione SigV4

Fase 1: prerequisiti

Fase 2: Esegui l'applicazione