Driver Amazon QLDB para Java

Para trabalhar com dados em seu ledger, você pode se conectar ao Amazon QLDB a partir do seu aplicativo Java usando um driver AWS fornecido. Os tópicos a seguir descrevem como começar a usar o driver QLDB para Java.

Tópicos

• Recursos para driver
• Pré-requisitos
• Configurando suas credenciais AWS e região padrão
• Instalação
• Tutorial de início rápido
• Referência de Cookbook

Recursos para driver

Para obter mais informações sobre a funcionalidade suportada pelo driver Java, consulte os recursos a seguir:

• Referência da API: 2.x, 1.x

• Código-fonte do driver (GitHub)

• Código-fonte da aplicação de exemplo (GitHub)

• Estrutura do carregador do ledger (GitHub)

• Exemplos de código do Amazon Ion

Pré-requisitos

Antes de começar a usar o driver QLDB para Java, você deverá fazer o seguinte:

1. Siga as instruções de configuração AWS no Acessar o Amazon QLDB. Essa transmissão inclui o seguinte:

   1. Cadastre-se no AWS.

   2. Crie um usuário com as permissões adequadas para QLDB.

   3. Conceda acesso programático para desenvolvimento.

2. Configure um ambiente de desenvolvimento Java baixando e instalando o seguinte:

   1. Java SE Development Kit 8, como o Amazon Corretto 8.

   2. (Opcional) Ambiente de desenvolvimento integrado (IDE) Java de sua escolha, como Eclipse ou IntelliJ.

3. Configurar seu ambiente de desenvolvimento para AWS SDK for Java por Configurando suas credenciais AWS e região padrão.

Em seguida, você pode baixar o aplicativo completo de amostra do tutorial ou instalar somente o driver em um projeto Java e executar exemplos de códigos curtos.

• Para instalar o driver QLDB e AWS SDK for Java o em um projeto existente, vá para Instalação.

• Para configurar um projeto e executar exemplos de códigos curtos que demonstram transações básicas de dados em um ledger, consulte o Tutorial de início rápido.

• Para executar exemplos mais detalhados das operações da API de dados e gerenciamento no aplicativo de amostra completo do tutorial, consulte Tutorial de Java.

Configurando suas credenciais AWS e região padrão

O driver QLDB e o AWS SDK for Java subjacente exigem que você forneça credenciais da AWS para seu aplicativo em runtime. Os exemplos de código neste guia pressupõem que você esteja usando um arquivo de credenciais AWS, conforme descrito em Configurar credenciais e região padrão no Guia do desenvolvedor da AWS SDK for Java 2.x.

Como parte dessas etapas, você também deve definir seu Região da AWS padrão para determinar seu endpoint QLDB padrão. Os exemplos de código se conectam ao QLDB em seu Região da AWS padrão. Para obter uma lista completa das regiões nas quais o QLDB está disponível, consulte endpoints e cotas Amazon QLDB em Referência geral da AWS.

Veja a seguir um exemplo de um arquivo de credenciais da AWS chamado ~/.aws/credentials em que o caractere de til (~) representa seu diretório inicial.

[default] 
aws_access_key_id = your_access_key_id
aws_secret_access_key = your_secret_access_key

Substitua os próprios valores de credenciais AWS da AWS pelos valores your_access_key_id e your_secret_access_key.

Instalação

O QLDB suporta as seguintes versões do driver Java e suas dependências do SDK AWS.

Versão do driver	AWS SDK	Status	Data da versão mais recente
1.x	AWS SDK for Java 1.x	Lançamento de produção	20 de março de 2020
2.x	AWS SDK for Java 2.x	Lançamento de produção	04 de junho de 2021

Para instalar o driver QLDB, recomendamos usar um sistema de gerenciamento de dependências, como o Gradle ou o Maven. Por exemplo, adicione o artefato a seguir como uma dependência no seu projeto Java.

2.x

Gradle

Adicione essa dependência ao seu arquivo build.gradle de configuração.

dependencies {
    compile group: 'software.amazon.qldb', name: 'amazon-qldb-driver-java', version: '2.3.1'
}

Maven

Adicione essa dependência ao seu arquivo pom.xml de configuração.

<dependencies>
  <dependency>
    <groupId>software.amazon.qldb</groupId>
    <artifactId>amazon-qldb-driver-java</artifactId>
    <version>2.3.1</version>
  </dependency>
</dependencies>

Esse artefato inclui automaticamente o módulo AWS SDK for Java 2.x principal, as bibliotecas Amazon Ion e outras dependências necessárias.

1.x

Gradle

Adicione essa dependência ao seu arquivo build.gradle de configuração.

dependencies {
    compile group: 'software.amazon.qldb', name: 'amazon-qldb-driver-java', version: '1.1.0'
}

Maven

Adicione essa dependência ao seu arquivo pom.xml de configuração.

<dependencies>
  <dependency>
    <groupId>software.amazon.qldb</groupId>
    <artifactId>amazon-qldb-driver-java</artifactId>
    <version>1.1.0</version>
  </dependency>
</dependencies>

Esse artefato inclui automaticamente o módulo AWS SDK for Java principal, as bibliotecas Amazon Ion e outras dependências necessárias.

Importante

Namespace Amazon Ion — Ao importar classes Amazon Ion em seu aplicativo, você deve usar o pacote que está sob o namespacecom.amazon.ion. O AWS SDK for Java depende de outro pacote Ion no namespace software.amazon.ion, mas esse é um pacote legado que não é compatível com o driver QLDB.

Para exemplos de código curto de como executar transações básicas de dados em um ledger, consulte o Referência de Cookbook.

Outras bibliotecas opcionais

Como opção, adicione também as seguintes bibliotecas úteis ao seu projeto. Esses artefatos são dependências obrigatórias no aplicativo Tutorial de Java de amostra.

1. aws-java-sdk-qldb — O módulo QLDB do AWS SDK for Java. A versão mínima compatível do QLDB é 1.11.785.

   Use esse módulo em seu aplicativo para interagir diretamente com as operações da API de gerenciamento listadas no Referência da API do Amazon QLDB.

2. jackson-dataformat-ion — Módulo de formato de dados Jackson do FasterXML para Ion. O aplicativo de amostra requer uma versão 2.10.0 ou posterior.

Gradle

Adicione essas dependências ao seu arquivo de configuração build.gradle.

dependencies {
    compile group: 'com.amazonaws', name: 'aws-java-sdk-qldb', version: '1.11.785'
    compile group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-ion', version: '2.10.0'
}

Maven

Adicione essas dependências ao seu arquivo de configuração pom.xml.

<dependencies>
  <dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-java-sdk-qldb</artifactId>
    <version>1.11.785</version>
  </dependency>
  <dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-ion</artifactId>
    <version>2.10.0</version>
  </dependency>
</dependencies>