software.amazon.awssdk.codegen.internal.Utils 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.internal;
import static java.util.stream.Collectors.toList;
import static software.amazon.awssdk.utils.StringUtils.lowerCase;
import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.UncheckedIOException;
import java.nio.file.Files;
import java.util.List;
import java.util.Map;
import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
import software.amazon.awssdk.codegen.model.intermediate.MapModel;
import software.amazon.awssdk.codegen.model.intermediate.MemberModel;
import software.amazon.awssdk.codegen.model.intermediate.Metadata;
import software.amazon.awssdk.codegen.model.intermediate.ShapeMarshaller;
import software.amazon.awssdk.codegen.model.intermediate.ShapeModel;
import software.amazon.awssdk.codegen.model.intermediate.ShapeType;
import software.amazon.awssdk.codegen.model.service.Input;
import software.amazon.awssdk.codegen.model.service.Operation;
import software.amazon.awssdk.codegen.model.service.ServiceMetadata;
import software.amazon.awssdk.codegen.model.service.ServiceModel;
import software.amazon.awssdk.codegen.model.service.Shape;
import software.amazon.awssdk.codegen.model.service.XmlNamespace;
import software.amazon.awssdk.utils.IoUtils;
import software.amazon.awssdk.utils.StringUtils;
public final class Utils {
private Utils() {
}
public static boolean isScalar(Shape shape) {
// enums are treated as scalars in C2j.
return !(isListShape(shape) || isStructure(shape) || isMapShape(shape));
}
public static boolean isStructure(Shape shape) {
return shape.getType().equals("structure");
}
public static boolean isListShape(Shape shape) {
return shape != null && shape.getType() != null && shape.getType().equals("list");
}
public static boolean isMapShape(Shape shape) {
return shape.getType() != null && shape.getType().equals("map");
}
public static boolean isEnumShape(Shape shape) {
return shape.getEnumValues() != null;
}
public static boolean isExceptionShape(Shape shape) {
return shape.isException() || shape.isFault();
}
public static boolean isOrContainsEnumShape(Shape shape, Map allShapes) {
boolean isEnum = isEnumShape(shape);
boolean isMapWithEnumMember = isMapShape(shape)
&& (isOrContainsEnumShape(allShapes.get(shape.getMapKeyType().getShape()), allShapes)
|| isOrContainsEnumShape(allShapes.get(shape.getMapValueType().getShape()), allShapes));
boolean isListWithEnumMember = isListShape(shape)
&& isOrContainsEnumShape(allShapes.get(shape.getListMember().getShape()), allShapes);
return isEnum || isMapWithEnumMember || isListWithEnumMember;
}
public static boolean isOrContainsEnum(MemberModel member) {
boolean isEnum = member.getEnumType() != null;
return isEnum || isMapWithEnumShape(member) || isListWithEnumShape(member);
}
public static boolean isListWithEnumShape(MemberModel member) {
return member.isList() && member.getListModel().getListMemberModel().getEnumType() != null;
}
public static boolean isMapWithEnumShape(MemberModel member) {
return member.isMap() && (isMapKeyWithEnumShape(member.getMapModel()) || isMapValueWithEnumShape(member.getMapModel()));
}
public static boolean isMapKeyWithEnumShape(MapModel mapModel) {
return mapModel.getKeyModel().getEnumType() != null;
}
public static boolean isMapValueWithEnumShape(MapModel mapModel) {
return mapModel.getValueModel().getEnumType() != null;
}
public static String unCapitalize(String name) {
if (name == null || name.trim().isEmpty()) {
throw new IllegalArgumentException("Name cannot be null or empty");
}
StringBuilder sb = new StringBuilder(name.length());
int i = 0;
do {
sb.append(Character.toLowerCase(name.charAt(i++)));
} while ((i < name.length() && Character.isUpperCase(name.charAt(i)))
// not followed by a lowercase character
&& !(i < name.length() - 1 && Character.isLowerCase(name.charAt(i + 1))));
sb.append(name.substring(i));
return sb.toString();
}
public static String capitalize(String name) {
if (name == null || name.trim().isEmpty()) {
throw new IllegalArgumentException("Name cannot be null or empty");
}
return name.length() < 2 ? StringUtils.upperCase(name) : StringUtils.upperCase(name.substring(0, 1))
+ name.substring(1);
}
public static String removeLeading(String str, String toRemove) {
if (str == null) {
return null;
}
if (lowerCase(str).startsWith(lowerCase(toRemove))) {
return str.substring(toRemove.length());
}
return str;
}
public static String removeTrailing(String str, String toRemove) {
if (str == null) {
return null;
}
if (lowerCase(str).endsWith(lowerCase(toRemove))) {
return str.substring(0, str.length() - toRemove.length());
}
return str;
}
/**
* * @param serviceModel Service model to get prefix for.
* * @return Prefix to use when writing model files (service and intermediate).
*/
public static String getFileNamePrefix(ServiceModel serviceModel) {
return String.format("%s-%s", serviceModel.getMetadata().getEndpointPrefix(), serviceModel.getMetadata().getApiVersion());
}
/**
* Converts a directory to a Java package name.
*
* @param directoryPath Directory to convert.
* @return Package name
*/
public static String directoryToPackage(String directoryPath) {
return directoryPath.replace('/', '.');
}
/**
* Converts a Java package name to a directory.
*
* @param packageName Java package to convert.
* @return directory
*/
public static String packageToDirectory(String packageName) {
return packageName.replace('.', '/');
}
public static String getDefaultEndpointWithoutHttpProtocol(String endpoint) {
if (endpoint == null) {
return null;
}
if (endpoint.startsWith("http://")) {
return endpoint.substring("http://".length());
}
if (endpoint.startsWith("https://")) {
return endpoint.substring("https://".length());
}
return endpoint;
}
public static File createDirectory(String path) {
if (isNullOrEmpty(path)) {
throw new IllegalArgumentException(
"Invalid path directory. Path directory cannot be null or empty");
}
File dir = new File(path);
createDirectory(dir);
return dir;
}
public static void createDirectory(File dir) {
if (!(dir.exists())) {
try {
Files.createDirectories(dir.toPath());
} catch (IOException e) {
throw new UncheckedIOException("Failed to create " + dir, e);
}
}
}
public static File createFile(String dir, String fileName) throws IOException {
if (isNullOrEmpty(fileName)) {
throw new IllegalArgumentException(
"Invalid file name. File name cannot be null or empty");
}
createDirectory(dir);
File file = new File(dir, fileName);
if (!(file.exists())) {
if (!(file.createNewFile())) {
throw new RuntimeException("Not able to create file . "
+ file.getAbsolutePath());
}
}
return file;
}
public static boolean isNullOrEmpty(String str) {
return str == null || str.trim().isEmpty();
}
public static void closeQuietly(Closeable closeable) {
IoUtils.closeQuietly(closeable, null);
}
/**
* Return an InputStream of the specified resource, failing if it can't be found.
*
* @param location Location of resource
*/
public static InputStream getRequiredResourceAsStream(Class clzz, String location) {
InputStream resourceStream = clzz.getResourceAsStream(location);
if (resourceStream == null) {
// Try with a leading "/"
if (!location.startsWith("/")) {
resourceStream = clzz.getResourceAsStream("/" + location);
}
if (resourceStream == null) {
throw new RuntimeException("Resource file was not found at location " + location);
}
}
return resourceStream;
}
/**
* Search for intermediate shape model by its c2j name.
*
* @return ShapeModel
* @throws IllegalArgumentException if the specified c2j name is not found in the intermediate model.
*/
public static ShapeModel findShapeModelByC2jName(IntermediateModel intermediateModel, String shapeC2jName)
throws IllegalArgumentException {
ShapeModel shapeModel = findShapeModelByC2jNameIfExists(intermediateModel, shapeC2jName);
if (shapeModel != null) {
return shapeModel;
} else {
throw new IllegalArgumentException(
shapeC2jName + " shape (c2j name) does not exist in the intermediate model.");
}
}
/**
* Search for intermediate shape model by its c2j name.
*
* @return ShapeModel or null if the shape doesn't exist (if it's primitive or container type for example)
*/
public static ShapeModel findShapeModelByC2jNameIfExists(IntermediateModel intermediateModel, String shapeC2jName) {
for (ShapeModel shape : intermediateModel.getShapes().values()) {
if (shape.getC2jName().equals(shapeC2jName)) {
return shape;
}
}
return null;
}
/**
* Search for a shape model by its C2J name, excluding request and response shapes, which are not candidates to be members
* of another shape.
*
* @return ShapeModel or null if the shape doesn't exist (if it's primitive or container type for example)
*/
public static ShapeModel findMemberShapeModelByC2jNameIfExists(IntermediateModel intermediateModel, String shapeC2jName) {
ShapeModel candidate = null;
for (ShapeModel shape : intermediateModel.getShapes().values()) {
if (shape.getShapeType() != ShapeType.Request
&& shape.getShapeType() != ShapeType.Response
&& shape.getC2jName().equals(shapeC2jName)) {
if (candidate != null) {
throw new IllegalStateException("Conflicting candidates for member model with C2J name " + shapeC2jName + ": "
+ candidate + " and " + shape);
}
candidate = shape;
}
}
return candidate;
}
public static List findShapesByC2jName(IntermediateModel intermediateModel, String shapeC2jName) {
return intermediateModel.getShapes().values().stream().filter(s -> s.getC2jName().equals(shapeC2jName)).collect(toList());
}
/**
* Create the ShapeMarshaller to the input shape from the specified Operation.
* The input shape in the operation could be empty.
*/
public static ShapeMarshaller createInputShapeMarshaller(ServiceMetadata service, Operation operation) {
if (operation == null) {
throw new IllegalArgumentException(
"The operation parameter must be specified!");
}
ShapeMarshaller marshaller = new ShapeMarshaller()
.withAction(operation.getName())
.withVerb(operation.getHttp().getMethod())
.withRequestUri(operation.getHttp().getRequestUri())
.withProtocol(service.getProtocol());
Input input = operation.getInput();
if (input != null) {
marshaller.setLocationName(input.getLocationName());
// Pass the xmlNamespace trait from the input reference
XmlNamespace xmlNamespace = input.getXmlNamespace();
if (xmlNamespace != null) {
marshaller.setXmlNameSpaceUri(xmlNamespace.getUri());
}
}
if (Metadata.usesOperationIdentifier(service.getProtocol())) {
marshaller.setTarget(StringUtils.isEmpty(service.getTargetPrefix()) ?
operation.getName() :
service.getTargetPrefix() + "." + operation.getName());
}
return marshaller;
}
/**
* Create the ShapeMarshaller to the input shape from the specified Operation.
* The input shape in the operation could be empty.
*/
public static ShapeMarshaller createSyntheticInputShapeMarshaller(ServiceMetadata service, Operation operation) {
ShapeMarshaller result = createInputShapeMarshaller(service, operation);
result.withIsSynthetic(true);
return result;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy