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.InvalidAttributeValueException;
024
025 import org.apache.directory.shared.ldap.message.ResultCodeEnum;
026
027
028 /**
029 * Makes a InvalidAttributeValueException unambiguous with respect to the result
030 * code 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 LdapInvalidAttributeValueException extends InvalidAttributeValueException 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 InvalidAttributeValueException 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.CONSTRAINTVIOLATION, or
054 * ResultCodeEnum.INVALIDATTRIBUTESYNTAX
055 */
056 public LdapInvalidAttributeValueException(ResultCodeEnum resultCode)
057 {
058 super();
059
060 switch ( resultCode )
061 {
062 case CONSTRAINT_VIOLATION :
063 case INVALID_ATTRIBUTE_SYNTAX :
064 break;
065
066 default:
067
068 throw new IllegalArgumentException( resultCode + " is not an acceptable result code." );
069 }
070
071 this.resultCode = resultCode;
072 }
073
074
075 /**
076 * Creates an Ldap InvalidAttributeValueException using a result code and a
077 * specific message.
078 *
079 * @param explanation
080 * an explanation for the failure
081 * @param resultCode
082 * the LDAP resultCode this exception is associated with
083 */
084 public LdapInvalidAttributeValueException(String explanation, ResultCodeEnum resultCode)
085 {
086 super( explanation );
087
088 this.resultCode = resultCode;
089 }
090
091
092 /**
093 * Gets the LDAP resultCode this exception is associated with.
094 *
095 * @return the LDAP resultCode this exception is associated with
096 */
097 public ResultCodeEnum getResultCode()
098 {
099 return this.resultCode;
100 }
101 }