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    
026    
027    /**
028     * This exception is thrown when a message processing error occurs.
029     * 
030     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031     */
032    public class ResponseCarryingMessageException extends RuntimeMultiException
033    {
034        /**
035         * Declares the Serial Version Uid.
036         * 
037         * @see <a
038         *      href="http://c2.com/cgi/wiki?AlwaysDeclareSerialVersionUid">Always
039         *      Declare Serial Version Uid</a>
040         */
041        private static final long serialVersionUID = 1L;
042    
043        /** The response with the error cause */
044        private InternalMessage response;
045        
046        /**
047         * Constructs an Exception without a message.
048         */
049        public ResponseCarryingMessageException()
050        {
051            super();
052        }
053    
054    
055        /**
056         * Constructs an Exception with a detailed message.
057         * 
058         * @param message
059         *            The message associated with the exception.
060         */
061        public ResponseCarryingMessageException(String message)
062        {
063            super( message );
064        }
065        
066        /**
067         * Set a response if we get an exception while parsing the message
068         * @param response the constructed response
069         */
070        public void setResponse( InternalMessage response ) 
071        {
072            this.response = response;
073        }
074        
075        /**
076         * Get the constructed response
077         * @return The constructed response
078         */
079        public InternalMessage getResponse()
080        {
081            return response;
082        }
083    }