001/*
002 * (C) Copyright 2006-2007 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 * $Id$
017 */
018
019package org.nuxeo.ecm.directory;
020
021import java.util.List;
022
023public interface DirectoryFactory {
024
025    String getName();
026
027    /**
028     * Returns the directory with the given name.
029     *
030     * @param name the name of the directory
031     * @return the directory with the given name
032     * @throws DirectoryException
033     */
034    Directory getDirectory(String name) throws DirectoryException;
035
036    /**
037     * @return a list with all the directories managed by this factory
038     * @throws DirectoryException
039     */
040    List<Directory> getDirectories() throws DirectoryException;
041
042    void shutdown() throws DirectoryException;
043
044}