001 /*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements. See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership. The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License. You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied. See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 *
019 */
020 package org.apache.directory.shared.ldap.exception;
021
022
023 import javax.naming.directory.SchemaViolationException;
024
025 import org.apache.directory.shared.i18n.I18n;
026 import org.apache.directory.shared.ldap.message.ResultCodeEnum;
027
028
029 /**
030 * Makes a SchemaViolationException unambiguous with respect to the result code
031 * it corresponds to by associating an LDAP specific result code with it.
032 *
033 * @see <a
034 * href="http://java.sun.com/j2se/1.4.2/docs/guide/jndi/jndi-ldap-gl.html#EXCEPT">
035 * LDAP ResultCode to JNDI Exception Mappings</a>
036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
037 * @version $Rev: 912436 $
038 */
039 public class LdapSchemaViolationException extends SchemaViolationException implements LdapException
040 {
041 static final long serialVersionUID = 5763624876999168014L;
042
043 /** the LDAP resultCode this exception is associated with */
044 private final ResultCodeEnum resultCode;
045
046
047 /**
048 * Creates an Ldap NamingException using a result code.
049 *
050 * @param resultCode
051 * the LDAP resultCode this exception is associated with
052 * @throws IllegalArgumentException
053 * if the resultCode argument is not
054 * ResultCodeEnum.OBJECTCLASSVIOLATION,
055 * ResultCodeEnum.NOTALLOWEDONRDN, or
056 * ResultCodeEnum.OBJECTCLASSMODSPROHIBITED
057 */
058 public LdapSchemaViolationException(ResultCodeEnum resultCode)
059 {
060 super();
061
062 switch ( resultCode )
063 {
064 case OBJECT_CLASS_VIOLATION :
065 case NOT_ALLOWED_ON_RDN :
066 case OBJECT_CLASS_MODS_PROHIBITED :
067 break;
068
069 default:
070
071 throw new IllegalArgumentException( I18n.err( I18n.ERR_04141, resultCode ) );
072 }
073
074 this.resultCode = resultCode;
075 }
076
077
078 /**
079 * Creates an Eve NamingException.
080 *
081 * @param explanation
082 * an explanation for the failure
083 * @param resultCode
084 * the LDAP resultCode this exception is associated with
085 */
086 public LdapSchemaViolationException(String explanation, ResultCodeEnum resultCode)
087 {
088 super( explanation );
089
090 this.resultCode = resultCode;
091 }
092
093
094 /**
095 * Gets the LDAP resultCode this exception is associated with.
096 *
097 * @return the LDAP resultCode this exception is associated with
098 */
099 public ResultCodeEnum getResultCode()
100 {
101 return this.resultCode;
102 }
103 }