org.snf4j.core.handler

Enum SessionIncident

java.lang.Object

java.lang.Enum<SessionIncident>

org.snf4j.core.handler.SessionIncident

All Implemented Interfaces:

Serializable, Comparable<SessionIncident>

public enum SessionIncident
extends Enum<SessionIncident>

An enum that represents session incidents that may occur during processing of I/O or protocol related operations.

Author:

SNF4J.ORG

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED_WITHOUT_CLOSE_MESSAGE A connection closed by peer without sending proper close message.
DECODING_PIPELINE_FAILURE A failure occurred while decoding data received from a remote peer.
ENCODING_PIPELINE_FAILURE A failure occurred while encoding data passed to write/send methods.
SCTP_SENDING_FAILURE A failure occurred while sending a message via the SCTP channel.
SSL_CLOSED_WITHOUT_CLOSE_NOTIFY SSL/TLS connection closed by peer without sending close_notify.

Method Summary

Modifier and Type	Method and Description
String	defaultMessage() Gets the default warning or error message that will be logged when an implementation of IHandler.incident(org.snf4j.core.handler.SessionIncident, java.lang.Throwable) method returns false.
static SessionIncident	valueOf(String name) Returns the enum constant of this type with the specified name.
static SessionIncident[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SSL_CLOSED_WITHOUT_CLOSE_NOTIFY

public static final SessionIncident SSL_CLOSED_WITHOUT_CLOSE_NOTIFY

SSL/TLS connection closed by peer without sending close_notify. It may indicate a possibility of an truncation attack.

Default action: the default message is logged at the WARN level.

CLOSED_WITHOUT_CLOSE_MESSAGE

public static final SessionIncident CLOSED_WITHOUT_CLOSE_MESSAGE

A connection closed by peer without sending proper close message.

Default action: the default message is logged at the WARN level.

ENCODING_PIPELINE_FAILURE

public static final SessionIncident ENCODING_PIPELINE_FAILURE

A failure occurred while encoding data passed to write/send methods.

Default action: the default message is logged at the ERROR level.

DECODING_PIPELINE_FAILURE

public static final SessionIncident DECODING_PIPELINE_FAILURE

A failure occurred while decoding data received from a remote peer. This incident is only reported for the datagram-oriented sessions.

NOTE: If such failure occurs while decoding data for the stream-oriented sessions then only an exception is reported.

Default action: the default message is logged at the ERROR level.

SCTP_SENDING_FAILURE

public static final SessionIncident SCTP_SENDING_FAILURE

A failure occurred while sending a message via the SCTP channel. This incident is only reported for the SCTP multi sessions for all exceptions not being an instance of the IOException.

Default action: the default message is logged at the ERROR level.

Method Detail

values

public static SessionIncident[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SessionIncident c : SessionIncident.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SessionIncident valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

defaultMessage

public String defaultMessage()

Gets the default warning or error message that will be logged when an implementation of IHandler.incident(org.snf4j.core.handler.SessionIncident, java.lang.Throwable) method returns false.

Returns:

the default warning or error message