com.ibm.ws.exception

Class ComponentDisabledException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ibm.ws.exception.WsException

com.ibm.ws.exception.WsRuntimeFwException

com.ibm.ws.exception.ComponentDisabledException

All Implemented Interfaces:

WsNestedException, java.io.Serializable

public class ComponentDisabledException
extends WsRuntimeFwException

A ComponentDisabledException is used to signal to the runtime framework that a component exists in the runtime framework but is currently disabled (for reasons unspecified). The component which throws this event will be exempt from further lifecycle events.

Note: Configuration analyzers or a server activation plan are preferential ways to avoid using this exception. For example, it is inappropriate to throw this exception to prevent component startup based on server type.

See Also:

com.ibm.wsspi.runtime.component.WsComponent#initialize(Object), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ComponentDisabledException() Constructs a new ComponentDisabledException with null as its detail message.
ComponentDisabledException(java.lang.String msg) Constructs a new ComponentDisabledException with the specified detail message.
ComponentDisabledException(java.lang.String msg, java.lang.Throwable t) Constructs a new ComponentDisabledException with the specified detail message and cause.
ComponentDisabledException(java.lang.Throwable t) Constructs a new ComponentDisabledException with the specified cause and a message which typically contains the class and detail message of cause.

Method Summary

Methods inherited from class com.ibm.ws.exception.WsException

getCause, initCause

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentDisabledException

public ComponentDisabledException()

Constructs a new ComponentDisabledException with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to WsException.initCause(java.lang.Throwable)

ComponentDisabledException

public ComponentDisabledException(java.lang.String msg)

Constructs a new ComponentDisabledException with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to WsException.initCause(java.lang.Throwable)

Parameters:

msg - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.

ComponentDisabledException

public ComponentDisabledException(java.lang.Throwable t)

Constructs a new ComponentDisabledException with the specified cause and a message which typically contains the class and detail message of cause. This constructor is useful for exceptions that are little more than wrappers for other throwables.

Parameters:

t - the cause (which is saved for later retrieval by the WsException.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

ComponentDisabledException

public ComponentDisabledException(java.lang.String msg,
                          java.lang.Throwable t)

Constructs a new ComponentDisabledException with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

msg - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

t - the cause (which is saved for later retrieval by the WsException.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)