io.micronaut.http.ByteBodyHttpResponseWrapper Maven / Gradle / Ivy

Go to download

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

Natively Cloud Native

The newest version!

/*
 * Copyright 2017-2024 original authors
 *
 * 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
 *
 * https://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 io.micronaut.http;

import io.micronaut.core.annotation.Experimental;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.http.body.ByteBody;
import io.micronaut.http.body.CloseableByteBody;

/**
 * Simple response wrapper to implement {@link ByteBodyHttpResponse}.
 *
 * @param  The original body type
 * @since 4.7.0
 * @author Jonas Konrad
 */
@Experimental
public final class ByteBodyHttpResponseWrapper extends HttpResponseWrapper implements ByteBodyHttpResponse {
    private final CloseableByteBody byteBody;

    private ByteBodyHttpResponseWrapper(HttpResponse delegate, CloseableByteBody byteBody) {
        super(delegate);
        this.byteBody = byteBody;
    }

    /**
     * Attach a body to the given response.
     *
     * @param delegate The original response to be used for e.g. headers and status
     * @param byteBody The bytes to respond with
     * @return A {@link ByteBodyHttpResponse} implementation with the given response and bytes
     */
    @NonNull
    public static ByteBodyHttpResponse wrap(@NonNull HttpResponse delegate, @NonNull CloseableByteBody byteBody) {
        return new ByteBodyHttpResponseWrapper<>(delegate, byteBody);
    }

    @Override
    public @NonNull ByteBody byteBody() {
        return byteBody;
    }

    @Override
    public void close() {
        byteBody.close();
    }
}