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.ldap.message.ResultCodeEnum;
026
027
028 /**
029 * Makes a SchemaViolationException unambiguous with respect to the result code
030 * it corresponds to by associating an LDAP specific result code with it.
031 *
032 * @see <a
033 * href="http://java.sun.com/j2se/1.4.2/docs/guide/jndi/jndi-ldap-gl.html#EXCEPT">
034 * LDAP ResultCode to JNDI Exception Mappings</a>
035 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
036 * @version $Rev: 613579 $
037 */
038 public class LdapSchemaViolationException extends SchemaViolationException implements LdapException
039 {
040 static final long serialVersionUID = 5763624876999168014L;
041
042 /** the LDAP resultCode this exception is associated with */
043 private final ResultCodeEnum resultCode;
044
045
046 /**
047 * Creates an Ldap NamingException using a result code.
048 *
049 * @param resultCode
050 * the LDAP resultCode this exception is associated with
051 * @throws IllegalArgumentException
052 * if the resultCode argument is not
053 * ResultCodeEnum.OBJECTCLASSVIOLATION,
054 * ResultCodeEnum.NOTALLOWEDONRDN, or
055 * ResultCodeEnum.OBJECTCLASSMODSPROHIBITED
056 */
057 public LdapSchemaViolationException(ResultCodeEnum resultCode)
058 {
059 super();
060
061 switch ( resultCode )
062 {
063 case OBJECT_CLASS_VIOLATION :
064 case NOT_ALLOWED_ON_RDN :
065 case OBJECT_CLASS_MODS_PROHIBITED :
066 break;
067
068 default:
069
070 throw new IllegalArgumentException( resultCode + " is not an acceptable result code." );
071 }
072
073 this.resultCode = resultCode;
074 }
075
076
077 /**
078 * Creates an Eve NamingException.
079 *
080 * @param explanation
081 * an explanation for the failure
082 * @param resultCode
083 * the LDAP resultCode this exception is associated with
084 */
085 public LdapSchemaViolationException(String explanation, ResultCodeEnum resultCode)
086 {
087 super( explanation );
088
089 this.resultCode = resultCode;
090 }
091
092
093 /**
094 * Gets the LDAP resultCode this exception is associated with.
095 *
096 * @return the LDAP resultCode this exception is associated with
097 */
098 public ResultCodeEnum getResultCode()
099 {
100 return this.resultCode;
101 }
102 }