001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020 021 package org.apache.directory.shared.ldap.message; 022 023 024 import org.apache.directory.shared.ldap.RuntimeMultiException; 025 import org.apache.directory.shared.ldap.message.internal.InternalMessage; 026 027 028 /** 029 * This exception is thrown when a message processing error occurs. 030 * 031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 032 */ 033 public class ResponseCarryingMessageException extends RuntimeMultiException 034 { 035 /** 036 * Declares the Serial Version Uid. 037 * 038 * @see <a 039 * href="http://c2.com/cgi/wiki?AlwaysDeclareSerialVersionUid">Always 040 * Declare Serial Version Uid</a> 041 */ 042 private static final long serialVersionUID = 1L; 043 044 /** The response with the error cause */ 045 private InternalMessage response; 046 047 /** 048 * Constructs an Exception without a message. 049 */ 050 public ResponseCarryingMessageException() 051 { 052 super(); 053 } 054 055 056 /** 057 * Constructs an Exception with a detailed message. 058 * 059 * @param message 060 * The message associated with the exception. 061 */ 062 public ResponseCarryingMessageException(String message) 063 { 064 super( message ); 065 } 066 067 /** 068 * Set a response if we get an exception while parsing the message 069 * @param response the constructed response 070 */ 071 public void setResponse( InternalMessage response ) 072 { 073 this.response = response; 074 } 075 076 /** 077 * Get the constructed response 078 * @return The constructed response 079 */ 080 public InternalMessage getResponse() 081 { 082 return response; 083 } 084 }