001/*
002 * (C) Copyright 2006-2013 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 */
020
021package org.nuxeo.ecm.directory.ldap;
022
023import org.nuxeo.ecm.core.api.RecoverableClientException;
024
025/**
026 * Interface used to provide a pluggable LDAP Exception processor
027 * 
028 * @author <a href="mailto:[email protected]">Tiry</a>
029 * @since 5.7
030 */
031public interface LdapExceptionProcessor {
032
033    /**
034     * Implementation should check the input Exception and turn it into a RecoverableClientException if the Exception
035     * should be displayed to the end user.
036     * 
037     * @param e
038     * @return a RecoverableClientException if needed and null otherwise
039     */
040    RecoverableClientException extractRecoverableException(Exception e);
041
042}