1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina.tribes;
import java.util.ArrayList;
/**
* Channel Exception<br>
* A channel exception is thrown when an internal error happens
* somewhere in the channel. <br>
* When a global error happens, the cause can be retrieved using <code>getCause()</code><br><br>
* 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 <code>getFaultyMembers()</code>
* method. This way, an application will always know if a message was delivered successfully or not.
* @author Filip Hanik
* @version $Revision: 532400 $, $Date: 2007-04-25 18:16:37 +0200 (mer., 25 avr. 2007) $
*/
public class ChannelException extends Exception {
/**
* Empty list to avoid reinstatiating lists
*/
protected static final FaultyMember[] EMPTY_LIST = new FaultyMember[0];
/*
* Holds a list of faulty members
*/
private ArrayList faultyMembers=null;
/**
* Constructor, creates a ChannelException
* @see java.lang.Exception#Exception()
*/
public ChannelException() {
super();
}
/**
* Constructor, creates a ChannelException with an error message
* @see java.lang.Exception#Exception(String)
*/
public ChannelException(String message) {
super(message);
}
/**
* Constructor, creates a ChannelException with an error message and a cause
* @param message String
* @param cause Throwable
* @see java.lang.Exception#Exception(String,Throwable)
*/
public ChannelException(String message, Throwable cause) {
super(message, cause);
}
/**
* Constructor, creates a ChannelException with a cause
* @param cause Throwable
* @see java.lang.Exception#Exception(Throwable)
*/
public ChannelException(Throwable cause) {
super(cause);
}
/**
* Returns the message for this exception
* @return String
* @see java.lang.Exception#getMessage()
*/
public String getMessage() {
StringBuffer buf = new StringBuffer(super.getMessage());
if (faultyMembers==null || faultyMembers.size() == 0 ) {
buf.append("; No faulty members identified.");
} else {
buf.append("; Faulty members:");
for ( int i=0; i<faultyMembers.size(); i++ ) {
FaultyMember mbr = (FaultyMember)faultyMembers.get(i);
buf.append(mbr.getMember().getName());
buf.append("; ");
}
}
return buf.toString();
}
/**
* Adds a faulty member, and the reason the member failed.
* @param mbr Member
* @param x Exception
*/
public boolean addFaultyMember(Member mbr, Exception x ) {
return addFaultyMember(new FaultyMember(mbr,x));
}
/**
* Adds a list of faulty members
* @param mbrs FaultyMember[]
*/
public int addFaultyMember(FaultyMember[] mbrs) {
int result = 0;
for (int i=0; mbrs!=null && i<mbrs.length; i++ ) {
if ( addFaultyMember(mbrs[i]) ) result++;
}
return result;
}
/**
* Adds a faulty member
* @param mbr FaultyMember
*/
public boolean addFaultyMember(FaultyMember mbr) {
if ( this.faultyMembers==null ) this.faultyMembers = new ArrayList();
if ( !faultyMembers.contains(mbr) ) return faultyMembers.add(mbr);
else return false;
}
/**
* Returns an array of members that failed and the reason they failed.
* @return FaultyMember[]
*/
public FaultyMember[] getFaultyMembers() {
if ( this.faultyMembers==null ) return EMPTY_LIST;
return (FaultyMember[])faultyMembers.toArray(new FaultyMember[faultyMembers.size()]);
}
/**
*
* <p>Title: FaultyMember class</p>
*
* <p>Description: Represent a failure to a specific member when a message was sent
* to more than one member</p>
*
* @author Filip Hanik
* @version 1.0
*/
public static class FaultyMember {
protected Exception cause;
protected Member member;
public FaultyMember(Member mbr, Exception x) {
this.member = mbr;
this.cause = x;
}
public Member getMember() {
return member;
}
public Exception getCause() {
return cause;
}
public String toString() {
return "FaultyMember:"+member.toString();
}
public int hashCode() {
return (member!=null)?member.hashCode():0;
}
public boolean equals(Object o) {
if (member==null || (!(o instanceof FaultyMember)) || (((FaultyMember)o).member==null)) return false;
return member.equals(((FaultyMember)o).member);
}
}
}
|
