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.i18n.I18n;
026 import org.apache.directory.shared.ldap.message.ResultCodeEnum;
027
028
029 /**
030 * Makes a InvalidAttributeValueException unambiguous with respect to the result
031 * code 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 LdapInvalidAttributeValueException extends InvalidAttributeValueException 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 InvalidAttributeValueException 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.CONSTRAINTVIOLATION, or
055 * ResultCodeEnum.INVALIDATTRIBUTESYNTAX
056 */
057 public LdapInvalidAttributeValueException(ResultCodeEnum resultCode)
058 {
059 super();
060
061 switch ( resultCode )
062 {
063 case CONSTRAINT_VIOLATION :
064 case INVALID_ATTRIBUTE_SYNTAX :
065 break;
066
067 default:
068
069 throw new IllegalArgumentException( I18n.err( I18n.ERR_04141, resultCode ) );
070 }
071
072 this.resultCode = resultCode;
073 }
074
075
076 /**
077 * Creates an Ldap InvalidAttributeValueException using a result code and a
078 * specific message.
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 LdapInvalidAttributeValueException(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 }