001/* 002 * (C) Copyright 2006-2013 Nuxeo SAS (http://nuxeo.com/) and contributors. 003 * 004 * All rights reserved. This program and the accompanying materials 005 * are made available under the terms of the GNU Lesser General Public License 006 * (LGPL) version 2.1 which accompanies this distribution, and is available at 007 * http://www.gnu.org/licenses/lgpl.html 008 * 009 * This library is distributed in the hope that it will be useful, 010 * but WITHOUT ANY WARRANTY; without even the implied warranty of 011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 012 * Lesser General Public License for more details. 013 * 014 * Contributors: 015 * Nuxeo - initial API and implementation 016 * 017 */ 018 019package org.nuxeo.ecm.directory.ldap; 020 021import org.nuxeo.ecm.core.api.RecoverableClientException; 022 023/** 024 * Interface used to provide a pluggable LDAP Exception processor 025 * 026 * @author <a href="mailto:tdelprat@nuxeo.com">Tiry</a> 027 * @since 5.7 028 */ 029public interface LdapExceptionProcessor { 030 031 /** 032 * Implementation should check the input Exception and turn it into a RecoverableClientException if the Exception 033 * should be displayed to the end user. 034 * 035 * @param e 036 * @return a RecoverableClientException if needed and null otherwise 037 */ 038 RecoverableClientException extractRecoverableException(Exception e); 039 040}