io.netty.handler.codec.http2

Class Http2Exception

java.lang.Object

java.lang.Throwable

java.lang.Exception

io.netty.handler.codec.http2.Http2Exception

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Http2Exception.ClosedStreamCreationException, Http2Exception.CompositeStreamException, Http2Exception.StreamException, Http2NoMoreStreamIdsException, StreamBufferingEncoder.Http2ChannelClosedException, StreamBufferingEncoder.Http2GoAwayException

@UnstableApi
public class Http2Exception
extends Exception

Exception thrown when an HTTP/2 error was encountered.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Http2Exception.ClosedStreamCreationException Used when a stream creation attempt fails but may be because the stream was previously closed.
static class	Http2Exception.CompositeStreamException Provides the ability to handle multiple stream exceptions with one throw statement.
static class	Http2Exception.HeaderListSizeException
static class	Http2Exception.ShutdownHint Provides a hint as to if shutdown is justified, what type of shutdown should be executed.
static class	Http2Exception.StreamException Represents an exception that can be isolated to a single stream (as opposed to the entire connection).

Constructor Summary

Constructors

Constructor and Description
Http2Exception(Http2Error error)
Http2Exception(Http2Error error, Http2Exception.ShutdownHint shutdownHint)
Http2Exception(Http2Error error, String message)
Http2Exception(Http2Error error, String message, Http2Exception.ShutdownHint shutdownHint)
Http2Exception(Http2Error error, String message, Throwable cause)
Http2Exception(Http2Error error, String message, Throwable cause, Http2Exception.ShutdownHint shutdownHint)

Method Summary

Modifier and Type	Method and Description
static Http2Exception	closedStreamError(Http2Error error, String fmt, Object... args) Use if an error has occurred which can not be isolated to a single stream, but instead applies to the entire connection.
static Http2Exception	connectionError(Http2Error error, String fmt, Object... args) Use if an error has occurred which can not be isolated to a single stream, but instead applies to the entire connection.
static Http2Exception	connectionError(Http2Error error, Throwable cause, String fmt, Object... args) Use if an error has occurred which can not be isolated to a single stream, but instead applies to the entire connection.
Http2Error	error()
static Http2Exception	headerListSizeError(int id, Http2Error error, boolean onDecode, String fmt, Object... args) A specific stream error resulting from failing to decode headers that exceeds the max header size list.
static boolean	isStreamError(Http2Exception e) Check if an exception is isolated to a single stream or the entire connection.
Http2Exception.ShutdownHint	shutdownHint() Provide a hint as to what type of shutdown should be executed.
static Http2Exception	streamError(int id, Http2Error error, String fmt, Object... args) Use if an error which can be isolated to a single stream has occurred.
static Http2Exception	streamError(int id, Http2Error error, Throwable cause, String fmt, Object... args) Use if an error which can be isolated to a single stream has occurred.
static int	streamId(Http2Exception e) Get the stream id associated with an exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Http2Exception

public Http2Exception(Http2Error error)

Http2Exception

public Http2Exception(Http2Error error,
                      Http2Exception.ShutdownHint shutdownHint)

Http2Exception

public Http2Exception(Http2Error error,
                      String message)

Http2Exception

public Http2Exception(Http2Error error,
                      String message,
                      Http2Exception.ShutdownHint shutdownHint)

Http2Exception

public Http2Exception(Http2Error error,
                      String message,
                      Throwable cause)

Http2Exception

public Http2Exception(Http2Error error,
                      String message,
                      Throwable cause,
                      Http2Exception.ShutdownHint shutdownHint)

Method Detail

error

public Http2Error error()

shutdownHint

public Http2Exception.ShutdownHint shutdownHint()

Provide a hint as to what type of shutdown should be executed. Note this hint may be ignored.

connectionError

public static Http2Exception connectionError(Http2Error error,
                                             String fmt,
                                             Object... args)

Use if an error has occurred which can not be isolated to a single stream, but instead applies to the entire connection.

Parameters:

error - The type of error as defined by the HTTP/2 specification.

fmt - String with the content and format for the additional debug data.

