Package org.teiid.adminapi

Class AdminException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.teiid.core.TeiidException

org.teiid.adminapi.AdminException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AdminComponentException, AdminProcessingException

public abstract class AdminException
extends org.teiid.core.TeiidException

AdminException is the base exception for the admin package. Many *Admin methods throw this exception. Instances will be one of the concrete subtypes: AdminComponentException or AdminProcessingException

AdminExceptions may contain multiple child exceptions. An example of this could be when performing an admin action results in multiple failures. Admin clients should be aware of this and use the hasMultiple() method to determine if they need to check the child exceptions.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.teiid.core.TeiidException

code

Method Summary

Modifier and Type	Method	Description
void	addChild(AdminException child)	Add a child AdminException for a particular failure if and action resulted in multiple failures.
List<AdminException>	getChildren()	Returns a non-null list of failures (AdminExceptions), one for each component that failed.
boolean	hasMultiple()	Determine whether this exception is representing mutliple component failures.

Methods inherited from class org.teiid.core.TeiidException

getCode, getMessage, getOriginalType, setCode, setOriginalType

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

Method Detail

hasMultiple

public boolean hasMultiple()

Determine whether this exception is representing mutliple component failures.

Returns:

true iff this exception contains multiple component failure exceptions.

Since:

4.3

getChildren

public List<AdminException> getChildren()

Returns a non-null list of failures (AdminExceptions), one for each component that failed.

The list will have members when hasMultiple() returns true.

Returns:

The non-null list of failures.

Since:

4.3

addChild

public void addChild(AdminException child)

Add a child AdminException for a particular failure if and action resulted in multiple failures.

Parameters:

child - a specific failure

Since:

4.3