software.amazon.awssdk.codegen.poet.model.ShapeModelSpec Maven / Gradle / Ivy
/*
* 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.codegen.poet.model;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.CodeBlock;
import com.squareup.javapoet.FieldSpec;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.ParameterizedTypeName;
import com.squareup.javapoet.WildcardTypeName;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
import javax.lang.model.element.Modifier;
import software.amazon.awssdk.codegen.model.config.customization.CustomizationConfig;
import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
import software.amazon.awssdk.codegen.model.intermediate.MemberModel;
import software.amazon.awssdk.codegen.model.intermediate.Protocol;
import software.amazon.awssdk.codegen.model.intermediate.ShapeModel;
import software.amazon.awssdk.codegen.model.intermediate.ShapeType;
import software.amazon.awssdk.codegen.model.service.XmlNamespace;
import software.amazon.awssdk.codegen.naming.NamingStrategy;
import software.amazon.awssdk.codegen.poet.PoetExtension;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.DataTypeConversionFailureHandlingTrait;
import software.amazon.awssdk.core.traits.DefaultValueTrait;
import software.amazon.awssdk.core.traits.JsonValueTrait;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.traits.PayloadTrait;
import software.amazon.awssdk.core.traits.RequiredTrait;
import software.amazon.awssdk.core.traits.TimestampFormatTrait;
import software.amazon.awssdk.core.traits.XmlAttributeTrait;
import software.amazon.awssdk.core.traits.XmlAttributesTrait;
import software.amazon.awssdk.core.traits.XmlAttributesTrait.AttributeAccessors;
import software.amazon.awssdk.utils.Pair;
/**
* Provides Poet specs related to shape models.
*/
class ShapeModelSpec {
private final ShapeModel shapeModel;
private final TypeProvider typeProvider;
private final PoetExtension poetExtensions;
private final NamingStrategy namingStrategy;
private final CustomizationConfig customizationConfig;
private final IntermediateModel model;
ShapeModelSpec(ShapeModel shapeModel,
TypeProvider typeProvider,
PoetExtension poetExtensions,
IntermediateModel model) {
this.shapeModel = shapeModel;
this.typeProvider = typeProvider;
this.poetExtensions = poetExtensions;
this.namingStrategy = model.getNamingStrategy();
this.customizationConfig = model.getCustomizationConfig();
this.model = model;
}
ClassName className() {
return poetExtensions.getModelClass(shapeModel.getShapeName());
}
public List fields() {
return fields(Modifier.PRIVATE, Modifier.FINAL);
}
public List fields(Modifier... modifiers) {
return shapeModel.getNonStreamingMembers().stream()
// Exceptions can be members of event stream shapes, need to filter those out of the models
.filter(m -> m.getShape() == null || m.getShape().getShapeType() != ShapeType.Exception)
.map(m -> typeProvider.asField(m, modifiers))
.collect(Collectors.toList());
}
public Iterable staticFields(Modifier... modifiers) {
List fields = new ArrayList<>();
Map nameToField = new LinkedHashMap<>();
shapeModel.getNonStreamingMembers().stream()
// Exceptions can be members of event stream shapes, need to filter those out of the models
.filter(m -> m.getShape() == null || m.getShape().getShapeType() != ShapeType.Exception)
.filter(m -> !m.isSynthetic())
.forEach(m -> {
FieldSpec field = typeProvider.asField(m, modifiers);
ClassName sdkFieldType = ClassName.get(SdkField.class);
fields.add(FieldSpec.builder(ParameterizedTypeName.get(sdkFieldType, field.type),
namingStrategy.getSdkFieldFieldName(m),
Modifier.PRIVATE, Modifier.STATIC, Modifier.FINAL)
.initializer(sdkFieldInitializer(m))
.build());
String name = m.getHttp().getMarshallLocationName();
nameToField.put(name, namingStrategy.getSdkFieldFieldName(m));
});
ParameterizedTypeName sdkFieldType = ParameterizedTypeName.get(ClassName.get(SdkField.class),
WildcardTypeName.subtypeOf(ClassName.get(Object.class)));
fields.add(FieldSpec.builder(ParameterizedTypeName.get(ClassName.get(List.class),
sdkFieldType), "SDK_FIELDS",
Modifier.PRIVATE, Modifier.STATIC, Modifier.FINAL)
.initializer(sdkFieldsInitializer(fields))
.build());
fields.add(FieldSpec.builder(ParameterizedTypeName.get(ClassName.get(Map.class),
ClassName.get(String.class),
sdkFieldType),
"SDK_NAME_TO_FIELD",
Modifier.PRIVATE, Modifier.STATIC, Modifier.FINAL)
.initializer(memberNameToFieldInitializer())
.build());
return fields;
}
private CodeBlock sdkFieldInitializer(MemberModel m) {
ClassName sdkFieldType = ClassName.get(SdkField.class);
return CodeBlock.builder()
.add("$T.<$T>builder($T.$L)\n",
sdkFieldType, typeProvider.fieldType(m),
ClassName.get(MarshallingType.class), m.getMarshallingType())
.add(".memberName($S)\n", m.getC2jName())
.add(".getter(getter($T::$L))\n",
className(), m.getFluentGetterMethodName())
.add(".setter(setter($T::$L))\n",
className().nestedClass("Builder"), m.getFluentSetterMethodName())
.add(constructor(m))
.add(traits(m))
.add(".build()")
.build();
}
public List additionalMethods() {
return Collections.singletonList(memberNameToFieldInitializerMethod(nameToField()));
}
public Map nameToField() {
Map nameToField = new LinkedHashMap<>();
shapeModel.getNonStreamingMembers().stream()
.filter(m -> m.getShape() == null || m.getShape().getShapeType() != ShapeType.Exception)
.filter(m -> !m.isSynthetic())
.forEach(m -> {
String name = m.getHttp().getMarshallLocationName();
nameToField.put(name, namingStrategy.getSdkFieldFieldName(m));
});
return nameToField;
}
private CodeBlock containerSdkFieldInitializer(MemberModel m) {
ClassName sdkFieldType = ClassName.get(SdkField.class);
return CodeBlock.builder()
.add("$T.<$T>builder($T.$L)\n",
sdkFieldType, typeProvider.fieldType(m),
ClassName.get(MarshallingType.class), m.getMarshallingType())
.add(constructor(m))
.add(traits(m))
.add(".build()")
.build();
}
private CodeBlock traits(MemberModel m) {
List traits = new ArrayList<>();
traits.add(createLocationTrait(m));
if (m.isList()) {
traits.add(createListTrait(m));
} else if (m.isMap()) {
traits.add(createMapTrait(m));
}
if (m.getHttp().getIsPayload() || m.isEventPayload() || attachPayloadTraitToMember(m)) {
traits.add(createPayloadTrait());
}
if (m.isJsonValue()) {
traits.add(createJsonValueTrait());
}
if (m.isIdempotencyToken()) {
traits.add(createIdempotencyTrait());
}
String customDefaultValueSupplier = customizationConfig.getModelMarshallerDefaultValueSupplier().get(m.getC2jName());
if (customDefaultValueSupplier != null) {
traits.add(createDefaultValueTrait(customDefaultValueSupplier));
}
if (m.getTimestampFormat() != null) {
traits.add(createTimestampFormatTrait(m));
}
if (m.getShape() != null && m.getShape().getXmlNamespace() != null) {
traits.add(createXmlAttributesTrait(m));
}
if (m.isXmlAttribute()) {
traits.add(createXmlAttributeTrait());
}
if (m.ignoreDataTypeConversionFailures()) {
traits.add(createDataTypeConversionFailureHandlingTrait());
}
if (customizationConfig.isRequiredTraitValidationEnabled() && m.isRequired()) {
traits.add(createRequiredTrait());
}
if (!traits.isEmpty()) {
return CodeBlock.builder()
.add(".traits(" + traits.stream().map(t -> "$L").collect(Collectors.joining(", ")) + ")",
traits.toArray())
.build();
} else {
return CodeBlock.builder().build();
}
}
private boolean attachPayloadTraitToMember(MemberModel m) {
return customizationConfig.getAttachPayloadTraitToMember()
.getOrDefault(shapeModel.getC2jName(), "")
.equals(m.getC2jName());
}
private CodeBlock createDataTypeConversionFailureHandlingTrait() {
return CodeBlock.builder()
.add("new $T()", ClassName.get(DataTypeConversionFailureHandlingTrait.class))
.build();
}
private CodeBlock createTimestampFormatTrait(MemberModel m) {
TimestampFormatTrait.Format format = TimestampFormatTrait.Format.fromString(m.getTimestampFormat());
ClassName traitClass = ClassName.get(TimestampFormatTrait.class);
ClassName formatClass = ClassName.get(TimestampFormatTrait.Format.class);
return CodeBlock.builder()
.add("$T.create($T.$L)", traitClass, formatClass, format.name())
.build();
}
private CodeBlock createLocationTrait(MemberModel m) {
MarshallLocation marshallLocation = marshallLocation(m);
String unmarshallLocation = unmarshallLocation(m);
return CodeBlock.builder()
// TODO will marshall and unmarshall location name ever differ?
.add("$T.builder()\n"
+ ".location($T.$L)\n"
+ ".locationName($S)\n"
+ unmarshallLocation
+ ".build()", ClassName.get(LocationTrait.class), ClassName.get(MarshallLocation.class),
marshallLocation, m.getHttp().getMarshallLocationName())
.build();
}
private MarshallLocation marshallLocation(MemberModel m) {
// Handle events explicitly
if (m.isEventHeader()) {
return MarshallLocation.HEADER;
}
if (m.isEventPayload()) {
return MarshallLocation.PAYLOAD;
}
return m.getHttp().getMarshallLocation();
}
// Rest xml uses unmarshall locationName to properly unmarshall flattened lists
private String unmarshallLocation(MemberModel m) {
return model.getMetadata().getProtocol() == Protocol.EC2 ||
model.getMetadata().getProtocol() == Protocol.REST_XML ?
String.format(".unmarshallLocationName(\"%s\")%n", m.getHttp().getUnmarshallLocationName()) : "";
}
private CodeBlock createIdempotencyTrait() {
return CodeBlock.builder()
.add("$T.idempotencyToken()", ClassName.get(DefaultValueTrait.class))
.build();
}
private CodeBlock createDefaultValueTrait(String customDefaultValueSupplier) {
return CodeBlock.builder()
.add("$T.create($T.getInstance())", ClassName.get(DefaultValueTrait.class),
ClassName.bestGuess(customDefaultValueSupplier))
.build();
}
private CodeBlock createJsonValueTrait() {
return CodeBlock.builder()
.add("$T.create()", ClassName.get(JsonValueTrait.class))
.build();
}
private CodeBlock createPayloadTrait() {
return CodeBlock.builder()
.add("$T.create()", ClassName.get(PayloadTrait.class))
.build();
}
private CodeBlock createRequiredTrait() {
return CodeBlock.builder()
.add("$T.create()", ClassName.get(RequiredTrait.class))
.build();
}
private CodeBlock createMapTrait(MemberModel m) {
return CodeBlock.builder()
.add("$T.builder()\n"
+ ".keyLocationName($S)\n"
+ ".valueLocationName($S)\n"
+ ".valueFieldInfo($L)\n"
+ isFlattened(m)
+ ".build()", ClassName.get(MapTrait.class),
m.getMapModel().getKeyLocationName(),
m.getMapModel().getValueLocationName(),
containerSdkFieldInitializer(m.getMapModel().getValueModel()))
.build();
}
private CodeBlock createListTrait(MemberModel m) {
return CodeBlock.builder()
.add("$T.builder()\n"
+ ".memberLocationName($S)\n"
+ ".memberFieldInfo($L)\n"
+ isFlattened(m)
+ ".build()", ClassName.get(ListTrait.class),
m.getListModel().getMemberLocationName(),
containerSdkFieldInitializer(m.getListModel().getListMemberModel()))
.build();
}
private CodeBlock createXmlAttributeTrait() {
return CodeBlock.builder()
.add("$T.create()", ClassName.get(XmlAttributeTrait.class))
.build();
}
private CodeBlock createXmlAttributesTrait(MemberModel model) {
ShapeModel shape = model.getShape();
XmlNamespace xmlNamespace = shape.getXmlNamespace();
String uri = xmlNamespace.getUri();
String prefix = xmlNamespace.getPrefix();
CodeBlock.Builder codeBlockBuilder = CodeBlock.builder()
.add("$T.create(", ClassName.get(XmlAttributesTrait.class));
String namespacePrefix = "xmlns:" + prefix;
codeBlockBuilder.add("$T.of($S, $T.builder().attributeGetter((ignore) -> $S).build())",
Pair.class, namespacePrefix, AttributeAccessors.class, uri);
Optional memberWithXmlAttribute = findMemberWithXmlAttribute(shape);
memberWithXmlAttribute.ifPresent(m -> {
String attributeLocation = m.getHttp().getMarshallLocationName();
codeBlockBuilder
.add(", $T.of($S, ", Pair.class, attributeLocation)
.add("$T.builder()", AttributeAccessors.class)
.add(".attributeGetter(t -> (($T)t).$L())\n",
typeProvider.fieldType(model),
m.getFluentGetterMethodName())
.add(".build())");
});
codeBlockBuilder.add(")");
return codeBlockBuilder.build();
}
private static Optional findMemberWithXmlAttribute(ShapeModel shapeModel) {
return shapeModel.getMembers().stream().filter(MemberModel::isXmlAttribute).findAny();
}
private String isFlattened(MemberModel m) {
return m.getHttp().isFlattened() ? ".isFlattened(true)\n" : "";
}
private CodeBlock constructor(MemberModel m) {
if (!m.isSimple() && !m.isList() && !m.isMap()) {
return CodeBlock.builder()
.add(".constructor($T::builder)\n", typeProvider.fieldType(m))
.build();
} else {
return CodeBlock.builder().build();
}
}
private CodeBlock sdkFieldsInitializer(List fields) {
CodeBlock.Builder builder = CodeBlock.builder();
if (fields.isEmpty()) {
builder.add("$T.emptyList()", Collections.class);
return builder.build();
}
builder.add("$T.unmodifiableList($T.asList($L))",
ClassName.get(Collections.class),
ClassName.get(Arrays.class),
fields.stream()
.map(f -> f.name)
.collect(Collectors.joining(",")));
return builder.build();
}
private CodeBlock memberNameToFieldInitializer() {
return CodeBlock.builder()
.add("memberNameToFieldInitializer()")
.build();
}
private MethodSpec memberNameToFieldInitializerMethod(Map nameToField) {
ParameterizedTypeName sdkFieldT = ParameterizedTypeName.get(ClassName.get(SdkField.class),
WildcardTypeName.subtypeOf(Object.class));
ParameterizedTypeName mapT = ParameterizedTypeName.get(ClassName.get(Map.class), ClassName.get(String.class),
sdkFieldT);
MethodSpec.Builder builder = MethodSpec.methodBuilder("memberNameToFieldInitializer")
.addModifiers(Modifier.PRIVATE, Modifier.STATIC)
.returns(mapT);
if (nameToField.isEmpty()) {
builder.addStatement("return $T.emptyMap()", Collections.class);
} else {
builder.addStatement("$T map = new $T<>()", mapT, HashMap.class);
nameToField.forEach((name, field) -> builder.addStatement("map.put($S, $L)", name, field));
builder.addStatement("return $T.unmodifiableMap(map)", Collections.class);
}
return builder.build();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy