Package org.apache.catalina.tribes
Class ChannelException
java.lang.Object
java.lang.Throwable
java.lang.Exception
org.apache.catalina.tribes.ChannelException
- All Implemented Interfaces:
Serializable
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
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
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.- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classTitle: FaultyMember class -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final ChannelException.FaultyMember[]Empty list to avoid reinstantiating lists -
Constructor Summary
ConstructorsConstructorDescriptionConstructor, creates a ChannelExceptionChannelException(String message) Constructor, creates a ChannelException with an error messageChannelException(String message, Throwable cause) Constructor, creates a ChannelException with an error message and a causeChannelException(Throwable cause) Constructor, creates a ChannelException with a cause -
Method Summary
Modifier and TypeMethodDescriptionbooleanAdds a faulty memberintAdds a list of faulty membersbooleanaddFaultyMember(Member mbr, Exception x) Adds a faulty member, and the reason the member failed.Returns an array of members that failed and the reason they failed.Returns the message for this exceptionMethods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Field Details
-
EMPTY_LIST
Empty list to avoid reinstantiating lists
-
-
Constructor Details
-
ChannelException
public ChannelException()Constructor, creates a ChannelException- See Also:
-
ChannelException
Constructor, creates a ChannelException with an error message- Parameters:
message- The error message- See Also:
-
ChannelException
Constructor, creates a ChannelException with an error message and a cause- Parameters:
message- The error messagecause- Throwable- See Also:
-
ChannelException
Constructor, creates a ChannelException with a cause- Parameters:
cause- Throwable- See Also:
-
-
Method Details
-
getMessage
Returns the message for this exception- Overrides:
getMessagein classThrowable- Returns:
- the error message
- See Also:
-
addFaultyMember
Adds a faulty member, and the reason the member failed.- Parameters:
mbr- Memberx- Exception- Returns:
trueif the member was added
-
addFaultyMember
Adds a list of faulty members- Parameters:
mbrs- FaultyMember[]- Returns:
- the number of members added
-
addFaultyMember
Adds a faulty member- Parameters:
mbr- FaultyMember- Returns:
trueif the member was added
-
getFaultyMembers
Returns an array of members that failed and the reason they failed.- Returns:
- FaultyMember[]
-