Package org.sourceid.saml20.adapter

Class GeneralAdapterException

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.sourceid.saml20.adapter.GeneralAdapterException
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AuthnAdapterException, OOBAuthGeneralException, UnknownUserException, UserAuthBindingMessageException
public class GeneralAdapterException extends Exception
Represents a generic adapter exception.
See Also:

  • Constructor Details

    • GeneralAdapterException

      public GeneralAdapterException(String message)
      Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).
      Parameters:
      message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.

    • GeneralAdapterException

      public GeneralAdapterException(String message, Throwable cause)
      Constructs a new exception with the specified detail message and cause.

      Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

      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). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
      Since:
      1.4

    • GeneralAdapterException

      public GeneralAdapterException(Throwable cause)
      Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause). This constructor is useful for exceptions that are little more than wrappers for other throwables.
      Parameters:
      cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
      Since:
      1.4

  • Method Details

    • isAllowMessagePropagation

      public boolean isAllowMessagePropagation()
      Indicates if, rather than a generic message, this exception's message should be allowed to propagate out to the protocol layer (such as OAuth's error_description parameter or SAML's StatusMessage element).
      Returns:
      true if message should be allowed to propagate; false otherwise

    • setAllowMessagePropagation

      public void setAllowMessagePropagation(boolean allowMessagePropagation)
      Indicates if, rather than a generic message, this exception's message should be allowed to propagate out to the protocol layer (such as OAuth's error_description parameter or SAML's StatusMessage element).
      Parameters:
      allowMessagePropagation - whether the message should be allowed to propagate