Package org.apache.catalina.tribes
Class ChannelException
- java.lang.Object
- 
- java.lang.Throwable
- 
- java.lang.Exception
- 
- org.apache.catalina.tribes.ChannelException
 
 
 
- 
- All Implemented Interfaces:
- java.io.Serializable
 
 public class ChannelException extends java.lang.ExceptionA 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 thegetFaultyMembers()method. This way, an application will always know if a message was delivered successfully or not.- See Also:
- Serialized Form
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classChannelException.FaultyMemberTitle: FaultyMember class
 - 
Field SummaryFields Modifier and Type Field Description protected static ChannelException.FaultyMember[]EMPTY_LISTEmpty list to avoid reinstantiating lists
 - 
Constructor SummaryConstructors Constructor Description ChannelException()Constructor, creates a ChannelExceptionChannelException(java.lang.String message)Constructor, creates a ChannelException with an error messageChannelException(java.lang.String message, java.lang.Throwable cause)Constructor, creates a ChannelException with an error message and a causeChannelException(java.lang.Throwable cause)Constructor, creates a ChannelException with a cause
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanaddFaultyMember(ChannelException.FaultyMember mbr)Adds a faulty memberintaddFaultyMember(ChannelException.FaultyMember[] mbrs)Adds a list of faulty membersbooleanaddFaultyMember(Member mbr, java.lang.Exception x)Adds a faulty member, and the reason the member failed.ChannelException.FaultyMember[]getFaultyMembers()Returns an array of members that failed and the reason they failed.java.lang.StringgetMessage()Returns the message for this exception
 
- 
- 
- 
Field Detail- 
EMPTY_LISTprotected static final ChannelException.FaultyMember[] EMPTY_LIST Empty list to avoid reinstantiating lists
 
- 
 - 
Constructor Detail- 
ChannelExceptionpublic ChannelException() Constructor, creates a ChannelException- See Also:
- Exception()
 
 - 
ChannelExceptionpublic ChannelException(java.lang.String message) Constructor, creates a ChannelException with an error message- Parameters:
- message- The error message
- See Also:
- Exception(String)
 
 - 
ChannelExceptionpublic ChannelException(java.lang.String message, java.lang.Throwable cause)Constructor, creates a ChannelException with an error message and a cause- Parameters:
- message- The error message
- cause- Throwable
- See Also:
- Exception(String,Throwable)
 
 - 
ChannelExceptionpublic ChannelException(java.lang.Throwable cause) Constructor, creates a ChannelException with a cause- Parameters:
- cause- Throwable
- See Also:
- Exception(Throwable)
 
 
- 
 - 
Method Detail- 
getMessagepublic java.lang.String getMessage() Returns the message for this exception- Overrides:
- getMessagein class- java.lang.Throwable
- Returns:
- the error message
- See Also:
- Throwable.getMessage()
 
 - 
addFaultyMemberpublic boolean addFaultyMember(Member mbr, java.lang.Exception x) Adds a faulty member, and the reason the member failed.- Parameters:
- mbr- Member
- x- Exception
- Returns:
- trueif the member was added
 
 - 
addFaultyMemberpublic int addFaultyMember(ChannelException.FaultyMember[] mbrs) Adds a list of faulty members- Parameters:
- mbrs- FaultyMember[]
- Returns:
- the number of members added
 
 - 
addFaultyMemberpublic boolean addFaultyMember(ChannelException.FaultyMember mbr) Adds a faulty member- Parameters:
- mbr- FaultyMember
- Returns:
- trueif the member was added
 
 - 
getFaultyMemberspublic ChannelException.FaultyMember[] getFaultyMembers() Returns an array of members that failed and the reason they failed.- Returns:
- FaultyMember[]
 
 
- 
 
-