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 public LdapInvalidDnException( String message ) 43 { 44 super( message ); 45 } 46 47 48 /** 49 * to be used by some special exceptions like LdapInvalidDnException 50 * 51 * @param message The exception message 52 * @param cause The root cause for this exception 53 */ 54 public LdapInvalidDnException( String message, Throwable cause ) 55 { 56 super( message, cause ); 57 } 58 59 60 /** 61 * Creates a new instance of LdapInvalidDnException. 62 * 63 * @param resultCode the ResultCodeEnum for this exception 64 * @param message The exception message 65 */ 66 public LdapInvalidDnException( ResultCodeEnum resultCode, String message ) 67 { 68 super( message ); 69 checkResultCode( resultCode ); 70 this.resultCode = resultCode; 71 } 72 73 74 /** 75 * Creates a new instance of LdapInvalidDnException. 76 * 77 * @param resultCode the ResultCodeEnum for this exception 78 * @param message The exception message 79 * @param cause The root cause for this exception 80 */ 81 public LdapInvalidDnException( ResultCodeEnum resultCode, String message, Throwable cause ) 82 { 83 super( message, cause ); 84 checkResultCode( resultCode ); 85 this.resultCode = resultCode; 86 } 87 88 89 /** 90 * Creates a new instance of LdapInvalidDnException. 91 * 92 * @param resultCode the ResultCodeEnum for this exception 93 */ 94 public LdapInvalidDnException( ResultCodeEnum resultCode ) 95 { 96 super( null ); 97 checkResultCode( resultCode ); 98 this.resultCode = resultCode; 99 } 100 101 102 /** 103 * Checks to make sure the resultCode value is right for this exception 104 * type. 105 * 106 * @throws IllegalArgumentException 107 * if the result code is not one of 108 * {@link ResultCodeEnum#INVALID_DN_SYNTAX}, 109 * {@link ResultCodeEnum#NAMING_VIOLATION}. 110 */ 111 private void checkResultCode( ResultCodeEnum resultCode ) 112 { 113 switch ( resultCode ) 114 { 115 case INVALID_DN_SYNTAX: 116 case NAMING_VIOLATION: 117 return; 118 119 default: 120 throw new IllegalArgumentException( I18n.err( I18n.ERR_04140_UNACCEPTABLE_RESULT_CODE, resultCode ) ); 121 } 122 } 123 }