com.sun.identity.authentication.spi

Class AuthLoginException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.security.GeneralSecurityException

javax.security.auth.login.LoginException

com.sun.identity.authentication.spi.AuthLoginException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InvalidPasswordException, UserNamePasswordValidationException

public class AuthLoginException
extends LoginException

This class is for handling message localization in LoginException.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthLoginException(String message) Constructs a new AuthLoginException with the given message.
AuthLoginException(String rbName, String errorCode, Object[] args) Constructs a new AuthLoginException without a nested Throwable.
AuthLoginException(String rbName, String errorCode, Object[] args, Throwable nestedException) Constructs an instance of AuthLoginException to pass the localized error message At this level, the locale of the caller is not known and it is not possible to throw localized error message at this level.
AuthLoginException(Throwable nestedException) Constructs an AuthLoginException with given Throwable.

Method Summary

Modifier and Type	Method and Description
String	getErrorCode() Returns the error code.
String	getL10NMessage(Locale locale) Returns the localized message of the given locale.
String	getMessage() Gets messages of the exceptions including the nested exceptions.
Object[]	getMessageArgs() Returns the error message arguments.
String	getResourceBundleName() Returns the resource bundle name.

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

AuthLoginException

public AuthLoginException(Throwable nestedException)

Constructs an AuthLoginException with given Throwable.

Parameters:

nestedException - Exception nested in the new exception.

AuthLoginException

public AuthLoginException(String message)

Constructs a new AuthLoginException with the given message.

Parameters:

message - message for this exception. This message can be later retrieved by getMessage() method.

AuthLoginException

public AuthLoginException(String rbName,
                          String errorCode,
                          Object[] args,
                          Throwable nestedException)

Constructs an instance of AuthLoginException to pass the localized error message At this level, the locale of the caller is not known and it is not possible to throw localized error message at this level. Instead this constructor provides Resource Bundle name and errorCode for correctly locating the error message. The default getMessage() will always return English messages only. This is consistent with current JRE.

Parameters:

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

errorCode - Key to resource bundle. You can use

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

args - arguments to message. If it is not present pass them as null

nestedException - The nested Throwable.

AuthLoginException

public AuthLoginException(String rbName,
                          String errorCode,
                          Object[] args)

Constructs a new AuthLoginException without a nested Throwable.

Parameters:

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

errorCode - Key to resource bundle. You can use

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

args - arguments to message. If it is not present pass them as null

Method Detail

getL10NMessage

public String getL10NMessage(Locale locale)

Returns the localized message of the given locale.

Parameters:

locale - the locale in which the message will be returned.

Returns:

String localized error message.

getResourceBundleName

public String getResourceBundleName()

Returns the resource bundle name.

Returns:

Resource Bundle Name associated with this error message.

See Also:

AuthLoginException.getL10NMessage(Locale)

getErrorCode

public String getErrorCode()

Returns the error code.

Returns:

Error code associated with this error message.

getMessageArgs

public Object[] getMessageArgs()

Returns the error message arguments.

Returns:

arguments for formatting this error message. You need to use MessageFormat class to format the message. It can be null.

getMessage

public String getMessage()

Gets messages of the exceptions including the nested exceptions.

Overrides:

getMessage in class Throwable

Returns:

messages of the exceptions including nested exceptions. The returned string is formed by concatenating messages of all the exceptions, with a new line separator, starting from this exception, all the way to the root exception, by following the nested exceptions. The message returned is always in English locale. To get localized message, use the getL10NMessage(Locale) method.