Module io.inverno.mod.http.base

Package io.inverno.mod.http.base.ws

Class UnsupportedProtocolException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.inverno.mod.http.base.HttpException

io.inverno.mod.http.base.ws.WebSocketException

io.inverno.mod.http.base.ws.UnsupportedProtocolException

All Implemented Interfaces:

Serializable

public class UnsupportedProtocolException
extends WebSocketException

An HTTP exception that indicates that the WebSocket subprotocols provided in the upgrade request are not supported.

Since:

1.5

Author:

Jeremy Kuhn

See Also:

• HttpException
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnsupportedProtocolException()	Creates an unsupported protocol exception.
UnsupportedProtocolException(String message)	Creates an unsupported protocol exception with the specified message.
UnsupportedProtocolException(String message, Throwable cause)	Creates an unsupported protocol exception with the specified message and cause.
UnsupportedProtocolException(Throwable cause)	Creates an unsupported protocol exception with the specified cause.
UnsupportedProtocolException(Set<String> supportedProtocols)	Creates an unsupported protocol exception with the specified list of media types accepted by the requested resource.
UnsupportedProtocolException(Set<String> supportedProtocols, String message)	Creates an unsupported protocol exception with the specified list of media types accepted by the requested resource and message.
UnsupportedProtocolException(Set<String> supportedProtocols, String message, Throwable cause)	Creates an unsupported protocol exception with the specified list of media types accepted by the requested resource, message and cause.
UnsupportedProtocolException(Set<String> supportedProtocols, Throwable cause)	Creates an unsupported protocol exception with the specified list of media types accepted by the requested resource and cause.

Method Summary

Modifier and Type	Method	Description
Optional<Set<String>>	getSupportedProtocol()	Returns the list of supported WebSocket subprotocols.

Methods inherited from class io.inverno.mod.http.base.HttpException

getStatus, getStatusCategory, getStatusCode, getStatusReasonPhrase, wrap

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 Details

UnsupportedProtocolException

public UnsupportedProtocolException()

Creates an unsupported protocol exception.

UnsupportedProtocolException

public UnsupportedProtocolException(String message)

Creates an unsupported protocol exception with the specified message.

Parameters:

message - a message

UnsupportedProtocolException

public UnsupportedProtocolException(Throwable cause)

Creates an unsupported protocol exception with the specified cause.

Parameters:

cause - a cause

UnsupportedProtocolException

public UnsupportedProtocolException(String message,
 Throwable cause)

Creates an unsupported protocol exception with the specified message and cause.

Parameters:

message - a message

cause - a cause

UnsupportedProtocolException

public UnsupportedProtocolException(Set<String> supportedProtocols)

Creates an unsupported protocol exception with the specified list of media types accepted by the requested resource.

Parameters:

supportedProtocols - a list of supported subprotocols

UnsupportedProtocolException

public UnsupportedProtocolException(Set<String> supportedProtocols,
 String message)

Creates an unsupported protocol exception with the specified list of media types accepted by the requested resource and message.

Parameters:

supportedProtocols - a list of supported subprotocols

message - a message

UnsupportedProtocolException

public UnsupportedProtocolException(Set<String> supportedProtocols,
 Throwable cause)

Creates an unsupported protocol exception with the specified list of media types accepted by the requested resource and cause.

Parameters:

supportedProtocols - a list of supported subprotocols

cause - a cause

UnsupportedProtocolException

public UnsupportedProtocolException(Set<String> supportedProtocols,
 String message,
 Throwable cause)

Creates an unsupported protocol exception with the specified list of media types accepted by the requested resource, message and cause.

Parameters:

supportedProtocols - a list of supported subprotocols

message - a message

cause - a cause

Method Details

getSupportedProtocol

public Optional<Set<String>> getSupportedProtocol()

Returns the list of supported WebSocket subprotocols.

Returns:

the list of supported WebSocket subprotocols