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.i18n.I18n;
24  import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
25  
26  
27  /**
28   * Makes a {@link LdapOperationException} unambiguous with respect to the result code
29   * it corresponds to by associating an LDAP specific result code with it.
30   * 
31   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32   */
33  public class LdapSchemaViolationException extends LdapOperationException
34  {
35      /** The serial version UUID */
36      static final long serialVersionUID = 1L;
37  
38  
39      /**
40       * Creates a new instance of LdapSchemaViolationException.
41       *
42       * @param resultCode the ResultCodeEnum for this exception
43       * @param message The exception message
44       */
45      public LdapSchemaViolationException( ResultCodeEnum resultCode, String message )
46      {
47          super( message );
48          checkResultCode( resultCode );
49          this.resultCode = resultCode;
50      }
51  
52  
53      /**
54       *
55       * @param resultCode the ResultCodeEnum for this exception
56       * @param message The exception message
57       * @param cause The root cause for this exception
58       */
59      public LdapSchemaViolationException( ResultCodeEnum resultCode, String message, Throwable cause )
60      {
61          super( message, cause );
62          checkResultCode( resultCode );
63          this.resultCode = resultCode;
64      }
65  
66  
67      /**
68       * Creates a new instance of LdapSchemaViolationException.
69       * 
70       * @param resultCode the ResultCodeEnum for this exception
71       */
72      public LdapSchemaViolationException( ResultCodeEnum resultCode )
73      {
74          super( null );
75          checkResultCode( resultCode );
76          this.resultCode = resultCode;
77      }
78  
79  
80      /**
81       * Checks to make sure the resultCode value is right for this exception
82       * type.
83       * 
84       * @throws IllegalArgumentException
85       *             if the result code is not one of
86       *             {@link ResultCodeEnum#OBJECT_CLASS_VIOLATION},
87       *             {@link ResultCodeEnum#NOT_ALLOWED_ON_RDN}.
88       *             {@link org.apache.directory.api.ldap.model.message.ResultCodeEnum#OBJECT_CLASS_MODS_PROHIBITED}.
89       */
90      private void checkResultCode( ResultCodeEnum resultCode )
91      {
92          switch ( resultCode )
93          {
94              case OBJECT_CLASS_VIOLATION:
95              case NOT_ALLOWED_ON_RDN:
96              case OBJECT_CLASS_MODS_PROHIBITED:
97                  return;
98  
99              default:
100                 throw new IllegalArgumentException( I18n.err( I18n.ERR_04140_UNACCEPTABLE_RESULT_CODE, resultCode ) );
101         }
102     }
103 }