Skip to content

Add DynamoDB support for converting ARNs #3674

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/next-release/feature-AmazonDynamoDB-e9516e8.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "feature",
"category": "Amazon DynamoDB",
"contributor": "belugabehr",
"description": "Add support for converting ARNs"
}
5 changes: 5 additions & 0 deletions services-custom/dynamodb-enhanced/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,11 @@
<artifactId>dynamodb</artifactId>
<version>${awsjavasdk.version}</version>
</dependency>
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>arns</artifactId>
<version>${awsjavasdk.version}</version>
</dependency>
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>annotations</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.PrimitiveConverter;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.StringConverter;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.StringConverterProvider;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.ArnAttributeConverter;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.AtomicBooleanAttributeConverter;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.AtomicIntegerAttributeConverter;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.AtomicLongAttributeConverter;
Expand Down Expand Up @@ -208,6 +209,7 @@ private <T> AttributeConverter<T> createSetConverter(EnhancedType<T> type) {

private static Builder getDefaultBuilder() {
return DefaultAttributeConverterProvider.builder()
.addConverter(ArnAttributeConverter.create())
.addConverter(AtomicBooleanAttributeConverter.create())
.addConverter(AtomicIntegerAttributeConverter.create())
.addConverter(AtomicLongAttributeConverter.create())
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute;

import software.amazon.awssdk.annotations.Immutable;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.arns.Arn;
import software.amazon.awssdk.enhanced.dynamodb.AttributeConverter;
import software.amazon.awssdk.enhanced.dynamodb.AttributeValueType;
import software.amazon.awssdk.enhanced.dynamodb.EnhancedType;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.TypeConvertingVisitor;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.string.ArnStringConverter;
import software.amazon.awssdk.services.dynamodb.model.AttributeValue;

/**
* A converter between {@link Arn} and {@link AttributeValue}.
*
* <p>
* This supports storing and reading values in DynamoDB as a string.
*/
@SdkInternalApi
@ThreadSafe
@Immutable
public final class ArnAttributeConverter implements AttributeConverter<Arn> {
public static final ArnStringConverter STRING_CONVERTER = ArnStringConverter.create();

public static ArnAttributeConverter create() {
return new ArnAttributeConverter();
}

@Override
public EnhancedType<Arn> type() {
return EnhancedType.of(Arn.class);
}

@Override
public AttributeValueType attributeValueType() {
return AttributeValueType.S;
}

@Override
public AttributeValue transformFrom(Arn input) {
return AttributeValue.builder().s(STRING_CONVERTER.toString(input)).build();
}

@Override
public Arn transformTo(AttributeValue input) {
return EnhancedAttributeValue.fromAttributeValue(input).convert(Visitor.INSTANCE);
}

private static final class Visitor extends TypeConvertingVisitor<Arn> {
private static final Visitor INSTANCE = new Visitor();

private Visitor() {
super(Arn.class, ArnAttributeConverter.class);
}

@Override
public Arn convertString(String value) {
return STRING_CONVERTER.fromString(value);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.awssdk.enhanced.dynamodb.internal.converter.string;

import software.amazon.awssdk.annotations.Immutable;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.arns.Arn;
import software.amazon.awssdk.enhanced.dynamodb.EnhancedType;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.StringConverter;

/**
* A converter between {@link Arn} and {@link String}.
*/
@SdkInternalApi
@ThreadSafe
@Immutable
public class ArnStringConverter implements StringConverter<Arn> {
private ArnStringConverter() {
}

public static ArnStringConverter create() {
return new ArnStringConverter();
}

@Override
public EnhancedType<Arn> type() {
return EnhancedType.of(Arn.class);
}

@Override
public Arn fromString(String string) {
return Arn.fromString(string);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
* <p>
* Included converters:
* <ul>
* <li>{@link ArnStringConverter}</li>
* <li>{@link AtomicIntegerStringConverter}</li>
* <li>{@link AtomicLongStringConverter}</li>
* <li>{@link BigDecimalStringConverter}</li>
Expand Down Expand Up @@ -106,6 +107,7 @@ public static Builder builder() {

public static DefaultStringConverterProvider create() {
return DefaultStringConverterProvider.builder()
.addConverter(ArnStringConverter.create())
.addConverter(ByteArrayStringConverter.create())
.addConverter(CharacterArrayStringConverter.create())
.addConverter(BooleanStringConverter.create())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,12 @@
import java.util.Set;
import java.util.UUID;
import org.junit.jupiter.api.Test;

import software.amazon.awssdk.arns.Arn;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.enhanced.dynamodb.AttributeValueType;
import software.amazon.awssdk.enhanced.dynamodb.internal.AttributeValues;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.ArnAttributeConverter;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.CharSequenceAttributeConverter;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.CharacterArrayAttributeConverter;
import software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.CharacterAttributeConverter;
Expand All @@ -59,6 +62,28 @@
import software.amazon.awssdk.utils.ImmutableMap;

public class StringAttributeConvertersTest {

@Test
public void arnAttributeConverterBehaves() {
ArnAttributeConverter converter = ArnAttributeConverter.create();
Arn arn = Arn.fromString("arn:partition:service:region:account:resourcetype/resource");
Arn arnSlashQualifier = Arn.fromString("arn:partition:service:region:account:resourcetype/resource/qualifier");
Arn arnColonQualifier = Arn.fromString("arn:partition:service:region:account:resourcetype/resource:qualifier");
Arn arnNoRegion = Arn.fromString("arn:partition:service::account:resourcetype/resource");

assertThat(transformFrom(converter, arn).s()).isEqualTo(arn.toString());
assertThat(transformTo(converter, fromString(arn.toString()))).isEqualTo(arn);

assertThat(transformFrom(converter, arnSlashQualifier).s()).isEqualTo(arnSlashQualifier.toString());
assertThat(transformTo(converter, fromString(arnSlashQualifier.toString()))).isEqualTo(arnSlashQualifier);

assertThat(transformFrom(converter, arnColonQualifier).s()).isEqualTo(arnColonQualifier.toString());
assertThat(transformTo(converter, fromString(arnColonQualifier.toString()))).isEqualTo(arnColonQualifier);

assertThat(transformFrom(converter, arnNoRegion).s()).isEqualTo(arnNoRegion.toString());
assertThat(transformTo(converter, fromString(arnNoRegion.toString()))).isEqualTo(arnNoRegion);
}

@Test
public void charArrayAttributeConverterBehaves() {
CharacterArrayAttributeConverter converter = CharacterArrayAttributeConverter.create();
Expand Down