Skip to content

Commit 4bf1f8f

Browse files
joviegasL-Applin
joviegas
and
L-Applin
authored
Add LegacyMd5Plugin for MD5 checksum calculations in S3 operations requiring checksums (#6055)
* LegacyMd5Plugin which adds MD5 checksum for operations that require it got S3 * LegacyMd5Plugin which adds MD5 checksum for operations that require it got S3 * Update services/s3/src/main/java/software/amazon/awssdk/services/s3/LegacyMd5Plugin.java Co-authored-by: Olivier L Applin <[email protected]> * Handled Oliviers commets * Handled Zoes comment * updated Java docs for class * Updated test case for user set md5 checksum --------- Co-authored-by: Olivier L Applin <[email protected]>
1 parent d0ccf56 commit 4bf1f8f

File tree

8 files changed

+825
-0
lines changed

8 files changed

+825
-0
lines changed

‎.changes/next-release/feature-AmazonSimpleStorageService-9b115ba.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Simple Storage Service",
4+
"contributor": "",
5+
"description": "Added LegacyMd5Plugin to perform MD5 checksums for operations that require checksum"
6+
}

‎codegen/src/main/java/software/amazon/awssdk/codegen/poet/model/ServiceClientConfigurationUtils.java

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515

1616
package software.amazon.awssdk.codegen.poet.model;
1717

18+
import static software.amazon.awssdk.codegen.poet.client.traits.HttpChecksumTrait.hasRequestAlgorithmMember;
19+
import static software.amazon.awssdk.codegen.poet.client.traits.HttpChecksumTrait.hasResponseAlgorithms;
20+
1821
import com.squareup.javapoet.ClassName;
1922
import com.squareup.javapoet.CodeBlock;
2023
import com.squareup.javapoet.MethodSpec;
@@ -34,6 +37,8 @@
3437
import software.amazon.awssdk.codegen.poet.auth.scheme.AuthSchemeSpecUtils;
3538
import software.amazon.awssdk.codegen.poet.rules.EndpointRulesSpecUtils;
3639
import software.amazon.awssdk.core.ClientEndpointProvider;
40+
import software.amazon.awssdk.core.checksums.RequestChecksumCalculation;
41+
import software.amazon.awssdk.core.checksums.ResponseChecksumValidation;
3742
import software.amazon.awssdk.core.client.config.ClientOption;
3843
import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
3944
import software.amazon.awssdk.core.client.config.SdkClientConfiguration;
@@ -100,6 +105,7 @@ private List<Field> fields(IntermediateModel model) {
100105
authSchemeProviderField()
101106
));
102107
fields.addAll(addCustomClientParams(model));
108+
fields.addAll(addCustomClientConfigParams(model));
103109
return fields;
104110
}
105111

@@ -553,4 +559,51 @@ private static String fieldName(Object fieldObject) {
553559
fieldObject,
554560
fieldObject.getClass().getName()));
555561
}
562+
563+
private List<Field> addCustomClientConfigParams(IntermediateModel model) {
564+
List<Field> customClientParamFields = new ArrayList<>();
565+
566+
if (hasRequestAlgorithmMember(model) && hasResponseAlgorithms(model)) {
567+
customClientParamFields.add(
568+
createChecksumConfigField(
569+
"responseChecksumValidation",
570+
ResponseChecksumValidation.class,
571+
"client behavior for response checksum validation",
572+
SdkClientOption.class,
573+
"RESPONSE_CHECKSUM_VALIDATION"
574+
)
575+
);
576+
customClientParamFields.add(
577+
createChecksumConfigField(
578+
"requestChecksumCalculation",
579+
RequestChecksumCalculation.class,
580+
"client behavior for request checksum calculation",
581+
SdkClientOption.class,
582+
"REQUEST_CHECKSUM_CALCULATION"
583+
)
584+
);
585+
}
586+
return customClientParamFields;
587+
}
588+
589+
private Field createChecksumConfigField(String fieldName, Class<?> fieldType, String docString,
590+
Class<?> optionClass, String optionName) {
591+
return fieldBuilder(fieldName, fieldType)
592+
.doc(docString)
593+
.isInherited(false)
594+
.localSetter(basicLocalSetterCode(fieldName))
595+
.localGetter(basicLocalGetterCode(fieldName))
596+
.configSetter(
597+
CodeBlock.builder()
598+
.addStatement("config.option($1T.$2L, $3L)", optionClass, optionName, fieldName)
599+
.addStatement("return this")
600+
.build()
601+
)
602+
.configGetter(
603+
CodeBlock.builder()
604+
.addStatement("return config.option($1T.$2L)", optionClass, optionName)
605+
.build()
606+
)
607+
.build();
608+
}
556609
}

‎codegen/src/test/java/software/amazon/awssdk/codegen/poet/model/ServiceClientConfigurationBuilderSpecTest.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
package software.amazon.awssdk.codegen.poet.model;
1717

