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 * A subclass of {@link LdapOperationException} designed to hold an unequivocal LDAP 29 * result code. 30 * 31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 32 */ 33 public class LdapInvalidDnException extends LdapOperationException 34 { 35 /** The serial version UUID */ 36 static final long serialVersionUID = 1L; 37 38 39 /** 40 * To be used by some special exceptions like LdapInvalidDnException 41 * 42 * @param message The message for this exception 43 */ 44 public LdapInvalidDnException( String message ) 45 { 46 super( message ); 47 } 48 49 50 /** 51 * to be used by some special exceptions like LdapInvalidDnException 52 * 53 * @param message The exception message 54 * @param cause The root cause for this exception 55 */ 56 public LdapInvalidDnException( String message, Throwable cause ) 57 { 58 super( message, cause ); 59 } 60 61 62 /** 63 * Creates a new instance of LdapInvalidDnException. 64 * 65 * @param resultCode the ResultCodeEnum for this exception 66 * @param message The exception message 67 */ 68 public LdapInvalidDnException( ResultCodeEnum resultCode, String message ) 69 { 70 super( message ); 71 checkResultCode( resultCode ); 72 this.resultCode = resultCode; 73 } 74 75 76 /** 77 * Creates a new instance of LdapInvalidDnException. 78 * 79 * @param resultCode the ResultCodeEnum for this exception 80 * @param message The exception message 81 * @param cause The root cause for this exception 82 */ 83 public LdapInvalidDnException( ResultCodeEnum resultCode, String message, Throwable cause ) 84 { 85 super( message, cause ); 86 checkResultCode( resultCode ); 87 this.resultCode = resultCode; 88 } 89 90 91 /** 92 * Creates a new instance of LdapInvalidDnException. 93 * 94 * @param resultCode the ResultCodeEnum for this exception 95 */ 96 public LdapInvalidDnException( ResultCodeEnum resultCode ) 97 { 98 super( null ); 99 checkResultCode( resultCode ); 100 this.resultCode = resultCode; 101 } 102 103 104 /** 105 * Checks to make sure the resultCode value is right for this exception 106 * type. 107 * 108 * @throws IllegalArgumentException 109 * if the result code is not one of 110 * {@link ResultCodeEnum#INVALID_DN_SYNTAX}, 111 * {@link ResultCodeEnum#NAMING_VIOLATION}. 112 */ 113 private void checkResultCode( ResultCodeEnum resultCode ) 114 { 115 switch ( resultCode ) 116 { 117 case INVALID_DN_SYNTAX: 118 case NAMING_VIOLATION: 119 return; 120 121 default: 122 throw new IllegalArgumentException( I18n.err( I18n.ERR_04140_UNACCEPTABLE_RESULT_CODE, resultCode ) ); 123 } 124 } 125 }