Package org.forgerock.openam.wsfederation.common

Class ActiveRequestorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sun.identity.shared.locale.L10NMessageImpl

com.sun.identity.wsfederation.common.WSFederationException

org.forgerock.openam.wsfederation.common.ActiveRequestorException

All Implemented Interfaces:

L10NMessage, Serializable

public class ActiveRequestorException
extends WSFederationException

A WSFederationException type that specifically handles error situations corresponding to WS-Federation Active Requestor Profile.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
jakarta.xml.soap.SOAPMessage	getSOAPFault()	Returns the exception's SOAP Fault representation that can be returned back to the SOAP client as a response.
static ActiveRequestorException	newReceiverException(String key, String... args)	Constructs a new exception instance for server side errors.
static ActiveRequestorException	newReceiverException(Throwable throwable)	Constructs a new exception instance for server side errors based on exception objects.
static ActiveRequestorException	newSenderException(String key, String... args)	Constructs a new exception instance for client side errors.

Methods inherited from class com.sun.identity.shared.locale.L10NMessageImpl

getErrorCode, getL10NMessage, getMessage, getMessageArgs, getResourceBundleName

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

Method Detail

newSenderException

public static ActiveRequestorException newSenderException(String key,
                                                          String... args)

Constructs a new exception instance for client side errors.

Parameters:

key - The localization key to use when constructing the SOAP fault.

args - Additional parameters for the localized message.

Returns:

An exception instance which represents the error state.

newReceiverException

public static ActiveRequestorException newReceiverException(String key,
                                                            String... args)

Constructs a new exception instance for server side errors.

Parameters:

key - The localization key to use when constructing the SOAP fault.

args - Additional parameters for the localized message.

Returns:

An exception instance which represents the error state.

newReceiverException

public static ActiveRequestorException newReceiverException(Throwable throwable)

Constructs a new exception instance for server side errors based on exception objects.

Parameters:

throwable - The exception that should be encapsulated in the error message.

Returns:

An exception instance which represents the error state.

getSOAPFault

public jakarta.xml.soap.SOAPMessage getSOAPFault()

Returns the exception's SOAP Fault representation that can be returned back to the SOAP client as a response.

Returns:

The exception's SOAP Fault representation. May return null, if there was a problem while creating the SOAP objects.