View Javadoc

1   /**
2   The contents of this file are subject to the Mozilla Public License Version 1.1 
3   (the "License"); you may not use this file except in compliance with the License. 
4   You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
5   Software distributed under the License is distributed on an "AS IS" basis, 
6   WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
7   specific language governing rights and limitations under the License. 
8   
9   The Original Code is "Application.java".  Description: 
10  "From an HL7 messaging perspective, a consumer of a messages" 
11  
12  The Initial Developer of the Original Code is University Health Network. Copyright (C) 
13  2002.  All Rights Reserved. 
14  
15  Contributor(s): ______________________________________. 
16  
17  Alternatively, the contents of this file may be used under the terms of the 
18  GNU General Public License (the  �GPL�), in which case the provisions of the GPL are 
19  applicable instead of those above.  If you wish to allow use of your version of this 
20  file only under the terms of the GPL and not to allow others to use your version 
21  of this file under the MPL, indicate your decision by deleting  the provisions above 
22  and replace  them with the notice and other provisions required by the GPL License.  
23  If you do not delete the provisions above, a recipient may use your version of 
24  this file under either the MPL or the GPL. 
25   */
26  
27  package ca.uhn.hl7v2.app;
28  
29  import ca.uhn.hl7v2.HL7Exception;
30  
31  /**
32   * The Interface ApplicationExceptionHandler. Allow applications to handle
33   * parsing and handling errors
34   * 
35   * @author Gabriel Landais
36   * @see Application
37   */
38  public interface ApplicationExceptionHandler extends Application {
39  
40  	/**
41  	 * Process an exception.
42  	 * 
43  	 * @param incomingMessage
44  	 *            the incoming message. This is the raw message which was
45  	 *            received from the external system
46  	 * @param outgoingMessage
47  	 *            the outgoing message. The response NAK message generated by
48  	 *            HAPI.
49  	 * @param e
50  	 *            the exception
51  	 * @return The new outgoing message. This can be set to the value provided
52  	 *         by HAPI in <code>outgoingMessage</code>, or may be replaced with
53  	 *         another message.
54  	 */
55  	public String processException(String incomingMessage, String outgoingMessage, Exception e) throws HL7Exception;
56  
57  }