com.palantir.conjure.java.dialogue.serde.BinaryEncoding Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dialogue-serde Show documentation
Palantir open source project
There is a newer version: 4.7.0
/*
 * (c) Copyright 2020 Palantir Technologies Inc. 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.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 com.palantir.conjure.java.dialogue.serde;

import com.palantir.dialogue.TypeMarker;
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import java.io.InputStream;
import java.util.Optional;

/**
 * Package-private internal api.
 * This partial Encoding implementation exists to allow binary responses to share the same safety
 * and validation provided by structured encodings. This is only consumed internally to create
 * a binary-specific EncodingDeserializerRegistry.
 */
enum BinaryEncoding implements Encoding {
    INSTANCE;

    static final String CONTENT_TYPE = "application/octet-stream";
    static final TypeMarker MARKER = new TypeMarker() {};
    static final TypeMarker> OPTIONAL_MARKER = new TypeMarker>() {};

    @Override
    public  Serializer serializer(TypeMarker _type) {
        throw new UnsupportedOperationException("BinaryEncoding does not support serializers");
    }

    @Override
    @SuppressWarnings("unchecked")
    public  Deserializer deserializer(TypeMarker type) {
        if (MARKER.equals(type)) {
            return (Deserializer) InputStreamDeserializer.INSTANCE;
        } else if (OPTIONAL_MARKER.equals(type)) {
            return (Deserializer) OptionalInputStreamDeserializer.INSTANCE;
        }
        throw new SafeIllegalStateException(
                "BinaryEncoding only supports InputStream and Optional", SafeArg.of("requested", type));
    }

    @Override
    public String getContentType() {
        return CONTENT_TYPE;
    }

    @Override
    public boolean supportsContentType(String contentType) {
        return Encodings.matchesContentType(CONTENT_TYPE, contentType);
    }

    @Override
    public String toString() {
        return "BinaryEncoding{" + CONTENT_TYPE + '}';
    }

    enum OptionalInputStreamDeserializer implements Deserializer> {
        INSTANCE;

        @Override
        public Optional deserialize(InputStream input) {
            // intentionally not closing this, otherwise users wouldn't be able to get any data out of it!
            return Optional.of(input);
        }

        @Override
        public String toString() {
            return "OptionalInputStreamDeserializer{}";
        }
    }

    enum InputStreamDeserializer implements Deserializer {
        INSTANCE;

        @Override
        public InputStream deserialize(InputStream input) {
            // intentionally not closing this, otherwise users wouldn't be able to get any data out of it!
            return input;
        }

        @Override
        public String toString() {
            return "InputStreamDeserializer{}";
        }
    }
}