args - Objects which fit into the format defined by fmt.

Returns:

An exception which can be translated into a HTTP/2 error.

connectionError

public static Http2Exception connectionError(Http2Error error,
                                             Throwable cause,
                                             String fmt,
                                             Object... args)

Use if an error has occurred which can not be isolated to a single stream, but instead applies to the entire connection.

Parameters:

error - The type of error as defined by the HTTP/2 specification.

cause - The object which caused the error.

fmt - String with the content and format for the additional debug data.

args - Objects which fit into the format defined by fmt.

Returns:

An exception which can be translated into a HTTP/2 error.

closedStreamError

public static Http2Exception closedStreamError(Http2Error error,
                                               String fmt,
                                               Object... args)

Use if an error has occurred which can not be isolated to a single stream, but instead applies to the entire connection.

Parameters:

error - The type of error as defined by the HTTP/2 specification.

fmt - String with the content and format for the additional debug data.

args - Objects which fit into the format defined by fmt.

Returns:

An exception which can be translated into a HTTP/2 error.

streamError

public static Http2Exception streamError(int id,
                                         Http2Error error,
                                         String fmt,
                                         Object... args)

Use if an error which can be isolated to a single stream has occurred. If the id is not Http2CodecUtil.CONNECTION_STREAM_ID then a Http2Exception.StreamException will be returned. Otherwise the error is considered a connection error and a Http2Exception is returned.

Parameters:

id - The stream id for which the error is isolated to.

error - The type of error as defined by the HTTP/2 specification.

fmt - String with the content and format for the additional debug data.

args - Objects which fit into the format defined by fmt.

Returns:

If the id is not Http2CodecUtil.CONNECTION_STREAM_ID then a Http2Exception.StreamException will be returned. Otherwise the error is considered a connection error and a Http2Exception is returned.

streamError

public static Http2Exception streamError(int id,
                                         Http2Error error,
                                         Throwable cause,
                                         String fmt,
                                         Object... args)

Use if an error which can be isolated to a single stream has occurred. If the id is not Http2CodecUtil.CONNECTION_STREAM_ID then a Http2Exception.StreamException will be returned. Otherwise the error is considered a connection error and a Http2Exception is returned.

Parameters:

id - The stream id for which the error is isolated to.

error - The type of error as defined by the HTTP/2 specification.

cause - The object which caused the error.

fmt - String with the content and format for the additional debug data.

args - Objects which fit into the format defined by fmt.

Returns:

If the id is not Http2CodecUtil.CONNECTION_STREAM_ID then a Http2Exception.StreamException will be returned. Otherwise the error is considered a connection error and a Http2Exception is returned.

headerListSizeError

public static Http2Exception headerListSizeError(int id,
                                                 Http2Error error,
                                                 boolean onDecode,
                                                 String fmt,
                                                 Object... args)

A specific stream error resulting from failing to decode headers that exceeds the max header size list. If the id is not Http2CodecUtil.CONNECTION_STREAM_ID then a Http2Exception.StreamException will be returned. Otherwise the error is considered a connection error and a Http2Exception is returned.

Parameters:

id - The stream id for which the error is isolated to.

error - The type of error as defined by the HTTP/2 specification.

onDecode - Whether this error was caught while decoding headers

fmt - String with the content and format for the additional debug data.

args - Objects which fit into the format defined by fmt.

Returns:

If the id is not Http2CodecUtil.CONNECTION_STREAM_ID then a Http2Exception.HeaderListSizeException will be returned. Otherwise the error is considered a connection error and a Http2Exception is returned.

isStreamError

public static boolean isStreamError(Http2Exception e)

Check if an exception is isolated to a single stream or the entire connection.

Parameters:

e - The exception to check.

Returns:

true if e is an instance of Http2Exception.StreamException. false otherwise.

streamId

public static int streamId(Http2Exception e)

Get the stream id associated with an exception.

Parameters:

e - The exception to get the stream id for.

Returns:

Http2CodecUtil.CONNECTION_STREAM_ID if e is a connection error. Otherwise the stream id associated with the stream error.