View Javadoc
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       * Creates a new instance of LdapOperationException.
47       *
48       * @param resultCode The operation resultCode
49       * @param message The exception message
50       */
51      public LdapOperationException( ResultCodeEnum resultCode, String message )
52      {
53          super( message );
54          this.resultCode = resultCode;
55      }
56  
57  
58      /**
59       * Creates a new instance of LdapOperationException.
60       *
61       * @param resultCode The operation resultCode
62       * @param message The exception message
63       * @param cause The root cause for this exception
64       */
65      public LdapOperationException( ResultCodeEnum resultCode, String message, Throwable cause )
66      {
67          super( message, cause );
68          this.resultCode = resultCode;
69      }
70  
71  
72      /**
73       * Creates a new instance of LdapOperationException.
74       *
75       * @param message The exception message
76       */
77      public LdapOperationException( String message )
78      {
79          super( message );
80      }
81  
82  
83      /**
84       * Creates a new instance of LdapOperationException.
85       *
86       * @param message The exception message
87       * @param cause The root cause for this exception
88       */
89      public LdapOperationException( String message, Throwable cause )
90      {
91          super( message, cause );
92      }
93  
94  
95      /**
96       * @return the resolvedDn
97       */
98      public Dn getResolvedDn()
99      {
100         return resolvedDn;
101     }
102 
103 
104     /**
105      * @param resolvedDn the resolvedDn to set
106      */
107     public void setResolvedDn( Dn resolvedDn )
108     {
109         this.resolvedDn = resolvedDn;
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 }