com.palantir.dialogue.RequestBody Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dialogue-target Show documentation

Palantir open source project

There is a newer version: 4.7.0

/*
 * (c) Copyright 2019 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.dialogue;

import java.io.Closeable;
import java.io.IOException;
import java.io.OutputStream;
import java.util.OptionalLong;

public interface RequestBody extends Closeable {

    /** The content of this request body, possibly empty. */
    void writeTo(OutputStream output) throws IOException;

    /** A HTTP/Conjure content type (e.g., "application/json") indicating the type of content. */
    String contentType();

    /** Returns true if {@link #writeTo(OutputStream)} may be invoked multiple times. */
    boolean repeatable();

    /** Returns the content length, if known. */
    default OptionalLong contentLength() {
        return OptionalLong.empty();
    }

    /**
     * Closes this {@link RequestBody} and releases all resources. Calling {@link #close()} should never throw,
     * preferring to catch and log.
     */
    @Override
    void close();
}