org.glassfish.grizzly.http2.HeaderDecodingException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grizzly-http-all Show documentation
The newest version!
/*
 * Copyright (c) 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.grizzly.http2;

import org.glassfish.grizzly.http2.frames.ErrorCode;

public class HeaderDecodingException extends RuntimeException {

    private final ErrorCode errorCode;
    private final ErrorType errorType;

    enum ErrorType {
        STREAM, SESSION
    }

    /**
     * Construct HeaderDecodingException.
     *
     * @param errorCode the {@link ErrorCode} for this {@link HeaderDecodingException}
     */
    public HeaderDecodingException(final ErrorCode errorCode, final ErrorType errorType) {
        this(errorCode, errorType, null);
    }

    /**
     * Construct HeaderDecodingException.
     *
     * @param errorCode the {@link ErrorCode} for this {@link HeaderDecodingException}
     * @param message the detail message for this {@link HeaderDecodingException}
     */
    public HeaderDecodingException(final ErrorCode errorCode, final ErrorType errorType, final String message) {
        super(message);
        this.errorCode = errorCode;
        this.errorType = errorType;
    }

    /**
     * @return the {@link ErrorCode} reason to be sent with a GOAWAY or RST frame.
     */
    public ErrorCode getErrorCode() {
        return errorCode;
    }

    /**
     * @return the {@link ErrorType} to control the type of frame to be sent to the peer.
     */
    public ErrorType getErrorType() {
        return errorType;
    }

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder(128);
        sb.append(getClass().getName()).append(" errorCode=").append(errorCode).append(" errorType=").append(errorType);

        String message = getLocalizedMessage();

        return message != null ? sb.append(": ").append(message).toString() : sb.toString();
    }

}