com.nike.riposte.server.http.impl.ChunkedResponseInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of riposte-spi Show documentation
Riposte module riposte-spi
There is a newer version: 0.20.0
package com.nike.riposte.server.http.impl;

import java.nio.charset.Charset;
import java.util.Set;

import io.netty.handler.codec.http.HttpHeaders;
import io.netty.handler.codec.http.cookie.Cookie;

/**
 * An extension of {@link BaseResponseInfo} that represents chunked (not full) responses. {@link #isChunkedResponse()}
 * will return true, and exceptions will be thrown if you try to treat this class as a full response. You should use the
 * {@link ChunkedResponseInfoBuilder} to create new instances.
 *
 * @author Nic Munroe
 */
@SuppressWarnings("WeakerAccess")
public class ChunkedResponseInfo extends BaseResponseInfo {

    /**
     * The "populate everything" constructor. It's recommended that you use the {@link ChunkedResponseInfoBuilder}
     * instead.
     */
    public ChunkedResponseInfo(Integer httpStatusCode, HttpHeaders headers,
                               String desiredContentWriterMimeType,
                               Charset desiredContentWriterEncoding,
                               Set cookies,
                               boolean preventCompressedOutput) {

        super(httpStatusCode, headers, desiredContentWriterMimeType, desiredContentWriterEncoding, cookies,
              preventCompressedOutput);
    }

    /**
     * Creates a new blank instance. Identical to calling {@code newBuilder().build()}.
     */
    public ChunkedResponseInfo() {
        this(null, null, null, null, null, false);
    }

    /**
     * Since this is a chunked response, this method always returns true.
     */
    public boolean isChunkedResponse() {
        return true;
    }

    @Override
    public Void getContentForFullResponse() {
        throw new IllegalStateException(
            "Attempted to call getContentForFullResponse() when isChunkedResponse() is true. Always verify that "
            + "isChunkedResponse() returns false before calling this method."
        );
    }

    @Override
    public void setContentForFullResponse(Void contentForFullResponse) {
        throw new IllegalStateException("isChunkedResponse() is true. You cannot add full response content to a "
                                        + "chunked response.");
    }

    /**
     * Base Builder for {@link ChunkedResponseInfo}. Create one of these with {@link #newBuilder()} or {@link
     * #newBuilder(Object)}.
     */
    public static final class ChunkedResponseInfoBuilder extends BaseResponseInfoBuilder {

        public ChunkedResponseInfoBuilder() {
        }

        @Override
        public ChunkedResponseInfoBuilder withHttpStatusCode(Integer httpStatusCode) {
            super.withHttpStatusCode(httpStatusCode);
            return this;
        }

        @Override
        public ChunkedResponseInfoBuilder withHeaders(HttpHeaders headers) {
            super.withHeaders(headers);
            return this;
        }

        @Override
        public ChunkedResponseInfoBuilder withDesiredContentWriterMimeType(String desiredContentWriterMimeType) {
            super.withDesiredContentWriterMimeType(desiredContentWriterMimeType);
            return this;
        }

        @Override
        public ChunkedResponseInfoBuilder withDesiredContentWriterEncoding(Charset desiredContentWriterEncoding) {
            super.withDesiredContentWriterEncoding(desiredContentWriterEncoding);
            return this;
        }

        @Override
        public ChunkedResponseInfoBuilder withCookies(Set cookies) {
            super.withCookies(cookies);
            return this;
        }

        @Override
        public ChunkedResponseInfoBuilder withPreventCompressedOutput(boolean preventCompressedOutput) {
            super.withPreventCompressedOutput(preventCompressedOutput);
            return this;
        }

        /**
         * @return A {@link ChunkedResponseInfo} setup with all the values contained in this builder.
         */
        public ChunkedResponseInfo build() {
            return new ChunkedResponseInfo(
                getHttpStatusCode(),
                getHeaders(),
                getDesiredContentWriterMimeType(),
                getDesiredContentWriterEncoding(),
                getCookies(),
                isPreventCompressedOutput()
            );
        }
    }

}