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
/**
* $RCSfile$
* $Revision: 1565 $
* $Date: 2005-06-28 19:46:49 -0300 (Tue, 28 Jun 2005) $
*
* Copyright (C) 2004-2008 Jive Software. All rights reserved.
*
* Licensed 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.jivesoftware.openfire.interceptor;
import java.io.PrintStream;
import java.io.PrintWriter;
/**
* Thrown by a PacketInterceptor when a packet is prevented from being processed. If the packet was
* received then it will not be processed and a not_allowed error will be sent back to the sender
* of the packet. If the packet was going to be sent then the sending will be aborted.
*
* @see PacketInterceptor
* @author Gaston Dombiak
*/
public class PacketRejectedException extends Exception {
private static final long serialVersionUID = 1L;
private Throwable nestedThrowable = null;
/**
* Text to include in a message that will be sent to the sender of the packet that got
* rejected. If no text is specified then no message will be sent to the user.
*/
private String rejectionMessage;
public PacketRejectedException() {
super();
}
public PacketRejectedException(String msg) {
super(msg);
}
public PacketRejectedException(Throwable nestedThrowable) {
this.nestedThrowable = nestedThrowable;
}
public PacketRejectedException(String msg, Throwable nestedThrowable) {
super(msg);
this.nestedThrowable = nestedThrowable;
}
public void printStackTrace() {
super.printStackTrace();
if (nestedThrowable != null) {
nestedThrowable.printStackTrace();
}
}
public void printStackTrace(PrintStream ps) {
super.printStackTrace(ps);
if (nestedThrowable != null) {
nestedThrowable.printStackTrace(ps);
}
}
public void printStackTrace(PrintWriter pw) {
super.printStackTrace(pw);
if (nestedThrowable != null) {
nestedThrowable.printStackTrace(pw);
}
}
/**
* Retuns the text to include in a message that will be sent to the sender of the packet
* that got rejected or <tt>null</tt> if none was defined. If no text was specified then
* no message will be sent to the sender of the rejected packet.
*
* @return the text to include in a message that will be sent to the sender of the packet
* that got rejected or <tt>null</tt> if none was defined.
*/
public String getRejectionMessage() {
return rejectionMessage;
}
/**
* Sets the text to include in a message that will be sent to the sender of the packet
* that got rejected or <tt>null</tt> if no message will be sent to the sender of the
* rejected packet. Bt default, no message will be sent.
*
* @param rejectionMessage the text to include in the notification message for the rejection.
*/
public void setRejectionMessage(String rejectionMessage) {
this.rejectionMessage = rejectionMessage;
}
}