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 * http://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 with a detailed message.
59 *
60 * @param message
61 * The message associated with the exception.
62 */
63 public ResponseCarryingMessageException( String message )
64 {
65 super( message );
66 }
67
68
69 /**
70 * Set a response if we get an exception while parsing the message
71 * @param response the constructed response
72 */
73 public void setResponse( Message response )
74 {
75 this.response = response;
76 }
77
78
79 /**
80 * Get the constructed response
81 * @return The constructed response
82 */
83 public Message getResponse()
84 {
85 return response;
86 }
87 }