/** * $RCSfile$ * $Revision: 1565 $ * $Date: 2005-06-28 19:46:49 -0300 (Tue, 28 Jun 2005) $ * * Copyright (C) 2004-2008 Jive Software. All rights reserved. * * This software is published under the terms of the GNU Public License (GPL), * a copy of which is included in this distribution, or a commercial license * agreement with Jive. */ 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; } }