1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * https://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.ldap.client.template.exception;
21
22
23 import org.apache.directory.api.ldap.model.message.ResultResponse;
24
25
26 /**
27 * An RuntimeException wrapper class that allows the user to choose to have
28 * unsuccessful responses thrown as exceptions rather than checking the
29 * response itself for process flow.
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public class LdapRequestUnsuccessfulException extends RuntimeException
34 {
35 private static final long serialVersionUID = 1982294624076306127L;
36
37 private final transient ResultResponse response;
38
39 /**
40 * Creates a new LdapRequestUnsuccessfulException instance
41 *
42 * @param response The associated LDAP Response
43 */
44 public LdapRequestUnsuccessfulException( ResultResponse response )
45 {
46 super();
47 this.response = response;
48 }
49
50
51 /**
52 * @return the associate LDAP Response
53 */
54 public ResultResponse getResponse()
55 {
56 return response;
57 }
58 }