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