com.nike.riposte.server.http.impl.FullResponseInfo 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 full (not chunked) responses. {@link #isChunkedResponse()}
 * will return false, and support has been added for the full content (i.e. {@link #getContentForFullResponse()} and
 * {@link #setContentForFullResponse(Object)} are implemented). You should use the {@link FullResponseInfoBuilder} to
 * create new instances.
 *
 * @author Nic Munroe
 */
public class FullResponseInfo extends BaseResponseInfo {

    @SuppressWarnings("WeakerAccess")
    protected T contentForFullResponse;

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

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

        this.contentForFullResponse = contentForFullResponse;
    }

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

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

    @Override
    public T getContentForFullResponse() {
        return contentForFullResponse;
    }

    @Override
    public void setContentForFullResponse(T contentForFullResponse) {
        if (isResponseSendingLastChunkSent()) {
            throw new IllegalStateException("isFullResponseSent() is true. You cannot set content for a response that "
                                            + "has already been sent to the user.");
        }

        this.contentForFullResponse = contentForFullResponse;
    }

    /**
     * Base Builder for {@link FullResponseInfo}. Create one of these with {@link #newBuilder()} or {@link
     * #newBuilder(Object)}.
     *
     * @param 
     *     The type of the response body content.
     */
    public static final class FullResponseInfoBuilder extends BaseResponseInfoBuilder {

        private T contentForFullResponse;

        public FullResponseInfoBuilder() {

        }

        /**
         * Populates this builder with the given content intended for a full response. Can be null if there is no
         * response body content to send.
         */
        public FullResponseInfoBuilder withContentForFullResponse(T content) {
            this.contentForFullResponse = content;
            return this;
        }

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

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

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

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

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

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

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

}