Controlador Amazon QLDB para Java

Para trabajar con los datos de su libro mayor, puede conectarse a Amazon QLDB desde su aplicación java mediante un controlador proporcionado por AWS. En los siguientes temas se describe cómo empezar a usar el controlador QLDB para Java.

Temas

• Recursos de controladores
• Requisitos previos
• Configurar la región y las credenciales AWS predeterminadas
• Instalación
• Tutorial de inicio rápido
• Referencia de libro de recetas

Recursos de controladores

Para obtener más información sobre la funcionalidad compatible con el controlador Java, consulte los siguientes recursos:

• Referencia de API: 2.x, 1.x

• Código fuente del controlador (GitHub)

• Ejemplo de código fuente de aplicación (GitHub)

• Marco de carga de libros mayores (GitHub)

• Ejemplos de código de Amazon Ion

Requisitos previos

Antes de empezar a usar el controlador QLDB para Java, debe hacer lo siguiente:

1. Siga las instrucciones de configuración de AWS en Acceso a Amazon QLDB. Estas incluyen las siguientes:

   1. Regístrese en AWS.

   2. Cree un usuario con los permisos de QLDB adecuados.

   3. Conceda acceso programático de desarrollo.

2. Configure un entorno de desarrollo Java descargando e instalando lo siguiente:

   1. Kit de desarrollo Java SE 8, como Amazon Corretto 8.

   2. (Opcional) Entorno de desarrollo integrado (IDE) Java de su elección, como Eclipse o IntelliJ.

3. Configurar el entorno de desarrollo para AWS SDK for Java Configurar la región y las credenciales AWS predeterminadas:

A continuación, puede descargar la aplicación de ejemplo completa del tutorial, o bien instalar solo el controlador en un proyecto de Java y ejecutar ejemplos de códigos cortos.

• Para instalar el controlador QLDB y el AWS SDK for Java en un proyecto existente, acceda a Instalación.

• Para configurar un proyecto y ejecutar ejemplos de códigos cortos que muestren las transacciones de datos básicas en un libro mayor, consulte Tutorial de inicio rápido.

• Para ver ejemplos más detallados de las operaciones de la API de datos y administración en la aplicación de ejemplo completa del tutorial, consulte Tutorial de Java.

Configurar la región y las credenciales AWS predeterminadas

El controlador QLDB y el AWS SDK for Java subyacente requieren que proporcione las credenciales de AWS a su aplicación en tiempo de ejecución. En los ejemplos de código de esta guía se supone que se usa un archivo de credenciales de AWS, tal como se describe en Configuración de las credenciales y la región predeterminadas en la Guía para desarrolladores de AWS SDK for Java 2.x.

Como parte de estos pasos, también debe establecer su valor predeterminado Región de AWS para determinar su punto de conexión de QLDB predeterminado. Los ejemplos de código se conectan a QLDB en su Región de AWS predeterminada. Para ver una lista completa de las regiones donde QLDB está disponible, consulte Puntos de conexión y cuotas de Amazon QLDB en Referencia general de AWS.

A continuación se muestra un ejemplo de archivo de credenciales de AWS denominado ~/.aws/credentials, donde el carácter de tilde (~) representa su directorio de inicio.

[default] 
aws_access_key_id = your_access_key_id
aws_secret_access_key = your_secret_access_key

Cambie los valores de las credenciales de AWS por los valores your_access_key_id y your_secret_access_key.

Instalación

QLDB es compatible con las siguientes versiones de controlador y sus dependencias de SDK de AWS.

Versión de controlador	SDK de AWS	Estado	Fecha de lanzamiento más reciente
1.x	AWS SDK for Java 1.x	Lanzamiento de producción	20 de marzo de 2020
2.x	AWS SDK for Java 2.x	Lanzamiento de producción	4 de junio de 2021

Para instalar el controlador QLDB, se recomienda utilizar un sistema de administración de dependencias, como Gradle o Maven. Por ejemplo, añada el artefacto siguiente como dependencia en su proyecto Java.

2.x

Gradle

Agregue esta dependencia a su archivo de configuración build.gradle.

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

Maven

Agregue esta dependencia a su archivo de configuración pom.xml.

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

Este artefacto incluye automáticamente el módulo principal AWS SDK for Java 2.x, las bibliotecas de Amazon Ion y otras dependencias necesarias.

1.x

Gradle

Agregue esta dependencia a su archivo de configuración build.gradle.

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

Maven

Agregue esta dependencia a su archivo de configuración pom.xml.

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

Este artefacto incluye automáticamente el módulo principal AWS SDK for Java, las bibliotecas de Amazon Ion y otras dependencias necesarias.

importante

Espacio de nombres de Amazon Ion: al importar las clases de Amazon Ion a su aplicación, debe usar el paquete que se encuentra debajo del espacio de nombres com.amazon.ion. AWS SDK for Java depende de otro paquete de Ion en el espacio de nombres software.amazon.ion, pero se trata de un paquete heredado que no es compatible con el controlador QLDB.

Para ver ejemplos de códigos cortos sobre cómo ejecutar transacciones de datos básicos en un libro mayor, consulte la Referencia de libro de recetas.

Otras bibliotecas opcionales

Si lo desea, también puede agregar las bibliotecas útiles siguientes al proyecto. Estos artefactos son dependencias obligatorias en la aplicación de muestra Tutorial de Java.

1. aws-java-sdk-qldb: el módulo QLDB del AWS SDK for Java. La versión de QLDB mínima compatible actualmente es 1.11.785.

   Utilice este módulo en su aplicación para interactuar directamente con las operaciones de la API de administración que se enumeran en Referencia de la API de Amazon QLDB.

2. jackson-dataformat-ion: el módulo de formato de datos Jackson de FasterXML para Ion. La aplicación de ejemplo requiere una versión 2.10.0 o posterior.

Gradle

Agregue estas dependencias a su archivo de configuración 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

Agregue estas dependencias a su archivo de configuración 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>