Package org.forgerock.openam.upgrade

Class UpgradeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sun.identity.shared.locale.L10NMessageImpl

org.forgerock.openam.upgrade.UpgradeException

All Implemented Interfaces:

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

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

This class is an extension point for all Upgrade related exceptions. This class also handles message localization in Upgrade exceptions.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UpgradeException(String message)	Constructs a new UpgradeException with the given message.
UpgradeException(String rbName, String errorCode, Object[] args)	Constructs a new UpgradeException without a nested Throwable.
UpgradeException(String message, Throwable cause)	Constructs a new UpgradeException with the given message and init cause.
UpgradeException(Throwable t)	Constructs an UpgradeException with given Throwable.

Method Summary

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

UpgradeException

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

Constructs a new UpgradeException 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

UpgradeException

public UpgradeException(String message)

Constructs a new UpgradeException with the given message.

Parameters:

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

UpgradeException

public UpgradeException(Throwable t)

Constructs an UpgradeException with given Throwable.

Parameters:

t - Exception nested in the new exception.

UpgradeException

public UpgradeException(String message,
                        Throwable cause)

Constructs a new UpgradeException with the given message and init cause.

Parameters:

message - The exception message.

cause - The init cause.