com.ibm.cloud.objectstorage.protocol.json.internal.JsonProtocolMarshaller Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibm-cos-java-sdk-core Show documentation
Show all versions of ibm-cos-java-sdk-core Show documentation
The IBM COS SDK for Java - Core module holds the classes that are used by the individual service clients to interact with IBM Cloud Object Storage. Users need to depend on cos-java-sdk artifact for accessing individual client classes.
/*
* Copyright 2011-2017 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 divalibuted
* 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 com.ibm.cloud.objectstorage.protocol.json.internal;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.nio.ByteBuffer;
import com.ibm.cloud.objectstorage.AmazonWebServiceRequest;
import com.ibm.cloud.objectstorage.DefaultRequest;
import com.ibm.cloud.objectstorage.Request;
import com.ibm.cloud.objectstorage.annotation.SdkInternalApi;
import com.ibm.cloud.objectstorage.protocol.MarshallingInfo;
import com.ibm.cloud.objectstorage.protocol.MarshallingType;
import com.ibm.cloud.objectstorage.protocol.OperationInfo;
import com.ibm.cloud.objectstorage.protocol.ProtocolMarshaller;
import com.ibm.cloud.objectstorage.protocol.ProtocolRequestMarshaller;
import com.ibm.cloud.objectstorage.protocol.json.StructuredJsonGenerator;
import com.ibm.cloud.objectstorage.util.BinaryUtils;
import com.ibm.cloud.objectstorage.util.UriResourcePathUtils;
/**
* Implementation of {@link ProtocolMarshaller} for JSON based services. This includes JSON-RPC and REST-JSON.
*
* @param Type of the original request object.
*/
@SdkInternalApi
public class JsonProtocolMarshaller implements ProtocolRequestMarshaller {
private static final MarshallerRegistry marshallerRegistry = createMarshallerRegistry();
private final StructuredJsonGenerator jsonGenerator;
private final Request request;
private final String contentType;
private final boolean hasExplicitPayloadMember;
private final JsonMarshallerContext marshallerContext;
public JsonProtocolMarshaller(StructuredJsonGenerator jsonGenerator,
String contentType,
OperationInfo operationInfo,
OrigRequest originalRequest) {
this.jsonGenerator = jsonGenerator;
this.contentType = contentType;
this.hasExplicitPayloadMember = operationInfo.hasExplicitPayloadMember();
this.request = fillBasicRequestParams(operationInfo, originalRequest);
this.marshallerContext = JsonMarshallerContext.builder()
.jsonGenerator(jsonGenerator)
.marshallerRegistry(marshallerRegistry)
.protocolHandler(this)
.request(request)
.build();
}
private Request fillBasicRequestParams(OperationInfo operationInfo, OrigRequest originalRequest) {
Request request = createRequest(operationInfo, originalRequest);
request.setHttpMethod(operationInfo.httpMethodName());
request.setResourcePath(UriResourcePathUtils.addStaticQueryParamtersToRequest(request, operationInfo.requestUri()));
if (operationInfo.operationIdentifier() != null) {
request.addHeader("X-Amz-Target", operationInfo.operationIdentifier());
}
return request;
}
private DefaultRequest createRequest(OperationInfo operationInfo, OrigRequest originalRequest) {
if (originalRequest instanceof AmazonWebServiceRequest) {
return new DefaultRequest((AmazonWebServiceRequest) originalRequest, operationInfo.serviceName());
} else {
return new DefaultRequest(operationInfo.serviceName());
}
}
private static MarshallerRegistry createMarshallerRegistry() {
return MarshallerRegistry.builder()
.payloadMarshaller(MarshallingType.STRING, SimpleTypeJsonMarshallers.STRING)
.payloadMarshaller(MarshallingType.JSON_VALUE, SimpleTypeJsonMarshallers.STRING)
.payloadMarshaller(MarshallingType.INTEGER, SimpleTypeJsonMarshallers.INTEGER)
.payloadMarshaller(MarshallingType.LONG, SimpleTypeJsonMarshallers.LONG)
.payloadMarshaller(MarshallingType.DOUBLE, SimpleTypeJsonMarshallers.DOUBLE)
.payloadMarshaller(MarshallingType.FLOAT, SimpleTypeJsonMarshallers.FLOAT)
.payloadMarshaller(MarshallingType.BIG_DECIMAL, SimpleTypeJsonMarshallers.BIG_DECIMAL)
.payloadMarshaller(MarshallingType.BOOLEAN, SimpleTypeJsonMarshallers.BOOLEAN)
.payloadMarshaller(MarshallingType.DATE, SimpleTypeJsonMarshallers.DATE)
.payloadMarshaller(MarshallingType.BYTE_BUFFER, SimpleTypeJsonMarshallers.BYTE_BUFFER)
.payloadMarshaller(MarshallingType.STRUCTURED, SimpleTypeJsonMarshallers.STRUCTURED)
.payloadMarshaller(MarshallingType.LIST, SimpleTypeJsonMarshallers.LIST)
.payloadMarshaller(MarshallingType.MAP, SimpleTypeJsonMarshallers.MAP)
.payloadMarshaller(MarshallingType.NULL, SimpleTypeJsonMarshallers.NULL)
.headerMarshaller(MarshallingType.STRING, HeaderMarshallers.STRING)
.headerMarshaller(MarshallingType.JSON_VALUE, HeaderMarshallers.JSON_VALUE)
.headerMarshaller(MarshallingType.INTEGER, HeaderMarshallers.INTEGER)
.headerMarshaller(MarshallingType.LONG, HeaderMarshallers.LONG)
.headerMarshaller(MarshallingType.DOUBLE, HeaderMarshallers.DOUBLE)
.headerMarshaller(MarshallingType.FLOAT, HeaderMarshallers.FLOAT)
.headerMarshaller(MarshallingType.BOOLEAN, HeaderMarshallers.BOOLEAN)
.headerMarshaller(MarshallingType.DATE, HeaderMarshallers.DATE)
.headerMarshaller(MarshallingType.NULL, JsonMarshaller.NULL)
.queryParamMarshaller(MarshallingType.STRING, QueryParamMarshallers.STRING)
.queryParamMarshaller(MarshallingType.INTEGER, QueryParamMarshallers.INTEGER)
.queryParamMarshaller(MarshallingType.LONG, QueryParamMarshallers.LONG)
.queryParamMarshaller(MarshallingType.DOUBLE, QueryParamMarshallers.DOUBLE)
.queryParamMarshaller(MarshallingType.FLOAT, QueryParamMarshallers.FLOAT)
.queryParamMarshaller(MarshallingType.BOOLEAN, QueryParamMarshallers.BOOLEAN)
.queryParamMarshaller(MarshallingType.DATE, QueryParamMarshallers.DATE)
.queryParamMarshaller(MarshallingType.LIST, QueryParamMarshallers.LIST)
.queryParamMarshaller(MarshallingType.MAP, QueryParamMarshallers.MAP)
.queryParamMarshaller(MarshallingType.NULL, JsonMarshaller.NULL)
.pathParamMarshaller(MarshallingType.STRING, SimpleTypePathMarshallers.STRING)
.pathParamMarshaller(MarshallingType.INTEGER, SimpleTypePathMarshallers.INTEGER)
.pathParamMarshaller(MarshallingType.LONG, SimpleTypePathMarshallers.LONG)
.pathParamMarshaller(MarshallingType.NULL, SimpleTypePathMarshallers.NULL)
.greedyPathParamMarshaller(MarshallingType.STRING, SimpleTypePathMarshallers.GREEDY_STRING)
.greedyPathParamMarshaller(MarshallingType.NULL, SimpleTypePathMarshallers.NULL)
.build();
}
/**
* If there is not an explicit payload member then we need to start the implicit JSON request object. All
* members bound to the payload will be added as fields to this object.
*/
@Override
public void startMarshalling() {
if (!hasExplicitPayloadMember) {
jsonGenerator.writeStartObject();
}
}
@Override
public void marshall(V val, MarshallingInfo marshallingInfo) {
doMarshall(resolveValue(val, marshallingInfo), marshallingInfo);
}
/**
* @return The original value if non-null, or if value is null and a {@link com.ibm.cloud.objectstorage.protocol.DefaultValueSupplier} is
* present return the default value. Otherwise return null.
*/
private V resolveValue(V val, MarshallingInfo marshallingInfo) {
return val == null && marshallingInfo.defaultValueSupplier() != null ? marshallingInfo.defaultValueSupplier().get() : val;
}
private void doMarshall(V val, MarshallingInfo marshallingInfo) {
if (marshallingInfo.isBinary()) {
marshallBinaryPayload(val);
} else {
marshallerRegistry.getMarshaller(marshallingInfo.marshallLocation(), marshallingInfo.marshallingType(), val)
.marshall(val, marshallerContext, marshallingInfo.marshallLocationName());
}
}
/**
* Binary data should be placed as is, directly into the content.
*/
private void marshallBinaryPayload(Object val) {
if (val instanceof ByteBuffer) {
request.setContent(BinaryUtils.toStream((ByteBuffer) val));
} else if (val instanceof InputStream) {
request.setContent((InputStream) val);
}
}
@Override
public Request finishMarshalling() {
// Content may already be set if the payload is binary data.
if (request.getContent() == null) {
// End the implicit request object if needed.
if (!hasExplicitPayloadMember) {
jsonGenerator.writeEndObject();
}
byte[] content = jsonGenerator.getBytes();
request.setContent(new ByteArrayInputStream(content));
if (content.length > 0) {
request.addHeader("Content-Length", Integer.toString(content.length));
}
}
if (!request.getHeaders().containsKey("Content-Type")) {
request.addHeader("Content-Type", contentType);
}
return request;
}
}