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
021 package org.apache.directory.shared.ldap.message.spi;
022
023
024 import org.apache.directory.shared.ldap.message.MessageException;
025
026
027 /**
028 * This exception is thrown when provider specific errors occur.
029 *
030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031 * @version $Revision: 437007 $
032 */
033 public class ProviderException extends MessageException
034 {
035 static final long serialVersionUID = 8915445282948982052L;
036
037 /** The provider this exception resulted on */
038 private final Provider m_provider;
039
040
041 /**
042 * Gets the provider that caused this exception.
043 *
044 * @return the offensive Provider.
045 */
046 public Provider getProvider()
047 {
048 return m_provider;
049 }
050
051
052 /**
053 * Constructs an Exception without a message.
054 *
055 * @param a_provider
056 * The offending Provider that caused the exception.
057 */
058 public ProviderException(final Provider a_provider)
059 {
060 super();
061 m_provider = a_provider;
062 }
063
064
065 /**
066 * Constructs an Exception with a detailed message.
067 *
068 * @param a_provider
069 * The offending Provider that caused the exception.
070 * @param a_message
071 * The message associated with the exception.
072 */
073 public ProviderException(final Provider a_provider, String a_message)
074 {
075 super( a_message );
076 m_provider = a_provider;
077 }
078 }