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
021package org.apache.directory.api.ldap.model.exception;
022
023
024import org.apache.directory.api.ldap.model.message.Message;
025import org.apache.directory.api.util.exception.RuntimeMultiException;
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 */
033public 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 Message response;
046
047
048    /**
049     * Constructs an Exception without a message.
050     */
051    public ResponseCarryingMessageException()
052    {
053        super();
054    }
055
056
057    /**
058     * Constructs an Exception without a message.
059     *
060     * @param cause The original cause
061     */
062    public ResponseCarryingMessageException( Throwable cause )
063    {
064        super( "", cause );
065    }
066
067
068    /**
069     * Constructs an Exception with a detailed message.
070     * 
071     * @param message The message associated with the exception.
072     */
073    public ResponseCarryingMessageException( String message )
074    {
075        super( message );
076    }
077
078
079    /**
080     * Constructs an Exception with a detailed message.
081     * 
082     * @param message The message associated with the exception.
083     * @param cause The original cause
084     */
085    public ResponseCarryingMessageException( String message, Throwable cause )
086    {
087        super( message, cause );
088    }
089
090
091    /**
092     * Set a response if we get an exception while parsing the message
093     * @param response the constructed response
094     */
095    public void setResponse( Message response )
096    {
097        this.response = response;
098    }
099
100
101    /**
102     * Get the constructed response
103     * @return The constructed response
104     */
105    public Message getResponse()
106    {
107        return response;
108    }
109}