org.snf4j.websocket.frame

Class InvalidFrameException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.snf4j.websocket.frame.InvalidFrameException

All Implemented Interfaces:

Serializable, ICloseControllingException

public class InvalidFrameException
extends RuntimeException
implements ICloseControllingException

Indicates problems with decoding or validation of Web Socket frames.

Author:

SNF4J.ORG

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.snf4j.core.ICloseControllingException

ICloseControllingException.CloseType

Constructor Summary

Constructors

Constructor and Description
InvalidFrameException() Constructs a new exception without the detail message and with the gentle closing type.
InvalidFrameException(String message) Constructs a new exception with the specified detail message and with the gentle closing type.
InvalidFrameException(String message, Throwable cause) Constructs a new exception with the specified detail message, cause and with the gentle closing type.
InvalidFrameException(String message, Throwable cause, boolean gentleClose) Constructs a new exception with the specified detail message, cause and session closing type.
InvalidFrameException(Throwable cause) Constructs a new exception with the specified cause and with the gentle closing type.
InvalidFrameException(Throwable cause, boolean gentleClose) Constructs a new exception with the specified cause and session closing type.

Method Summary

Modifier and Type	Method and Description
ICloseControllingException.CloseType	getCloseType() Returns the way a session should be closed after throwing this exception during processing of session's I/O operations.
Throwable	getClosingCause() Returns the cause that triggered the close operation.

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

InvalidFrameException

public InvalidFrameException(String message,
                             Throwable cause,
                             boolean gentleClose)

Constructs a new exception with the specified detail message, cause and session closing type.

Parameters:

message - the detail message.

cause - the cause

gentleClose - the session closing type. If true the affected session will be gently closed, or otherwise the default closing will be performed

InvalidFrameException

public InvalidFrameException(Throwable cause,
                             boolean gentleClose)

Constructs a new exception with the specified cause and session closing type.

Parameters:

cause - the cause

gentleClose - the session closing type. If true the affected session will be gently closed, or otherwise the default closing will be performed

InvalidFrameException

public InvalidFrameException(String message,
                             Throwable cause)

Constructs a new exception with the specified detail message, cause and with the gentle closing type.

Parameters:

message - the detail message.

cause - the cause

InvalidFrameException

public InvalidFrameException(String message)

Constructs a new exception with the specified detail message and with the gentle closing type.

Parameters:

message - the detail message.

InvalidFrameException

public InvalidFrameException(Throwable cause)

Constructs a new exception with the specified cause and with the gentle closing type.

Parameters:

cause - the cause

InvalidFrameException

public InvalidFrameException()

Constructs a new exception without the detail message and with the gentle closing type.

Method Detail

getCloseType

public ICloseControllingException.CloseType getCloseType()

Description copied from interface: ICloseControllingException

Returns the way a session should be closed after throwing this exception during processing of session's I/O operations.

Specified by:

getCloseType in interface ICloseControllingException

Returns:

the close type

getClosingCause

public Throwable getClosingCause()

Description copied from interface: ICloseControllingException

Returns the cause that triggered the close operation. The return closing cause will be passed to the IHandler.exception(java.lang.Throwable).

Specified by:

getClosingCause in interface ICloseControllingException

Returns:

the cause that triggered the close operation