com.webmethods.portal.system.init

Class InitializationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.webmethods.portal.PortalException

com.webmethods.portal.system.init.InitializationException

All Implemented Interfaces:

IPortalException, Serializable

Direct Known Subclasses:

RtlInitException

public class InitializationException
extends PortalException

During startup, this various IInitializables are initialized by the PortalSystem. If an exception occurrs an InitializationException is thrown. The author of the IInitializable decides whether the system can recover. If it can, an InitializationException is thrown with the paramater RECOVERABLE_ERROR. This implies that even though the object wasn't successfully initialized, the system as a whole can still continue to initialize. Otherwise, an InitializationException is thrown with the paramater NON_RECOVERABLE_ERROR.

See Also:

IInitializable, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.webmethods.portal.PortalException

PortalException.IPortalExceptionDelegate

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_errorState
static int	NON_RECOVERABLE_ERROR Initialization must stop
static int	RECOVERABLE_ERROR The system can continue to initialize
static int	UNKNOWN_ERROR This is a recoverable error, but the cause isn't known

Fields inherited from class com.webmethods.portal.PortalException

CURRENT_ERROR_LIST, EXCEPTION_DELEGATE_CLASS_NAME, logger, m_context, m_errorList, m_ignoreTargetMessage, m_isExpected, m_isLocalizable, m_messageArgs, m_messageInfo, m_messageKey, m_resBundleClass, m_target, s_portalExceptionDelegate

Constructor Summary

Constructors

Constructor and Description
InitializationException(Class<? extends ResourceBundle> resourceBundleClass, String messageKey, Object[] messageArgs, int errorState)
InitializationException(int errorState) Deprecated. use a construtor that provides a localized reason for the error
InitializationException(Throwable target) By default, this is created with NON_RECOVERABLE_ERROR
InitializationException(Throwable t, Class<? extends ResourceBundle> resourceBundleClass, String messageKey, Object[] messageArgs, int errorState)
InitializationException(Throwable target, int errorState)

Method Summary

Modifier and Type	Method and Description
boolean	canRecover() Based on getErrorState() we may or may not be able to recover
int	getErrorState() The error level
static InitializationException	reuseOrWrap(Throwable target) This will either construct a new InitializationException, wrapping the target or just return the target if it already is an instance of InitializationException.
static InitializationException	reuseOrWrap(Throwable target, int errorState) This will either construct a new InitializationException, wrapping the target or just return the target if it already is an instance of InitializationException.

Methods inherited from class com.webmethods.portal.PortalException

addDetailsMesasge, addDetailsMessage, checkExpected, getCause, getContext, getErrorList, getErrorList, getGlobalProvider, getLocalizedMessage, getMessage, getMessageKey, getTargetException, getTLS, initDetailsMessage, isExpected, notImplemented, printFullStackTrace, printFullStackTrace, printStackTrace, printStackTrace, printStackTrace, putTLS, removeTLS, reset, reuseOrWrapException, setContext, setExpected, setIgnoreTargetMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN_ERROR

public static final int UNKNOWN_ERROR

This is a recoverable error, but the cause isn't known

See Also:

Constant Field Values

RECOVERABLE_ERROR

public static final int RECOVERABLE_ERROR

The system can continue to initialize

See Also:

Constant Field Values

NON_RECOVERABLE_ERROR

public static final int NON_RECOVERABLE_ERROR

Initialization must stop

See Also:

Constant Field Values

m_errorState

protected int m_errorState

Constructor Detail

InitializationException

@Deprecated
public InitializationException(int errorState)

Deprecated. use a construtor that provides a localized reason for the error

Parameters:

errorState - either RECOVERABLE_ERROR or NON_RECOVERABLE_ERROR

InitializationException

public InitializationException(Throwable t,
                               Class<? extends ResourceBundle> resourceBundleClass,
                               String messageKey,
                               Object[] messageArgs,
                               int errorState)

Parameters:

errorState - either RECOVERABLE_ERROR or NON_RECOVERABLE_ERROR

InitializationException

public InitializationException(Class<? extends ResourceBundle> resourceBundleClass,
                               String messageKey,
                               Object[] messageArgs,
                               int errorState)

Parameters:

errorState - either RECOVERABLE_ERROR or NON_RECOVERABLE_ERROR

InitializationException

public InitializationException(Throwable target)

By default, this is created with NON_RECOVERABLE_ERROR

Parameters:

target - the wrapped exception. see PortalException.getTargetException()

InitializationException

public InitializationException(Throwable target,
                               int errorState)

Parameters:

target - the wrapped exception. see PortalException.getTargetException()

errorState - either RECOVERABLE_ERROR or NON_RECOVERABLE_ERROR

Method Detail

reuseOrWrap

public static InitializationException reuseOrWrap(Throwable target)

This will either construct a new InitializationException, wrapping the target or just return the target if it already is an instance of InitializationException. By default, if a new InitializationException is created, it will be with NON_RECOVERABLE_ERROR.

Parameters:

target - the wrapped exception. see PortalException.getTargetException()

Returns:

nothing, an exception be will be thrown

reuseOrWrap

public static InitializationException reuseOrWrap(Throwable target,
                                                  int errorState)

This will either construct a new InitializationException, wrapping the target or just return the target if it already is an instance of InitializationException. By default, if a new InitializationException is created, it will be with NON_RECOVERABLE_ERROR.

Parameters:

target - the wrapped exception. see PortalException.getTargetException()

errorState - either RECOVERABLE_ERROR or NON_RECOVERABLE_ERROR

Returns:

nothing, an exception be will be thrown

getErrorState

public int getErrorState()

The error level

Returns:

either RECOVERABLE_ERROR or NON_RECOVERABLE_ERROR

canRecover

public boolean canRecover()

Based on getErrorState() we may or may not be able to recover

Returns:

true if you can recover, false otherwise