software.amazon.awssdk.transfer.s3.internal.serialization.TransferManagerMarshallingUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of s3-transfer-manager Show documentation
The S3 Transfer Manager allows customers to easily and optimally transfer objects and directories to and from S3.
There is a newer version: 2.28.4
/*
 * 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.transfer.s3.internal.serialization;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Function;
import java.util.stream.Collectors;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;
import software.amazon.awssdk.services.s3.model.PutObjectRequest;

/**
 * Marshallers and unmarshallers for serializing objects in TM, using the SDK request {@link MarshallingType}.
 * 
 * Excluded marshalling types that should not appear inside a POJO like GetObjectRequest:
 * 

 *     MarshallingType.SDK_POJO
 *     MarshallingType.DOCUMENT
 *     MarshallingType.MAP
 *     MarshallingType.LIST
 * 
 * 
 * Note: unmarshalling generic List structures is not supported at this time
 */
@SdkInternalApi
public final class TransferManagerMarshallingUtils {

    private static final Map, TransferManagerJsonMarshaller> MARSHALLERS;
    private static final Map, TransferManagerJsonUnmarshaller> UNMARSHALLERS;
    private static final Map> GET_OBJECT_SDK_FIELDS;
    private static final Map> PUT_OBJECT_SDK_FIELDS;

    static {
        Map, TransferManagerJsonMarshaller> marshallers = new HashMap<>();
        marshallers.put(MarshallingType.STRING, TransferManagerJsonMarshaller.STRING);
        marshallers.put(MarshallingType.SHORT, TransferManagerJsonMarshaller.SHORT);
        marshallers.put(MarshallingType.INTEGER, TransferManagerJsonMarshaller.INTEGER);
        marshallers.put(MarshallingType.LONG, TransferManagerJsonMarshaller.LONG);
        marshallers.put(MarshallingType.INSTANT, TransferManagerJsonMarshaller.INSTANT);
        marshallers.put(MarshallingType.NULL, TransferManagerJsonMarshaller.NULL);
        marshallers.put(MarshallingType.FLOAT, TransferManagerJsonMarshaller.FLOAT);
        marshallers.put(MarshallingType.DOUBLE, TransferManagerJsonMarshaller.DOUBLE);
        marshallers.put(MarshallingType.BIG_DECIMAL, TransferManagerJsonMarshaller.BIG_DECIMAL);
        marshallers.put(MarshallingType.BOOLEAN, TransferManagerJsonMarshaller.BOOLEAN);
        marshallers.put(MarshallingType.SDK_BYTES, TransferManagerJsonMarshaller.SDK_BYTES);
        marshallers.put(MarshallingType.LIST, TransferManagerJsonMarshaller.LIST);
        marshallers.put(MarshallingType.MAP, TransferManagerJsonMarshaller.MAP);
        MARSHALLERS = Collections.unmodifiableMap(marshallers);

        Map, TransferManagerJsonUnmarshaller> unmarshallers = new HashMap<>();
        unmarshallers.put(MarshallingType.STRING, TransferManagerJsonUnmarshaller.STRING);
        unmarshallers.put(MarshallingType.SHORT, TransferManagerJsonUnmarshaller.SHORT);
        unmarshallers.put(MarshallingType.INTEGER, TransferManagerJsonUnmarshaller.INTEGER);
        unmarshallers.put(MarshallingType.LONG, TransferManagerJsonUnmarshaller.LONG);
        unmarshallers.put(MarshallingType.INSTANT, TransferManagerJsonUnmarshaller.INSTANT);
        unmarshallers.put(MarshallingType.NULL, TransferManagerJsonUnmarshaller.NULL);
        unmarshallers.put(MarshallingType.FLOAT, TransferManagerJsonUnmarshaller.FLOAT);
        unmarshallers.put(MarshallingType.DOUBLE, TransferManagerJsonUnmarshaller.DOUBLE);
        unmarshallers.put(MarshallingType.BIG_DECIMAL, TransferManagerJsonUnmarshaller.BIG_DECIMAL);
        unmarshallers.put(MarshallingType.BOOLEAN, TransferManagerJsonUnmarshaller.BOOLEAN);
        unmarshallers.put(MarshallingType.SDK_BYTES, TransferManagerJsonUnmarshaller.SDK_BYTES);
        unmarshallers.put(MarshallingType.MAP, TransferManagerJsonUnmarshaller.MAP);
        UNMARSHALLERS = Collections.unmodifiableMap(unmarshallers);

        GET_OBJECT_SDK_FIELDS = Collections.unmodifiableMap(
            GetObjectRequest.builder().build()
                            .sdkFields().stream()
                            .collect(Collectors.toMap(SdkField::locationName, Function.identity())));

        PUT_OBJECT_SDK_FIELDS = Collections.unmodifiableMap(
            PutObjectRequest.builder().build()
                            .sdkFields().stream()
                            .collect(Collectors.toMap(SdkField::locationName, Function.identity())));
    }

    private TransferManagerMarshallingUtils() {
    }

    @SuppressWarnings("unchecked")
    public static  TransferManagerJsonMarshaller getMarshaller(T val) {
        MarshallingType tMarshallingType = toMarshallingType(val);
        return getMarshaller(tMarshallingType, val);
    }

    @SuppressWarnings("unchecked")
    private static  MarshallingType toMarshallingType(T val) {
        MarshallingType marshallingType = MarshallingType.NULL;
        if (val != null) {
            marshallingType =
                MARSHALLERS.keySet()
                           .stream()
                           .filter(type -> type.getTargetClass()
                                               .isAssignableFrom(val.getClass()))
                           .findFirst()
                           .orElse(MarshallingType.NULL);
        }
        return (MarshallingType) marshallingType;
    }

    @SuppressWarnings("unchecked")
    public static  TransferManagerJsonMarshaller getMarshaller(MarshallingType marshallingType, T val) {
        TransferManagerJsonMarshaller marshaller = MARSHALLERS.get(val == null ? MarshallingType.NULL : marshallingType);
        if (marshaller == null) {
            throw new IllegalStateException(String.format("Cannot find a marshaller for marshalling type %s", marshallingType));
        }
        return (TransferManagerJsonMarshaller) marshaller;
    }

    public static TransferManagerJsonUnmarshaller getUnmarshaller(MarshallingType marshallingType) {
        TransferManagerJsonUnmarshaller unmarshaller = UNMARSHALLERS.get(marshallingType);
        if (unmarshaller == null) {
            throw new IllegalStateException(String.format("Cannot find an unmarshaller for marshalling type %s",
                                                          marshallingType));
        }
        return unmarshaller;
    }

    public static SdkField getObjectSdkField(String key) {
        SdkField sdkField = GET_OBJECT_SDK_FIELDS.get(key);
        if (sdkField != null) {
            return sdkField;
        }
        throw new IllegalStateException("Could not match a field in GetObjectRequest");
    }

    public static SdkField putObjectSdkField(String key) {
        SdkField sdkField = PUT_OBJECT_SDK_FIELDS.get(key);
        if (sdkField != null) {
            return sdkField;
        }
        throw new IllegalStateException("Could not match a field in PutObjectRequest");
    }
}