001/**
002The contents of this file are subject to the Mozilla Public License Version 1.1 
003(the "License"); you may not use this file except in compliance with the License. 
004You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
005Software distributed under the License is distributed on an "AS IS" basis, 
006WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
007specific language governing rights and limitations under the License. 
008
009The Original Code is "ReceivingApplicationException.java".  Description: 
010"Represents any problem encountered during processing of a message by a 
011ReceivingApplication" 
012
013The Initial Developer of the Original Code is University Health Network. Copyright (C) 
0142002, 2005.  All Rights Reserved. 
015
016Contributor(s): ______________________________________. 
017
018Alternatively, the contents of this file may be used under the terms of the 
019GNU General Public License (the "GPL"), in which case the provisions of the GPL are 
020applicable instead of those above.  If you wish to allow use of your version of this 
021file only under the terms of the GPL and not to allow others to use your version 
022of this file under the MPL, indicate your decision by deleting  the provisions above 
023and replace  them with the notice and other provisions required by the GPL License.  
024If you do not delete the provisions above, a recipient may use your version of 
025this file under either the MPL or the GPL. 
026*/
027package ca.uhn.hl7v2.protocol;
028
029import java.util.Map;
030
031/**
032 * Represents any problem encountered during processing of a message by a 
033 * <code>ReceivingApplication</code>.
034 * 
035 * Note that this replaces ca.uhn.hl7v2.app.ApplicationException in HAPI 0.5.  
036 *   
037 * @author <a href="mailto:bryan.tripp@uhn.on.ca">Bryan Tripp</a>
038 * @version $Revision: 1.1 $ updated on $Date: 2007-02-19 02:24:38 $ by $Author: jamesagnew $
039 */
040public class ReceivingApplicationException extends Exception {
041
042    private String incomingMessage;
043    private String outgoingMessage;
044    private Map<String, Object> incomingMetadata;
045
046    /**
047     * Constructs an instance of <code>ReceivingApplicationException</code> with the specified detail message.
048     */
049    public ReceivingApplicationException(String msg) {
050        super(msg);
051    }
052    
053    /**
054     * Constructs a new exception with the specified underlying cause.
055     *  
056     * @param cause an exception that is the reason for this exception
057     */
058    public ReceivingApplicationException(Throwable cause) {
059        super(cause);
060    }
061    
062    /**
063     * Constructs a new exception with the specified underlying cause
064     * and detail message.
065     *  
066     * @param msg detail message 
067     * @param cause an exception that is the reason for this exception
068     */
069    public ReceivingApplicationException(String msg, Throwable cause) {
070        super(msg, cause);
071    }
072
073    public ReceivingApplicationException(Throwable cause, String incomingMessage, String outgoingMessage, Map<String, Object> incomingMetadata) {
074        super(cause);
075        this.incomingMessage = incomingMessage;
076        this.outgoingMessage = outgoingMessage;
077        this.incomingMetadata = incomingMetadata;
078    }
079
080    public String getIncomingMessage() {
081        return incomingMessage;
082    }
083
084
085    public String getOutgoingMessage() {
086        return outgoingMessage;
087    }
088
089    public Map<String, Object> getIncomingMetadata() {
090        return incomingMetadata;
091    }
092
093}