Package com.iplanet.sso

Class SSOException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sun.identity.shared.locale.L10NMessageImpl

com.iplanet.sso.SSOException

All Implemented Interfaces:

com.sun.identity.shared.locale.L10NMessage, Serializable

Direct Known Subclasses:

SSOTokenListenersUnsupportedException

@SupportedAll
public class SSOException
extends com.sun.identity.shared.locale.L10NMessageImpl

This SSOException is thrown when there are single sign on token operation error.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SSOException(String msg)	Constructs a SSOException with a detail message.
SSOException(String bundleName, String errCode, Object[] args)	Constructs a SSOException with a detailed localizable error message.
SSOException(String msg, Throwable t)	Constructs a SSOException with a detail message.
SSOException(Throwable t)	Constructs a SSOException with a specified throwable cause and detailed message.

Method Summary

Modifier and Type	Method	Description
String	getL10NMessage()	Returns the localized message for this exception.

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

SSOException

public SSOException(String msg)

Constructs a SSOException with a detail message.

Parameters:

msg - The message provided by the object that is throwing the exception.

SSOException

public SSOException(String msg,
                    Throwable t)

Constructs a SSOException with a detail message.

Parameters:

msg - The message provided by the object that is throwing the exception.

t - The Throwable object provided by the object that is throwing the exception.

SSOException

public SSOException(String bundleName,
                    String errCode,
                    Object[] args)

Constructs a SSOException with a detailed localizable error message.

Parameters:

bundleName - Resource Bundle Name to be used for getting localized error message.

errCode - Key to resource bundle. You can use

  ResourceBundle rb = ResourceBunde.getBundle (rbName,locale);
  String localizedStr = rb.getString(errorCode)
 

args - Arguments to message. If arguments to the message are not present, pass null.

SSOException

public SSOException(Throwable t)

Constructs a SSOException with a specified throwable cause and detailed message.

Parameters:

t - The Throwable object provided by the object that is throwing the exception.

Method Detail

getL10NMessage

public String getL10NMessage()

Returns the localized message for this exception. Default locale is used to retrieve this message from properties file, which is the locale of OS.

Returns:

the localized message for this exception.