com.iplanet.sso
Class SSOException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.sun.identity.common.L10NMessageImpl
              com.iplanet.sso.SSOException

All Implemented Interfaces:

com.sun.identity.common.L10NMessage, java.io.Serializable

public class SSOException

extends com.sun.identity.common.L10NMessageImpl

An SSOException is thrown when there are errors related to single sign on token operations.

See Also:

Serialized Form

Constructor Summary

SSOException(java.lang.String msg)
Constructs an instance of the SSOException class.

SSOException(java.lang.String bundleName, java.lang.String errCode, java.lang.Object[] args)
Constructs an instance of the SSOException class with localizable error message

SSOException(java.lang.Throwable t)
Constructs an instance of the SSOException class.

Method Summary

java.lang.String

getL10NMessage() Returns the localized message for this exception.

Methods inherited from class com.sun.identity.common.L10NMessageImpl

getErrorCode, getL10NMessage, getMessage, getMessageArgs, getResourceBundleName

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SSOException

public SSOException(java.lang.String msg)

Constructs an instance of the SSOException class.

Parameters:

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

SSOException

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

Constructs an instance of the SSOException class with 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(java.lang.Throwable t)

Constructs an instance of the SSOException class.

Parameters:

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

Method Detail

getL10NMessage

public java.lang.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.