As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Como usar um driver de cliente Java Cassandra para acessar o Amazon Keyspaces programaticamente
Esta seção mostra como se conectar ao Amazon Keyspaces usando um driver de cliente Java.
nota
Atualmente, o Java 17 e o DataStax Java Driver 4.17 estão apenas em suporte Beta. Para ter mais informações, consulte https://docs.datastax.com/en/developer/java-driver/4.17/upgrade_guide/
Para fornecer aos usuários e aplicativos credenciais para acesso programático aos recursos do Amazon Keyspaces, você pode executar uma das seguintes ações:
-
Criar credenciais específicas do serviço associadas a um usuário específico AWS Identity and Access Management (IAM).
-
Para aumentar a segurança, recomendamos criar chaves de acesso do IAM para identidades do IAM que são usadas em todos os AWS serviços. O plug-in de autenticação SigV4 do Amazon Keyspaces para drivers de clientes do Cassandra permite que você autentique chamadas para o Amazon Keyspaces usando chaves de acesso do IAM em vez de nome de usuário e senha. Para ter mais informações, consulte Como criar e configurar AWS credenciais para o Amazon Keyspaces.
nota
Para obter um exemplo de como usar o Amazon Keyspaces com o Spring Boot, consulte https://github.com/aws-samples/amazon-keyspaces-examples/tree/main/java/datastax-v4/spring
Tópicos
- Antes de começar
- Um tep-by-step tutorial para se conectar ao Amazon Keyspaces usando o driver DataStax Java para Apache Cassandra usando credenciais específicas do serviço
- Um tep-by-step tutorial para se conectar ao Amazon Keyspaces usando o driver DataStax Java 4.x para Apache Cassandra e o plug-in de autenticação SigV4
- Conecte-se ao Amazon Keyspaces usando o driver DataStax Java 3.x para Apache Cassandra e o plug-in de autenticação SigV4
Antes de começar
Para se conectar ao Amazon Keyspaces, você precisa concluir as seguintes tarefas antes de começar.
O Amazon Keyspaces requer o uso do Transport Layer Security (TLS) para ajudar a proteger as conexões com os clientes.
Faça o download do certificado digital Starfield usando o comando a seguir e salve
sf-class2-root.crt
localmente ou em seu diretório inicial.curl https://certs.secureserver.net/repository/sf-class2-root.crt -O
nota
Você também pode usar o certificado digital da Amazon para se conectar ao Amazon Keyspaces e continuar fazendo isso se seu cliente estiver se conectando ao Amazon Keyspaces com sucesso. O certificado Starfield fornece compatibilidade adicional com versões anteriores para clientes que usam autoridades de certificação mais antigas.
Converta o certificado digital Starfield em um arquivo 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
Nesta etapa, você precisa criar uma senha para o repositório de chaves e confiar nesse certificado. O comando interativo tem a aparência a seguir.
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
-
Anexe o arquivo trustStore nos argumentos da JVM:
-Djavax.net.ssl.trustStore=
path_to_file
/cassandra_truststore.jks -Djavax.net.ssl.trustStorePassword=my_password
Um tep-by-step tutorial para se conectar ao Amazon Keyspaces usando o driver DataStax Java para Apache Cassandra usando credenciais específicas do serviço
O step-by-step tutorial a seguir mostra como se conectar ao Amazon Keyspaces usando um driver Java para Cassandra usando credenciais específicas do serviço. Especificamente, você usará a versão 4.0 do driver DataStax Java para o Apache Cassandra.
Etapa 1: pré-requisitos
Para seguir este tutorial, você precisa gerar credenciais específicas do serviço e adicionar o driver DataStax Java para Apache Cassandra ao seu projeto Java.
Gere credenciais específicas do serviço para seu usuário do IAM do Amazon Keyspaces concluindo as etapas em Gerar credenciais específicas do serviço. Se preferir usar as chaves de acesso do IAM para autenticação, consulte Um tep-by-step tutorial para se conectar ao Amazon Keyspaces usando o driver DataStax Java 4.x para Apache Cassandra e o plug-in de autenticação SigV4.
Adicione o driver DataStax Java para Apache Cassandra ao seu projeto Java. Verifique se está usando uma versão do driver compatível com o Apache Cassandra 3.11.2. Para obter mais informações, consulte a documentação do driver DataStax Java para Apache Cassandra
.
Etapa 2: configurar o driver
Você pode especificar as configurações do driver DataStax Java Cassandra criando um arquivo de configuração para seu aplicativo. Esse arquivo de configuração substitui as configurações padrão e instrui o driver a se conectar ao endpoint do serviço Amazon Keyspaces usando a porta 9142. Para obter uma lista de endpoints de serviço, consulte Endpoints de serviço para Amazon Keyspaces.
Crie um arquivo de configuração e salve-o na pasta de recursos do aplicativo — por exemplo, src/main/resources/application.conf
. Abra application.conf
e adicione as seguintes configurações.
Provedor de autenticação: crie o provedor de autenticação com a
PlainTextAuthProvider
classe. ServiceUserOnome
eServicePassword
deve corresponder ao nome de usuário e senha que você obteve ao gerar as credenciais específicas do serviço seguindo as etapas em. Gerar credenciais específicas do serviçonota
Você pode usar credenciais de curto prazo usando o plug-in de autenticação do driver DataStax Java para Apache Cassandra em vez de credenciais codificadas no arquivo de configuração do driver. Para saber mais, siga as instruções do Um tep-by-step tutorial para se conectar ao Amazon Keyspaces usando o driver DataStax Java 4.x para Apache Cassandra e o plug-in de autenticação SigV4.
Datacenter local: defina o valor
local-datacenter
para a região à qual você está se conectando. Por exemplo, se o aplicativo estiver se conectando acassandra.us-east-2.amazonaws.com
, defina o datacenter local comous-east-2
. Para saber todas as Regiões da AWS disponíveis, consulte Endpoints de serviço para Amazon Keyspaces. Definaslow-replica-avoidance = false
para balancear a carga em relação a menos nós.SSL/TLS — Inicialize o SSL EngineFactory adicionando uma seção no arquivo de configuração com uma única linha que especifica a classe com.
class = DefaultSslEngineFactory
Forneça o caminho para o arquivo trustStore e a senha que você criou anteriormente. O Amazon Keyspaces não oferece suportehostname-validation
a pares, então defina essa opção como 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
Em vez de adicionar o caminho para o trustStore no arquivo de configuração, você também pode adicioná-lo diretamente no código do aplicativo ou aos seus argumentos da JVM.
Etapa 3: executar o aplicativo de exemplo
Este exemplo de código mostra um aplicativo de linha de comando simples que cria um pool de conexões com o Amazon Keyspaces usando o arquivo de configuração que criamos anteriormente. Ele confirma que a conexão foi estabelecida executando uma consulta simples.
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
Use um try
bloco para estabelecer a conexão e garantir que ela esteja sempre fechada. Se você não usa um try
bloco, lembre-se de fechar sua conexão para evitar o vazamento de recursos.
Um tep-by-step tutorial para se conectar ao Amazon Keyspaces usando o driver DataStax Java 4.x para Apache Cassandra e o plug-in de autenticação SigV4
A seção a seguir descreve como usar o plug-in de autenticação SigV4 para o driver DataStax Java 4.x de código aberto do Apache Cassandra para acessar o Amazon Keyspaces (para o Apache Cassandra). O plug-in está disponível no GitHubrepositório.
O plug-in de autenticação SigV4 permite que você use credenciais do IAM para usuários ou perfis ao se conectar ao Amazon Keyspaces. Em vez de exigir um nome de usuário e senha, esse plug-in assina solicitações de API usando chaves de acesso. Para ter mais informações, consulte Como criar e configurar AWS credenciais para o Amazon Keyspaces.
Etapa 1: pré-requisitos
Para seguir este tutorial, você precisa concluir as tarefas a seguir.
Se ainda não tiver feito isso, crie credenciais para o usuário do IAM ou o perfil do IAM seguindo as etapas em Como criar e configurar AWS credenciais para o Amazon Keyspaces. Este tutorial pressupõe que as chaves de acesso sejam armazenadas como variáveis de ambiente. Para ter mais informações, consulte Como gerenciar chaves de acesso para usuários do IAM.
Adicione o driver DataStax Java para Apache Cassandra ao seu projeto Java. Verifique se está usando uma versão do driver compatível com o Apache Cassandra 3.11.2. Para obter mais informações, consulte a documentação do driver DataStax Java para Apache Cassandra
. Adicione o plug-in de autenticação ao seu aplicativo. O plug-in de autenticação suporta a versão 4.x do driver DataStax Java para Apache Cassandra. Se estiver usando o Apache Maven ou um sistema de compilação que pode usar dependências do Maven, adicione as seguintes dependências ao seu arquivo
pom.xml
.Importante
Substitua a versão do plug-in pela versão mais recente, conforme mostrado no GitHub repositório
. <dependency> <groupId>software.aws.mcs</groupId> <artifactId>aws-sigv4-auth-cassandra-java-driver-plugin</artifactId> <version>
4.0.9
</version> </dependency>
Etapa 2: configurar o driver
Você pode especificar as configurações do driver DataStax Java Cassandra criando um arquivo de configuração para seu aplicativo. Esse arquivo de configuração substitui as configurações padrão e instrui o driver a se conectar ao endpoint do serviço Amazon Keyspaces usando a porta 9142. Para obter uma lista de endpoints de serviço, consulte Endpoints de serviço para Amazon Keyspaces.
Crie um arquivo de configuração e salve-o na pasta de recursos do aplicativo — por exemplo, src/main/resources/application.conf
. Abra application.conf
e adicione as seguintes configurações.
Provedor de autenticação: defina o
advanced.auth-provider.class
para uma nova instância desoftware.aws.mcs.auth.SigV4AuthProvider
. O SigV4 AuthProvider é o manipulador de autenticação fornecido pelo plug-in para realizar a autenticação SigV4.Datacenter local: defina o valor
local-datacenter
para a região à qual você está se conectando. Por exemplo, se o aplicativo estiver se conectando acassandra.us-east-2.amazonaws.com
, defina o datacenter local comous-east-2
. Para todos os disponíveis Regiões da AWS, consulteEndpoints de serviço para Amazon Keyspaces.slow-replica-avoidance = false
Defina para balancear a carga em relação a todos os nós disponíveis.Idempotência — Defina o padrão
idempotence
para que o aplicativo configure o driver para sempre repetir as solicitaçõestrue
de leitura/gravação/preparação/execução com falha. Essa é uma prática recomendada para aplicativos distribuídos que ajuda a lidar com falhas transitórias ao tentar novamente solicitações com falha.SSL/TLS — Inicialize o SSL EngineFactory adicionando uma seção no arquivo de configuração com uma única linha que especifica a classe com.
class = DefaultSslEngineFactory
Forneça o caminho para o arquivo trustStore e a senha que você criou anteriormente. O Amazon Keyspaces não oferece suportehostname-validation
a pares, então defina essa opção como false.Conexões — Crie pelo menos 3 conexões locais por endpoint
local.size = 3
configurando. Essa é uma prática recomendada que ajuda seu aplicativo a lidar com sobrecarga e picos de tráfego. Para obter mais informações sobre como calcular quantas conexões locais por endpoint seu aplicativo precisa com base nos padrões de tráfego esperados, consulteComo configurar conexões no Amazon Keyspaces.Política de repetição — A
AmazonKeyspacesExponentialRetryPolicy
política de repetição do Amazon Keyspaces é uma alternativa à que vem comDefaultRetryPolicy
o driver Cassandra. A principal diferença entre as duas políticas de repetição é que você pode configurar a quantidade de tentativas de repetição para atenderAmazonKeyspacesExponentialRetryPolicy
às suas necessidades. Por padrão, o número de tentativas de repetição doAmazonKeyspacesExponentialRetryPolicy
é definido como 3. Além disso, a política de repetição do Amazon Keyspaces não retorna o genérico.NoHostAvailableException
Em vez disso, a política de repetição do Amazon Keyspaces devolve a exceção original retornada pelo serviço. Para obter mais exemplos de código que implementam políticas de repetição, consulte as políticas de repetição do Amazon Keyspaces no Github. Declarações preparadas —
prepare-on-all-nodes
Defina como false para otimizar o uso da rede.
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
Em vez de adicionar o caminho para o trustStore no arquivo de configuração, você também pode adicioná-lo diretamente no código do aplicativo ou aos seus argumentos da JVM.
Etapa 3: executar o aplicativo
Este exemplo de código mostra um aplicativo de linha de comando simples que cria um pool de conexões com o Amazon Keyspaces usando o arquivo de configuração que criamos anteriormente. Ele confirma que a conexão foi estabelecida executando uma consulta simples.
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
Use um try
bloco para estabelecer a conexão e garantir que ela esteja sempre fechada. Se você não usa um try
bloco, lembre-se de fechar sua conexão para evitar o vazamento de recursos.
Conecte-se ao Amazon Keyspaces usando o driver DataStax Java 3.x para Apache Cassandra e o plug-in de autenticação SigV4
A seção a seguir descreve como usar o plug-in de autenticação SigV4 para o driver DataStax Java de código aberto 3.x para o Apache Cassandra acessar o Amazon Keyspaces. O plug-in está disponível no GitHub repositório.
O plug-in de autenticação SigV4 permite que você use credenciais do IAM para usuários e perfis ao se conectar ao Amazon Keyspaces. Em vez de exigir um nome de usuário e senha, esse plug-in assina solicitações de API usando chaves de acesso. Para ter mais informações, consulte Como criar e configurar AWS credenciais para o Amazon Keyspaces.
Etapa 1: pré-requisitos
Para executar esse exemplo de código, primeiro você precisa concluir as tarefas a seguir.
Crie credenciais para seu usuário do IAM ou perfil do IAM seguindo as etapas em Como criar e configurar AWS credenciais para o Amazon Keyspaces. Este tutorial pressupõe que as chaves de acesso sejam armazenadas como variáveis de ambiente. Para ter mais informações, consulte Como gerenciar chaves de acesso para usuários do IAM.
Siga as etapas em Antes de começar para baixar o certificado digital Starfield, convertê-lo em um arquivo trustStore e anexar o arquivo trustStore nos argumentos da JVM ao seu aplicativo.
Adicione o driver DataStax Java para Apache Cassandra ao seu projeto Java. Verifique se está usando uma versão do driver compatível com o Apache Cassandra 3.11.2. Para obter mais informações, consulte a documentação do driver DataStax Java para Apache Cassandra
. Adicione o plug-in de autenticação ao seu aplicativo. O plug-in de autenticação suporta a versão 3.x do driver DataStax Java para Apache Cassandra. Se estiver usando o Apache Maven ou um sistema de compilação que pode usar dependências do Maven, adicione as seguintes dependências ao seu arquivo
pom.xml
. Substitua a versão do plug-in pela versão mais recente, conforme mostrado no GitHub repositório. <dependency> <groupId>software.aws.mcs</groupId> <artifactId>aws-sigv4-auth-cassandra-java-driver-plugin_3</artifactId> <version>
3.0.3
</version> </dependency>
Etapa 2: executar o aplicativo
Este exemplo de código mostra um aplicativo de linha de comando simples que cria um pool de conexões com o Amazon Keyspaces. Ele confirma que a conexão foi estabelecida executando uma consulta simples.
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")); } }
Observações de uso:
Para obter uma lista de endpoints disponíveis, consulte Endpoints de serviço para Amazon Keyspaces.
Consulte o seguinte repositório para políticas úteis de drivers Java, exemplos, e melhores práticas ao usar o driver Java com o Amazon Keyspaces: https://github.com/aws-samples/amazon-keyspaces-java-driver-helpers