Package io.asgardeo.java.oidc.sdk.exception

Class SSOAgentException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.servlet.ServletException

io.asgardeo.java.oidc.sdk.exception.SSOAgentException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SSOAgentClientException, SSOAgentServerException

public class SSOAgentException
extends javax.servlet.ServletException

The SSOAgentException class is a generic OIDC SDK exception class that provides type safety for all the SDK-related exception classes that extend from it. It is an implementation of the base class, ServletException.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SSOAgentException()
SSOAgentException(String message)	Constructs a SSOAgentException with the specified detail message.
SSOAgentException(String message, String errorCode)	Creates a SSOAgentException with the specified detail message and cause.
SSOAgentException(String message, String errorCode, Throwable cause)	Creates a SSOAgentException with the specified detail message and cause.
SSOAgentException(String message, Throwable cause)	Creates a SSOAgentException with the specified detail message and cause.
SSOAgentException(Throwable cause)	Creates a SSOAgentException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Method Summary

Modifier and Type	Method	Description
String	getErrorCode()	Returns a errorCode for the exception as defined in SSOAgentConstants.ErrorMessages.

Methods inherited from class javax.servlet.ServletException

getRootCause

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

SSOAgentException

public SSOAgentException()

SSOAgentException

public SSOAgentException(String message)

Constructs a SSOAgentException with the specified detail message. A detail message is a String that describes this particular exception.

Parameters:

message - The detail message.

SSOAgentException

public SSOAgentException(String message,
                         String errorCode)

Creates a SSOAgentException with the specified detail message and cause.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

errorCode - The error code (which is saved for later retrieval by the getErrorCode() method).

SSOAgentException

public SSOAgentException(Throwable cause)

Creates a SSOAgentException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Parameters:

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method).

SSOAgentException

public SSOAgentException(String message,
                         Throwable cause)

Creates a SSOAgentException with the specified detail message and cause.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method).

SSOAgentException

public SSOAgentException(String message,
                         String errorCode,
                         Throwable cause)

Creates a SSOAgentException with the specified detail message and cause.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

errorCode - The error code (which is saved for later retrieval by the getErrorCode() method).

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method).

Method Detail

getErrorCode

public String getErrorCode()

Returns a errorCode for the exception as defined in SSOAgentConstants.ErrorMessages.