io.servicetalk.http.netty.H1SpecExceptions Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of servicetalk-http-netty Show documentation
A networking framework that evolves with your application
The newest version!
/*
 * Copyright © 2020-2022 Apple Inc. and the ServiceTalk project 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
 *
 *   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 io.servicetalk.http.netty;

/**
 * Additional exceptions for HTTP/1.1 specification.
 */
public final class H1SpecExceptions {

    private final boolean allowPrematureClosureBeforePayloadBody;
    private final boolean allowLFWithoutCR;

    private H1SpecExceptions(final boolean allowPrematureClosureBeforePayloadBody,
                             final boolean allowLFWithoutCR) {
        this.allowPrematureClosureBeforePayloadBody = allowPrematureClosureBeforePayloadBody;
        this.allowLFWithoutCR = allowLFWithoutCR;
    }

    /**
     * Allows interpreting connection closures as the end of HTTP/1.1 messages if the receiver did not receive any part
     * of the payload body before the connection closure.
     *
     * @return {@code true} if the receiver should interpret connection closures as the end of HTTP/1.1 messages if it
     * did not receive any part of the payload body before the connection closure
     */
    public boolean allowPrematureClosureBeforePayloadBody() {
        return allowPrematureClosureBeforePayloadBody;
    }

    /**
     * Allow {@code LF} without a proceeding {@code CR} as described in
     * HTTP/1.x Message Parsing Robustness:
     *      *   Although the line terminator for the start-line and header fields is
     *   the sequence CRLF, a recipient MAY recognize a single LF as a line
     *   terminator and ignore any preceding CR.
     * 
     * @return {@code true} to allow {@code LF} without a proceeding {@code CR}.
     */
    public boolean allowLFWithoutCR() {
        return allowLFWithoutCR;
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() +
                "{allowPrematureClosureBeforePayloadBody=" + allowPrematureClosureBeforePayloadBody +
                ", allowLFWithoutCR=" + allowLFWithoutCR +
                '}';
    }

    /**
     * Builder for {@link H1SpecExceptions}.
     */
    public static final class Builder {

        private boolean allowPrematureClosureBeforePayloadBody;
        private boolean allowLFWithoutCR;

        /**
         * Allows interpreting connection closures as the end of HTTP/1.1 messages if the receiver did not receive any
         * part of the payload body before the connection closure.
         * @param allow {@code true} if the receiver should interpret connection closures as the end of HTTP/1.1
         * messages if it did not receive any part of the payload body before the connection closure.
         * @return {@code this}
         */
        public Builder allowPrematureClosureBeforePayloadBody(boolean allow) {
            this.allowPrematureClosureBeforePayloadBody = allow;
            return this;
        }

        /**
         * Allow {@code LF} without a proceeding {@code CR} as described in
         * HTTP/1.x Message Parsing Robustness:
         *          *   Although the line terminator for the start-line and header fields is
         *   the sequence CRLF, a recipient MAY recognize a single LF as a line
         *   terminator and ignore any preceding CR.
         * 
         * @param allow {@code true} to allow {@code LF} without a proceeding {@code CR}.
         * @return {@code this}
         */
        public Builder allowLFWithoutCR(boolean allow) {
            this.allowLFWithoutCR = allow;
            return this;
        }

        /**
         * Builds {@link H1SpecExceptions}.
         *
         * @return a new {@link H1SpecExceptions}
         */
        public H1SpecExceptions build() {
            return new H1SpecExceptions(allowPrematureClosureBeforePayloadBody, allowLFWithoutCR);
        }
    }
}