Package com.sun.identity.saml2.profile

Class FederatedSSOException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sun.identity.saml2.profile.FederatedSSOException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClientFaultException, ServerFaultException

public abstract class FederatedSSOException
extends Exception

Checked exception for errors that occur during federated single sign-on (SSO).

Since:

13.0.0

See Also:

ServerFaultException, ClientFaultException, Serialized Form

Constructor Summary

Constructors

Constructor	Description
FederatedSSOException(SAML2IdentityProviderAdapter idpAdapter, String messageCode, String detail)	Constructs the FederatedSSOException with the given parameters.

Method Summary

Modifier and Type	Method	Description
String	getDetail()	Returns the detail message of this error, if provided.
abstract String	getFaultCode()	The SOAP fault code of the error.
SAML2IdentityProviderAdapter	getIdpAdapter()	The IDP adapter.
String	getMessage()
String	getMessageCode()	Returns the message code of this error.

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 Detail

FederatedSSOException

public FederatedSSOException(SAML2IdentityProviderAdapter idpAdapter,
                             String messageCode,
                             String detail)

Constructs the FederatedSSOException with the given parameters.

Parameters:

idpAdapter - the identity provider adapter, if resolved - may be null.

messageCode - the message code of the error that occurred.

detail - the detail of the exception.

Method Detail

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getMessageCode

public String getMessageCode()

Returns the message code of this error.

Returns:

the message code. Never null.

getDetail

public String getDetail()

Returns the detail message of this error, if provided.

Returns:

the detail message - may be null.

getIdpAdapter

public SAML2IdentityProviderAdapter getIdpAdapter()

The IDP adapter. This can be used to invoke hooks during error processing.

Returns:

the idp adapter. May be null.

getFaultCode

public abstract String getFaultCode()

The SOAP fault code of the error.

Returns:

one of SAML2Constants.SERVER_FAULT or SAML2Constants.CLIENT_FAULT. Never null.