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 */
020package org.apache.directory.ldap.client.template.exception;
021
022
023import org.apache.directory.api.ldap.model.message.ResultResponse;
024
025
026/**
027 * An RuntimeException wrapper class that allows the user to choose to have
028 * unsuccessful responses thrown as exceptions rather than checking the 
029 * response itself for process flow.
030 * 
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public class LdapRequestUnsuccessfulException extends RuntimeException
034{
035    private static final long serialVersionUID = 1982294624076306127L;
036
037    private final transient ResultResponse response;
038
039
040    /**
041     * Creates a new LdapRequestUnsuccessfulException instance
042     * 
043     * @param response The associated LDAP Response
044     */
045    public LdapRequestUnsuccessfulException( ResultResponse response )
046    {
047        super();
048        this.response = response;
049    }
050
051
052    /**
053     * @return the associate LDAP Response
054     */
055    public ResultResponse getResponse()
056    {
057        return response;
058    }
059
060}