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 */
020package org.apache.directory.shared.ldap.model.exception;
021
022
023import org.apache.directory.shared.i18n.I18n;
024import org.apache.directory.shared.ldap.model.message.ResultCodeEnum;
025
026
027/**
028 * Makes a {@link LdapOperationException} unambiguous with respect to the result code
029 * it corresponds to by associating an LDAP specific result code with it.
030 * 
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public class LdapSchemaViolationException extends LdapOperationException
034{
035    /** The serial version UUID */
036    static final long serialVersionUID = 1L;
037
038    /**
039     * Creates a new instance of LdapSchemaViolationException.
040     *
041     * @param resultCode the ResultCodeEnum for this exception
042     * @param message The exception message
043     */
044    public LdapSchemaViolationException( ResultCodeEnum resultCode, String message )
045    {
046        super( message );
047        checkResultCode( resultCode );
048        this.resultCode = resultCode;
049    }
050
051
052    /**
053     *
054     * @param resultCode the ResultCodeEnum for this exception
055     * @param message The exception message
056     * @param cause The root cause for this exception
057     */
058    public LdapSchemaViolationException( ResultCodeEnum resultCode, String message, Throwable cause )
059    {
060        super( message, cause );
061        checkResultCode( resultCode );
062        this.resultCode = resultCode;
063    }
064    
065    
066    /**
067     * Creates a new instance of LdapSchemaViolationException.
068     * 
069     * @param resultCode the ResultCodeEnum for this exception
070     */
071    public LdapSchemaViolationException( ResultCodeEnum resultCode )
072    {
073        super( null );
074        checkResultCode( resultCode );
075        this.resultCode = resultCode;
076    }
077
078
079    /**
080     * Checks to make sure the resultCode value is right for this exception
081     * type.
082     * 
083     * @throws IllegalArgumentException
084     *             if the result code is not one of
085     *             {@link ResultCodeEnum#OBJECT_CLASS_VIOLATION},
086     *             {@link ResultCodeEnum#NOT_ALLOWED_ON_RDN}.
087     *             {@link org.apache.directory.shared.ldap.model.message.ResultCodeEnum#OBJECT_CLASS_MODS_PROHIBITED}.
088     */
089    private void checkResultCode( ResultCodeEnum resultCode )
090    {
091        switch ( resultCode )
092        {
093            case OBJECT_CLASS_VIOLATION :
094            case NOT_ALLOWED_ON_RDN :
095            case OBJECT_CLASS_MODS_PROHIBITED :
096                return;
097                
098            default:
099                throw new IllegalArgumentException( I18n.err( I18n.ERR_04140_UNACCEPTABLE_RESUT_CODE, resultCode ) );
100        }
101    }
102}