ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ResponseCarryingException.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    https://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */

package org.apache.directory.api.ldap.codec.api;


import org.apache.directory.api.asn1.DecoderException;
import org.apache.directory.api.ldap.model.message.Message;
import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
import org.apache.directory.api.ldap.model.message.ResultResponse;
import org.apache.directory.api.ldap.model.name.Dn;


/**
 * Thrown when a Decoder has encountered a failure condition during a decode.
 * 
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public class ResponseCarryingException extends DecoderException
{
    /**
     * Declares the Serial Version Uid.
     * 
     * @see <a
     *      href="http://c2.com/cgi/wiki?AlwaysDeclareSerialVersionUid">Always
     *      Declare Serial Version Uid</a>
     */
    private static final long serialVersionUID = 1L;

    /** The response with the error cause */
    private Message response;


    /**
     * Creates a DecoderException
     * 
     * @param message A message with meaning to a human
     */
    public ResponseCarryingException( String message )
    {
        super( message );
    }


    /**
     * Creates a DecoderException
     * 
     * @param message A message with meaning to a human
     * @param cause The original cause
     */
    public ResponseCarryingException( String message, Throwable cause )
    {
        super( message, cause );
    }


    /**
     * Creates a DecoderException
     * 
     * @param message A message with meaning to a human
     * @param response The response to store
     * @param code the ResultCode
     * @param matchedDn The Matched DN
     * @param cause The Exception which caused the error
     */
    public ResponseCarryingException( String message, ResultResponse response, ResultCodeEnum code,
        Dn matchedDn, Throwable cause )
    {
        super( message, cause );

        response.getLdapResult().setDiagnosticMessage( message );
        response.getLdapResult().setResultCode( code );
        response.getLdapResult().setMatchedDn( matchedDn );

        this.response = response;
    }


    /**
     * Set a response if we get an exception while parsing the message
     * @param response the constructed response
     */
    public void setResponse( Message response )
    {
        this.response = response;
    }


    /**
     * Get the constructed response
     * @return The constructed response
     */
    public Message getResponse()
    {
        return response;
    }

}