Package org.wildfly.security.mechanism

Class ScramServerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.wildfly.security.mechanism.AuthenticationMechanismException

org.wildfly.security.mechanism.ScramServerException

All Implemented Interfaces:

Serializable

public class ScramServerException
extends AuthenticationMechanismException

A SCRAM server-side exception with an error code.

Author:

David M. Lloyd

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ScramServerException(String msg, Throwable cause, ScramServerErrorCode error)	Constructs a new ScramServerException instance with an initial message and cause.
ScramServerException(String msg, ScramServerErrorCode error)	Constructs a new ScramServerException instance with an initial message.
ScramServerException(Throwable cause, ScramServerErrorCode error)	Constructs a new ScramServerException instance with an initial cause.
ScramServerException(ScramServerErrorCode error)	Constructs a new ScramServerException instance.

Method Summary

Modifier and Type	Method	Description
ScramServerErrorCode	getError()	Returns the error code of the exception.
String	getMessage()

Methods inherited from class org.wildfly.security.mechanism.AuthenticationMechanismException

fromException, toHttpAuthenticationException, toSaslException

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

ScramServerException

public ScramServerException(ScramServerErrorCode error)

Constructs a new ScramServerException instance. The message is left blank (null), and no cause is specified.

Parameters:

error - the server error code

ScramServerException

public ScramServerException(String msg,
 ScramServerErrorCode error)

Constructs a new ScramServerException instance with an initial message. No cause is specified.

Parameters:

msg - the message

error - the server error code

ScramServerException

public ScramServerException(Throwable cause,
 ScramServerErrorCode error)

Constructs a new ScramServerException instance with an initial cause. If a non-null cause is specified, its message is used to initialize the message of this ScramServerException; otherwise the message is left blank (null).

Parameters:

cause - the cause

error - the server error code

ScramServerException

public ScramServerException(String msg,
 Throwable cause,
 ScramServerErrorCode error)

Constructs a new ScramServerException instance with an initial message and cause.

Parameters:

msg - the message

cause - the cause

error - the server error code

Method Details

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getError

public ScramServerErrorCode getError()

Returns the error code of the exception.

Returns:

the error code of the exception.