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 * http://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 /**
46 * @return the resolvedDn
47 */
48 public Dn getResolvedDn()
49 {
50 return resolvedDn;
51 }
52
53
54 /**
55 * @param resolvedDn the resolvedDn to set
56 */
57 public void setResolvedDn( Dn resolvedDn )
58 {
59 this.resolvedDn = resolvedDn;
60 }
61
62
63 /**
64 * Creates a new instance of LdapOperationException.
65 *
66 * @param resultCode The operation resultCode
67 * @param message The exception message
68 */
69 public LdapOperationException( ResultCodeEnum resultCode, String message )
70 {
71 super( message );
72 this.resultCode = resultCode;
73 }
74
75
76 /**
77 * Creates a new instance of LdapOperationException.
78 *
79 * @param resultCode The operation resultCode
80 * @param message The exception message
81 * @param cause The root cause for this exception
82 */
83 public LdapOperationException( ResultCodeEnum resultCode, String message, Throwable cause )
84 {
85 super( message, cause );
86 this.resultCode = resultCode;
87 }
88
89
90 /**
91 * Creates a new instance of LdapOperationException.
92 *
93 * @param message The exception message
94 */
95 public LdapOperationException( String message )
96 {
97 super( message );
98 }
99
100
101 /**
102 * Creates a new instance of LdapOperationException.
103 *
104 * @param message The exception message
105 * @param cause The root cause for this exception
106 */
107 public LdapOperationException( String message, Throwable cause )
108 {
109 super( message, cause );
110 }
111
112
113 /**
114 * Gets the LDAP result code that would be associated with this exception.
115 *
116 * @return the LDAP result code corresponding to this exception type.
117 */
118 public ResultCodeEnum getResultCode()
119 {
120 return resultCode;
121 }
122 }