18+
import static software.amazon.awssdk.codegen.poet.ClientTestModels.restJsonServiceModels;
1819
import static software.amazon.awssdk.codegen.poet.PoetMatchers.generatesTo;
1920

2021
import java.io.File;
@@ -52,4 +53,10 @@ public void testGeneration() {
5253
ServiceClientConfigurationBuilderClass spec = new ServiceClientConfigurationBuilderClass(intermediateModel);
5354
MatcherAssert.assertThat(spec, generatesTo("serviceclientconfiguration-builder.java"));
5455
}
56+
57+
@Test
58+
public void testGenerationWithChecksumCalulationEnabled() {
59+
ServiceClientConfigurationBuilderClass spec = new ServiceClientConfigurationBuilderClass(restJsonServiceModels());
60+
MatcherAssert.assertThat(spec, generatesTo("serviceclientconfiguration-withchecksum-builder.java"));
61+
}
5562
}

‎codegen/src/test/resources/software/amazon/awssdk/codegen/poet/model/serviceclientconfiguration-withchecksum-builder.java

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
package software.amazon.awssdk.services.json.internal;
2+
3+
import java.net.URI;
4+
import java.util.Collections;
5+
import java.util.HashMap;
6+
import java.util.Map;
7+
import software.amazon.awssdk.annotations.Generated;
8+
import software.amazon.awssdk.annotations.SdkInternalApi;
9+
import software.amazon.awssdk.awscore.client.config.AwsClientOption;
10+
import software.amazon.awssdk.core.ClientEndpointProvider;
11+
import software.amazon.awssdk.core.checksums.RequestChecksumCalculation;
12+
import software.amazon.awssdk.core.checksums.ResponseChecksumValidation;
13+
import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
14+
import software.amazon.awssdk.core.client.config.SdkClientConfiguration;
15+
import software.amazon.awssdk.core.client.config.SdkClientOption;
16+
import software.amazon.awssdk.endpoints.EndpointProvider;
17+
import software.amazon.awssdk.http.auth.spi.scheme.AuthScheme;
18+
import software.amazon.awssdk.http.auth.spi.scheme.AuthSchemeProvider;
19+
import software.amazon.awssdk.identity.spi.AwsCredentialsIdentity;
20+
import software.amazon.awssdk.identity.spi.IdentityProvider;
21+
import software.amazon.awssdk.regions.Region;
22+
import software.amazon.awssdk.services.json.JsonServiceClientConfiguration;
23+
import software.amazon.awssdk.services.json.auth.scheme.JsonAuthSchemeProvider;
24+
import software.amazon.awssdk.utils.Validate;
25+
26+
@Generated("software.amazon.awssdk:codegen")
27+
@SdkInternalApi
28+
public class JsonServiceClientConfigurationBuilder implements JsonServiceClientConfiguration.Builder {
29+
private final SdkClientConfiguration.Builder config;
30+
31+
public JsonServiceClientConfigurationBuilder() {
32+
this(SdkClientConfiguration.builder());
33+
}
34+
35+
public JsonServiceClientConfigurationBuilder(SdkClientConfiguration.Builder config) {
36+
this.config = config;
37+
}
38+
39+
/**
40+
* Sets the value for client override configuration
41+
*/
42+
@Override
43+
public JsonServiceClientConfiguration.Builder overrideConfiguration(ClientOverrideConfiguration overrideConfiguration) {
44+
config.putAll(overrideConfiguration);
45+
return this;
46+
}
47+
48+
/**
49+
* Gets the value for client override configuration
50+
*/
51+
@Override
52+
public ClientOverrideConfiguration overrideConfiguration() {
53+
return config.asOverrideConfigurationBuilder().build();
54+
}
55+
56+
/**
57+
* Sets the value for endpoint override
58+
*/
59+
@Override
60+
public JsonServiceClientConfiguration.Builder endpointOverride(URI endpointOverride) {
61+
if (endpointOverride != null) {
62+
config.option(SdkClientOption.CLIENT_ENDPOINT_PROVIDER, ClientEndpointProvider.forEndpointOverride(endpointOverride));
63+
} else {
64+
config.option(SdkClientOption.CLIENT_ENDPOINT_PROVIDER, null);
65+
}
66+
return this;
67+
}
68+
69+
/**
70+
* Gets the value for endpoint override
71+
*/
72+
@Override
73+
public URI endpointOverride() {
74+
ClientEndpointProvider clientEndpoint = config.option(SdkClientOption.CLIENT_ENDPOINT_PROVIDER);
75+
if (clientEndpoint != null && clientEndpoint.isEndpointOverridden()) {
76+
return clientEndpoint.clientEndpoint();
77+
}
78+
return null;
79+
}
80+
81+
/**
82+
* Sets the value for endpoint provider
83+
*/
84+
@Override
85+
public JsonServiceClientConfiguration.Builder endpointProvider(EndpointProvider endpointProvider) {
86+
config.option(SdkClientOption.ENDPOINT_PROVIDER, endpointProvider);
87+
return this;
88+
}
89+
90+
/**
91+
* Gets the value for endpoint provider
92+
*/
93+
@Override
94+
public EndpointProvider endpointProvider() {
95+
return config.option(SdkClientOption.ENDPOINT_PROVIDER);
96+
}
97+
98+
/**
99+
* Sets the value for AWS region
100+
*/
101+
@Override
102+
public JsonServiceClientConfiguration.Builder region(Region region) {
103+
config.option(AwsClientOption.AWS_REGION, region);
104+
return this;
105+
}
106+
107+
/**
108+
* Gets the value for AWS region
109+
*/
110+
@Override
111+
public Region region() {
112+
return config.option(AwsClientOption.AWS_REGION);
113+
}
114+
115+
/**
116+
* Sets the value for credentials provider
117+
*/
118+
@Override
119+
public JsonServiceClientConfiguration.Builder credentialsProvider(
120+
IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider) {
121+
config.option(AwsClientOption.CREDENTIALS_IDENTITY_PROVIDER, credentialsProvider);
122+
return this;
123+
}
124+
125+
/**
126+
* Gets the value for credentials provider
127+
*/
128+
@Override
129+
public IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider() {
130+
return config.option(AwsClientOption.CREDENTIALS_IDENTITY_PROVIDER);
131+
}
132+
133+
@Override
134+
public JsonServiceClientConfiguration.Builder putAuthScheme(AuthScheme<?> authScheme) {
135+
config.computeOptionIfAbsent(SdkClientOption.AUTH_SCHEMES, HashMap::new).put(authScheme.schemeId(), authScheme);
136+
return this;
137+
}
138+
139+
/**
140+
* Gets the value for auth schemes
141+
*/
142+
@Override
143+
public Map<String, AuthScheme<?>> authSchemes() {
144+
Map<String, AuthScheme<?>> authSchemes = config.option(SdkClientOption.AUTH_SCHEMES);
145+
return Collections.unmodifiableMap(authSchemes == null ? Collections.emptyMap() : authSchemes);
146+
}
147+
148+
/**
149+
* Sets the value for auth scheme provider
150+
*/
151+
@Override
152+
public JsonServiceClientConfiguration.Builder authSchemeProvider(JsonAuthSchemeProvider authSchemeProvider) {
153+
config.option(SdkClientOption.AUTH_SCHEME_PROVIDER, authSchemeProvider);
154+
return this;
155+
}
156+
157+
/**
158+
* Gets the value for auth scheme provider
159+
*/
160+
@Override
161+
public JsonAuthSchemeProvider authSchemeProvider() {
162+
AuthSchemeProvider result = config.option(SdkClientOption.AUTH_SCHEME_PROVIDER);
163+
if (result == null) {
164+
return null;
165+
}
166+
return Validate.isInstanceOf(JsonAuthSchemeProvider.class, result, "Expected an instance of "
167+
+ JsonAuthSchemeProvider.class.getSimpleName());
168+
}
169+
170+
/**
171+
* Sets the value for client behavior for response checksum validation
172+
*/
173+
@Override
174+
public JsonServiceClientConfiguration.Builder responseChecksumValidation(ResponseChecksumValidation responseChecksumValidation) {
175+
config.option(SdkClientOption.RESPONSE_CHECKSUM_VALIDATION, responseChecksumValidation);
176+
return this;
177+
}
178+
179+
/**
180+
* Gets the value for client behavior for response checksum validation
181+
*/
182+
@Override
183+
public ResponseChecksumValidation responseChecksumValidation() {
184+
return config.option(SdkClientOption.RESPONSE_CHECKSUM_VALIDATION);
185+
}
186+
187+
/**
188+
* Sets the value for client behavior for request checksum calculation
189+
*/
190+
@Override
191+
public JsonServiceClientConfiguration.Builder requestChecksumCalculation(RequestChecksumCalculation requestChecksumCalculation) {
192+
config.option(SdkClientOption.REQUEST_CHECKSUM_CALCULATION, requestChecksumCalculation);
193+
return this;
194+
}
195+
196+
/**
197+
* Gets the value for client behavior for request checksum calculation
198+
*/
199+
@Override
200+
public RequestChecksumCalculation requestChecksumCalculation() {
201+
return config.option(SdkClientOption.REQUEST_CHECKSUM_CALCULATION);
202+
}
203+
204+
@Override
205+
public JsonServiceClientConfiguration build() {
206+
return new JsonServiceClientConfiguration(this);
207+
}
208+
}

0 commit comments

Comments
 (0)