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.api.ldap.model.exception;
21
22
23 import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
24 import org.apache.directory.api.ldap.model.name.Dn;
25
26
27 /**
28 * An class for LDAP operation exceptions which add LDAP specific information to
29 * Exceptions.
30 *
31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public class LdapOperationException extends LdapException
34 {
35 /** The serial version UUID */
36 private static final long serialVersionUID = 1L;
37
38 /** The operation resultCode */
39 protected ResultCodeEnum resultCode;
40
41 /** The resolved Dn */
42 protected Dn resolvedDn;
43
44 /**
45 * Creates a new instance of LdapOperationException.
46 *
47 * @param resultCode The operation resultCode
48 * @param message The exception message
49 */
50 public LdapOperationException( ResultCodeEnum resultCode, String message )
51 {
52 super( message );
53 this.resultCode = resultCode;
54 }
55
56
57 /**
58 * Creates a new instance of LdapOperationException.
59 *
60 * @param resultCode The operation resultCode
61 * @param message The exception message
62 * @param cause The root cause for this exception
63 */
64 public LdapOperationException( ResultCodeEnum resultCode, String message, Throwable cause )
65 {
66 super( message, cause );
67 this.resultCode = resultCode;
68 }
69
70
71 /**
72 * Creates a new instance of LdapOperationException.
73 *
74 * @param message The exception message
75 */
76 public LdapOperationException( String message )
77 {
78 super( message );
79 }
80
81
82 /**
83 * Creates a new instance of LdapOperationException.
84 *
85 * @param message The exception message
86 * @param cause The root cause for this exception
87 */
88 public LdapOperationException( String message, Throwable cause )
89 {
90 super( message, cause );
91 }
92
93
94 /**
95 * Gets the LDAP result code that would be associated with this exception.
96 *
97 * @return the LDAP result code corresponding to this exception type.
98 */
99 public ResultCodeEnum getResultCode()
100 {
101 return resultCode;
102 }
103
104
105 /**
106 * @return the resolvedDn
107 */
108 public Dn getResolvedDn()
109 {
110 return resolvedDn;
111 }
112
113
114 /**
115 * @param resolvedDn the resolvedDn to set
116 */
117 public void setResolvedDn( Dn resolvedDn )
118 {
119 this.resolvedDn = resolvedDn;
120 }
121 }