com.ongres.scram.common.exception

Class ScramServerErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ongres.scram.common.exception.ScramException

com.ongres.scram.common.exception.ScramServerErrorException

All Implemented Interfaces:

Serializable

public class ScramServerErrorException
extends ScramException

This class specifies an error that occurred during authentication exchange in a server-final-message.

It is sent by the server in its server-final-message and can help diagnose the reason for the authentication exchange failure.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScramServerErrorException(String serverError) Constructs a new instance of ScramServerErrorException with a detailed message.
ScramServerErrorException(String serverError, Throwable ex) Constructs a new instance of ScramServerErrorException with a detailed message and a root cause.

Method Summary

Modifier and Type	Method and Description
String	getServerError() Return the "e=" server-error-value from the server-final-message.

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

ScramServerErrorException

public ScramServerErrorException(String serverError)

Constructs a new instance of ScramServerErrorException with a detailed message.

Parameters:

serverError - The SCRAM error in the message

ScramServerErrorException

public ScramServerErrorException(String serverError,
                                 Throwable ex)

Constructs a new instance of ScramServerErrorException with a detailed message and a root cause.

Parameters:

serverError - The SCRAM error in the message

ex - The root exception

Method Detail

getServerError

public String getServerError()

Return the "e=" server-error-value from the server-final-message.

Returns:

the error type returned in the server-final-message