org.dmfs.httpessentials.entities.BinaryRequestEntity Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of http-client-basics Show documentation

Basic implementations of http-client-essentials that are frequently used.

There is a newer version: 1.22.1

/*
 * Copyright 2017 dmfs GmbH
 *
 *
 * 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 org.dmfs.httpessentials.entities;

import org.dmfs.httpessentials.client.HttpRequestEntity;
import org.dmfs.httpessentials.types.MediaType;
import org.dmfs.jems.single.Single;
import org.dmfs.optional.Optional;
import org.dmfs.optional.Present;

import java.io.IOException;
import java.io.OutputStream;


/**
 * A basic {@link HttpRequestEntity} with binary data. This is meant to be used as a delegate for higher level request entities.
 * 
 * Note, this is meant to be used for requests with a message body and always expects a valid {@link MediaType}.
 *
 * @author Marten Gajda
 */
public final class BinaryRequestEntity implements HttpRequestEntity
{
    private final MediaType mMediaType;
    private final Single mData;


    public BinaryRequestEntity(MediaType mediaType, Single data)
    {
        mMediaType = mediaType;
        mData = data;
    }


    @Override
    public Optional contentType()
    {
        return new Present<>(mMediaType);
    }


    @Override
    public Optional contentLength()
    {
        return new Present<>((long) mData.value().length);
    }


    @Override
    public void writeContent(OutputStream out) throws IOException
    {
        out.write(mData.value());
    }
}