org.apache.catalina.tribes

Class ChannelException

public class ChannelException extends Exception

Channel Exception
A channel exception is thrown when an internal error happens somewhere in the channel.
When a global error happens, the cause can be retrieved using getCause()

If an application is sending a message and some of the recipients fail to receive it, the application can retrieve what recipients failed by using the getFaultyMembers() method. This way, an application will always know if a message was delivered successfully or not.

Version: $Revision: 532400 $, $Date: 2007-04-25 18:16:37 +0200 (Wed, 25 Apr 2007) $

Author: Filip Hanik

Nested Class Summary
static class	ChannelException.FaultyMember Title: FaultyMember class Description: Represent a failure to a specific member when a message was sent to more than one member

Field Summary
protected static ChannelException.FaultyMember[]	EMPTY_LIST Empty list to avoid reinstatiating lists

Constructor Summary
	ChannelException() Constructor, creates a ChannelException
	ChannelException(String message) Constructor, creates a ChannelException with an error message
	ChannelException(String message, Throwable cause) Constructor, creates a ChannelException with an error message and a cause
	ChannelException(Throwable cause) Constructor, creates a ChannelException with a cause

Method Summary
boolean	addFaultyMember(Member mbr, Exception x) Adds a faulty member, and the reason the member failed.
int	addFaultyMember(ChannelException.FaultyMember[] mbrs) Adds a list of faulty members
boolean	addFaultyMember(ChannelException.FaultyMember mbr) Adds a faulty member
ChannelException.FaultyMember[]	getFaultyMembers() Returns an array of members that failed and the reason they failed.
String	getMessage() Returns the message for this exception