software.amazon.awssdk.protocols.json.BaseAwsJsonProtocolFactory 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.protocols.json;
import static java.util.Collections.unmodifiableList;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.EnumMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.function.Function;
import java.util.function.Supplier;
import software.amazon.awssdk.annotations.SdkProtectedApi;
import software.amazon.awssdk.annotations.SdkTestInternalApi;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.ClientEndpointProvider;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.client.config.SdkClientConfiguration;
import software.amazon.awssdk.core.client.config.SdkClientOption;
import software.amazon.awssdk.core.http.HttpResponseHandler;
import software.amazon.awssdk.core.http.MetricCollectingHttpResponseHandler;
import software.amazon.awssdk.core.metrics.CoreMetric;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.traits.TimestampFormatTrait;
import software.amazon.awssdk.http.SdkHttpFullRequest;
import software.amazon.awssdk.http.SdkHttpFullResponse;
import software.amazon.awssdk.protocols.core.ExceptionMetadata;
import software.amazon.awssdk.protocols.core.OperationInfo;
import software.amazon.awssdk.protocols.core.OperationMetadataAttribute;
import software.amazon.awssdk.protocols.core.ProtocolMarshaller;
import software.amazon.awssdk.protocols.json.internal.AwsStructuredPlainJsonFactory;
import software.amazon.awssdk.protocols.json.internal.ProtocolFact;
import software.amazon.awssdk.protocols.json.internal.marshall.JsonProtocolMarshallerBuilder;
import software.amazon.awssdk.protocols.json.internal.unmarshall.AwsJsonErrorMessageParser;
import software.amazon.awssdk.protocols.json.internal.unmarshall.AwsJsonProtocolErrorUnmarshaller;
import software.amazon.awssdk.protocols.json.internal.unmarshall.AwsJsonResponseHandler;
import software.amazon.awssdk.protocols.json.internal.unmarshall.JsonProtocolUnmarshaller;
import software.amazon.awssdk.protocols.json.internal.unmarshall.JsonResponseHandler;
import software.amazon.awssdk.protocols.json.internal.unmarshall.ProtocolUnmarshallDependencies;
import software.amazon.awssdk.protocols.json.internal.unmarshall.SdkClientJsonProtocolAdvancedOption;
@SdkProtectedApi
public abstract class BaseAwsJsonProtocolFactory {
/**
* Used by operations that do not serialize the input, e.g., when the input is not defined in the model. RPCv2 uses it.
*/
public static final OperationMetadataAttribute GENERATES_BODY = new OperationMetadataAttribute<>(Boolean.class);
/**
* Attribute for a protocol to configure extra headers for the operation.
*/
public static final OperationMetadataAttribute> HTTP_EXTRA_HEADERS =
OperationMetadataAttribute.forUnsafe(Map.class);
/**
* Content type resolver implementation for plain text AWS_JSON services.
*/
protected static final JsonContentTypeResolver AWS_JSON = new DefaultJsonContentTypeResolver("application/x-amz-json-");
private final AwsJsonProtocolMetadata protocolMetadata;
private final List modeledExceptions;
private final Supplier defaultServiceExceptionSupplier;
private final String customErrorCodeFieldName;
private final boolean hasAwsQueryCompatible;
private final SdkClientConfiguration clientConfiguration;
private final JsonProtocolUnmarshaller protocolUnmarshaller;
protected BaseAwsJsonProtocolFactory(Builder builder) {
this.protocolMetadata = builder.protocolMetadata.build();
this.modeledExceptions = unmodifiableList(builder.modeledExceptions);
this.defaultServiceExceptionSupplier = builder.defaultServiceExceptionSupplier;
this.customErrorCodeFieldName = builder.customErrorCodeFieldName;
this.hasAwsQueryCompatible = builder.hasAwsQueryCompatible;
this.clientConfiguration = builder.clientConfiguration;
Boolean enableFastUnmarshalling = false;
if (clientConfiguration != null) {
enableFastUnmarshalling =
clientConfiguration.option(SdkClientJsonProtocolAdvancedOption.ENABLE_FAST_UNMARSHALLER);
if (enableFastUnmarshalling == null) {
enableFastUnmarshalling = false;
}
}
this.protocolUnmarshaller = JsonProtocolUnmarshaller.builder()
.enableFastUnmarshalling(enableFastUnmarshalling)
.protocolUnmarshallDependencies(
builder.protocolUnmarshallDependencies.get())
.build();
}
/**
* Creates a new response handler with the given {@link JsonOperationMetadata} and a supplier of the POJO response
* type.
*
* @param operationMetadata Metadata about operation being unmarshalled.
* @param pojoSupplier {@link Supplier} of the POJO response type.
* @param Type being unmarshalled.
* @return HttpResponseHandler that will handle the HTTP response and unmarshall into a POJO.
*/
public final HttpResponseHandler createResponseHandler(JsonOperationMetadata operationMetadata,
Supplier pojoSupplier) {
return createResponseHandler(operationMetadata, r -> pojoSupplier.get());
}
/**
* Creates a new response handler with the given {@link JsonOperationMetadata} and a supplier of the POJO response
* type.
*
* @param operationMetadata Metadata about operation being unmarshalled.
* @param pojoSupplier {@link Supplier} of the POJO response type. Has access to the HTTP response, primarily for polymorphic
* deserialization as seen in event stream (i.e. unmarshalled event depends on ':event-type' header).
* @param Type being unmarshalled.
* @return HttpResponseHandler that will handle the HTTP response and unmarshall into a POJO.
*/
public final HttpResponseHandler createResponseHandler(
JsonOperationMetadata operationMetadata,
Function pojoSupplier) {
return timeUnmarshalling(
new AwsJsonResponseHandler<>(
new JsonResponseHandler<>(protocolUnmarshaller,
pojoSupplier,
operationMetadata.hasStreamingSuccessResponse(),
operationMetadata.isPayloadJson())));
}
/**
* Creates a response handler for handling a error response (non 2xx response).
*
* @deprecated Users should favor using
* {@link BaseAwsJsonProtocolFactory#createErrorResponseHandler(JsonOperationMetadata, Function)}, which allows the creation
* of an error unmarshaller that uses a mapping function to map from error code to the associated {@link ExceptionMetadata}.
*/
@Deprecated
public final HttpResponseHandler createErrorResponseHandler(
JsonOperationMetadata errorResponseMetadata) {
return timeUnmarshalling(AwsJsonProtocolErrorUnmarshaller
.builder()
.jsonProtocolUnmarshaller(protocolUnmarshaller)
.exceptions(modeledExceptions)
.errorCodeParser(getSdkFactory().getErrorCodeParser(customErrorCodeFieldName))
.hasAwsQueryCompatible(hasAwsQueryCompatible)
.errorMessageParser(AwsJsonErrorMessageParser.DEFAULT_ERROR_MESSAGE_PARSER)
.jsonFactory(getSdkFactory().getJsonFactory())
.defaultExceptionSupplier(defaultServiceExceptionSupplier)
.build());
}
public final HttpResponseHandler createErrorResponseHandler(
JsonOperationMetadata errorResponseMetadata,
Function> exceptionMetadataSupplier) {
return timeUnmarshalling(
AwsJsonProtocolErrorUnmarshaller.builder()
.jsonProtocolUnmarshaller(protocolUnmarshaller)
.exceptionMetadataSupplier(exceptionMetadataSupplier)
.errorCodeParser(getSdkFactory().getErrorCodeParser(customErrorCodeFieldName))
.hasAwsQueryCompatible(hasAwsQueryCompatible)
.errorMessageParser(AwsJsonErrorMessageParser.DEFAULT_ERROR_MESSAGE_PARSER)
.jsonFactory(getSdkFactory().getJsonFactory())
.defaultExceptionSupplier(defaultServiceExceptionSupplier)
.build());
}
private MetricCollectingHttpResponseHandler timeUnmarshalling(HttpResponseHandler delegate) {
return MetricCollectingHttpResponseHandler.create(CoreMetric.UNMARSHALLING_DURATION, delegate);
}
private StructuredJsonGenerator createGenerator(OperationInfo operationInfo) {
Boolean generatesBody = operationInfo.addtionalMetadata(GENERATES_BODY);
if (generatesBody == null) {
AwsJsonProtocol protocol = protocolMetadata.protocol();
generatesBody = ProtocolFact.from(protocol).generatesBody(operationInfo);
}
if (!generatesBody) {
return StructuredJsonGenerator.NO_OP;
}
return createGenerator();
}
@SdkTestInternalApi
private StructuredJsonGenerator createGenerator() {
return getSdkFactory().createWriter(getContentType());
}
@SdkTestInternalApi
public final String getContentType() {
return protocolMetadata.contentType() != null ? protocolMetadata.contentType()
: getContentTypeResolver().resolveContentType(protocolMetadata);
}
/**
* @return Content type resolver implementation to use.
*/
protected JsonContentTypeResolver getContentTypeResolver() {
return AWS_JSON;
}
/**
* @return Instance of {@link StructuredJsonFactory} to use in creating handlers.
*/
protected StructuredJsonFactory getSdkFactory() {
return AwsStructuredPlainJsonFactory.SDK_JSON_FACTORY;
}
/**
* @return The default timestamp format for unmarshalling for each location in the response. This
* can be overridden by subclasses to customize behavior.
*/
protected Map getDefaultTimestampFormats() {
Map formats = new EnumMap<>(MarshallLocation.class);
formats.put(MarshallLocation.HEADER, TimestampFormatTrait.Format.RFC_822);
formats.put(MarshallLocation.PAYLOAD, TimestampFormatTrait.Format.UNIX_TIMESTAMP);
return Collections.unmodifiableMap(formats);
}
public final ProtocolMarshaller createProtocolMarshaller(OperationInfo operationInfo) {
return JsonProtocolMarshallerBuilder.create()
.endpoint(endpoint(clientConfiguration))
.jsonGenerator(createGenerator(operationInfo))
.contentType(getContentType())
.operationInfo(operationInfo)
.sendExplicitNullForPayload(false)
.protocolMetadata(protocolMetadata)
.hasAwsQueryCompatible(hasAwsQueryCompatible)
.build();
}
private URI endpoint(SdkClientConfiguration clientConfiguration) {
ClientEndpointProvider endpointProvider = clientConfiguration.option(SdkClientOption.CLIENT_ENDPOINT_PROVIDER);
if (endpointProvider != null) {
return endpointProvider.clientEndpoint();
}
// Some old client versions may not use the endpoint provider. In that case, use the legacy endpoint field.
return clientConfiguration.option(SdkClientOption.ENDPOINT);
}
/**
* Builder for {@link AwsJsonProtocolFactory}.
*/
public abstract static class Builder {
protected Supplier protocolUnmarshallDependencies =
JsonProtocolUnmarshaller::defaultProtocolUnmarshallDependencies;
private final AwsJsonProtocolMetadata.Builder protocolMetadata = AwsJsonProtocolMetadata.builder();
private final List modeledExceptions = new ArrayList<>();
private Supplier defaultServiceExceptionSupplier;
private String customErrorCodeFieldName;
private SdkClientConfiguration clientConfiguration;
private boolean hasAwsQueryCompatible;
protected Builder() {
}
/**
* Registers a new modeled exception by the error code.
*
* @param errorMetadata Metadata to unmarshall the modeled exception.
* @return This builder for method chaining.
*
* @deprecated Users should favor using
* {@link BaseAwsJsonProtocolFactory#createErrorResponseHandler(JsonOperationMetadata, Function)}, which allows the
* creation of an error unmarshaller that uses a mapping function to map from error code to the associated
* {@link ExceptionMetadata}.
*/
@Deprecated
public final SubclassT registerModeledException(ExceptionMetadata errorMetadata) {
modeledExceptions.add(errorMetadata);
return getSubclass();
}
/**
* A supplier for the services base exception builder. This is used when we can't identify any modeled
* exception to unmarshall into.
*
* @param exceptionBuilderSupplier Suppplier of the base service exceptions Builder.
* @return This builder for method chaining.
*/
public final SubclassT defaultServiceExceptionSupplier(Supplier exceptionBuilderSupplier) {
this.defaultServiceExceptionSupplier = exceptionBuilderSupplier;
return getSubclass();
}
/**
* @param protocol Protocol of the client (i.e. REST or RPC).
* @return This builder for method chaining.
*/
public final SubclassT protocol(AwsJsonProtocol protocol) {
protocolMetadata.protocol(protocol);
return getSubclass();
}
/**
* Protocol version of the client (right now supports JSON 1.0 and JSON 1.1). Used to determine content type.
*
* @param protocolVersion JSON protocol version.
* @return This builder for method chaining.
*/
public final SubclassT protocolVersion(String protocolVersion) {
protocolMetadata.protocolVersion(protocolVersion);
return getSubclass();
}
/**
* ContentType of the client (By default it is used from {@link #AWS_JSON} ).
* Used to determine content type.
*
* @param contentType JSON protocol contentType.
* @return This builder for method chaining.
*/
public final SubclassT contentType(String contentType) {
protocolMetadata.contentType(contentType);
return getSubclass();
}
/**
* Custom field name containing the error code that identifies the exception. Currently only used by Glacier
* which uses the "code" field instead of the traditional "__type".
*
* @param customErrorCodeFieldName Custom field name to look for error code.
* @return This builder for method chaining.
*/
public final SubclassT customErrorCodeFieldName(String customErrorCodeFieldName) {
this.customErrorCodeFieldName = customErrorCodeFieldName;
return getSubclass();
}
/**
* Sets the {@link SdkClientConfiguration} which contains the service endpoint.
*
* @param clientConfiguration Configuration of the client.
* @return This builder for method chaining.
*/
public final SubclassT clientConfiguration(SdkClientConfiguration clientConfiguration) {
this.clientConfiguration = clientConfiguration;
return getSubclass();
}
/**
* Provides a check on whether AwsQueryCompatible trait is found in Metadata.
* If true, custom error codes can be provided
*
* @param hasAwsQueryCompatible boolean of whether the AwsQueryCompatible trait is found
* @return This builder for method chaining.
*/
public final SubclassT hasAwsQueryCompatible(boolean hasAwsQueryCompatible) {
this.hasAwsQueryCompatible = hasAwsQueryCompatible;
return getSubclass();
}
/**
* Provides the unmarshalling dependencies instance.
*
* @param protocolUnmarshallDependencies the set of dependencies used to create an unmarshaller
* @return This builder for method chaining.
*/
protected final SubclassT protocolUnmarshallDependencies(
Supplier protocolUnmarshallDependencies
) {
this.protocolUnmarshallDependencies = protocolUnmarshallDependencies;
return getSubclass();
}
@SuppressWarnings("unchecked")
private SubclassT getSubclass() {
return (SubclassT) this;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy