org.springframework.ldap.NamingExceptionTranslator Maven / Gradle / Ivy

/*
 * Copyright 2002-2005 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.ldap;

import javax.naming.NamingException;

import org.springframework.dao.DataAccessException;

/**
 * Interface to be implemented by classes that can translate between
 * NamingExceptions and DataAccessExceptions.
 * 
 * @author Mattias Arthursson
 * 
 */
public interface NamingExceptionTranslator {
    /**
     * Translate the given NamingException into a generic data access exception.
     * @param namingException
     *            the offending NamingException.
     * 
     * @return the DataAccessException to throw.
     */
    public DataAccessException translate(NamingException namingException);
}