Package com.sun.identity.saml2.profile

Class ClientFaultException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sun.identity.saml2.profile.FederatedSSOException

com.sun.identity.saml2.profile.ClientFaultException

All Implemented Interfaces:

Serializable

public class ClientFaultException
extends FederatedSSOException

Indicates a client fault during federated SSO.

Since:

13.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClientFaultException(SAML2IdentityProviderAdapter idpAdapter, String messageCode)	Constructs the client fault exception with the given IDP adapter and message code.
ClientFaultException(SAML2IdentityProviderAdapter idpAdapter, String messageCode, String detail)	Constructs the client fault exception with the given IDP adapter, message code, and detail message.
ClientFaultException(String messageCode)	Constructs the client fault exception with the given message code.
ClientFaultException(String messageCode, String detail)	Constructs the client fault exception with the given message code and detail message.

Method Summary

Modifier and Type	Method	Description
String	getFaultCode()	The SOAP fault code of the error.

Methods inherited from class com.sun.identity.saml2.profile.FederatedSSOException

getDetail, getIdpAdapter, getMessage, getMessageCode

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

ClientFaultException

public ClientFaultException(String messageCode)

Constructs the client fault exception with the given message code.

Parameters:

messageCode - the message code. May not be null.

ClientFaultException

public ClientFaultException(String messageCode,
                            String detail)

Constructs the client fault exception with the given message code and detail message.

Parameters:

messageCode - the message code. May not be null.

detail - the detail message. May be null.

ClientFaultException

public ClientFaultException(SAML2IdentityProviderAdapter idpAdapter,
                            String messageCode)

Constructs the client fault exception with the given IDP adapter and message code.

Parameters:

idpAdapter - the identity provider adapter. May be null.

messageCode - the message code. May not be null.

ClientFaultException

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

Constructs the client fault exception with the given IDP adapter, message code, and detail message.

Parameters:

idpAdapter - the identity provider adapter. May be null.

messageCode - the message code. May not be null.

detail - the detail message. May be null.

Method Detail

getFaultCode

public String getFaultCode()

Description copied from class: FederatedSSOException

The SOAP fault code of the error.

Specified by:

getFaultCode in class FederatedSSOException

Returns:

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