View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    https://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  
21  package org.apache.directory.api.ldap.model.exception;
22  
23  
24  import org.apache.directory.api.ldap.model.message.Message;
25  import org.apache.directory.api.util.exception.RuntimeMultiException;
26  
27  
28  /**
29   * This exception is thrown when a message processing error occurs.
30   * 
31   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32   */
33  public class ResponseCarryingMessageException extends RuntimeMultiException
34  {
35      /**
36       * Declares the Serial Version Uid.
37       * 
38       * @see <a
39       *      href="http://c2.com/cgi/wiki?AlwaysDeclareSerialVersionUid">Always
40       *      Declare Serial Version Uid</a>
41       */
42      private static final long serialVersionUID = 1L;
43  
44      /** The response with the error cause */
45      private Message response;
46  
47  
48      /**
49       * Constructs an Exception without a message.
50       */
51      public ResponseCarryingMessageException()
52      {
53          super();
54      }
55  
56  
57      /**
58       * Constructs an Exception without a message.
59       *
60       * @param cause The original cause
61       */
62      public ResponseCarryingMessageException( Throwable cause )
63      {
64          super( "", cause );
65      }
66  
67  
68      /**
69       * Constructs an Exception with a detailed message.
70       * 
71       * @param message The message associated with the exception.
72       */
73      public ResponseCarryingMessageException( String message )
74      {
75          super( message );
76      }
77  
78  
79      /**
80       * Constructs an Exception with a detailed message.
81       * 
82       * @param message The message associated with the exception.
83       * @param cause The original cause
84       */
85      public ResponseCarryingMessageException( String message, Throwable cause )
86      {
87          super( message, cause );
88      }
89  
90  
91      /**
92       * Set a response if we get an exception while parsing the message
93       * @param response the constructed response
94       */
95      public void setResponse( Message response )
96      {
97          this.response = response;
98      }
99  
100 
101     /**
102      * Get the constructed response
103      * @return The constructed response
104      */
105     public Message getResponse()
106     {
107         return response;
108     }
109 }