001/*
002 * (C) Copyright 2012 Nuxeo SA (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 *     Antoine Taillefer <ataillefer@nuxeo.com>
016 */
017package org.nuxeo.drive.service;
018
019import java.security.Principal;
020
021import org.nuxeo.drive.adapter.FolderItem;
022import org.nuxeo.drive.service.impl.DefaultTopLevelFolderItemFactory;
023
024/**
025 * Interface for the classes contributed to the {@code topLevelFolderItemFactory} extension point of the
026 * {@link FileSystemItemAdapterService}.
027 * <p>
028 * Allows to get the top level {@link FolderItem} for a given user.
029 *
030 * @author Antoine Taillefer
031 * @see DefaultTopLevelFolderItemFactory
032 */
033public interface TopLevelFolderItemFactory extends VirtualFolderItemFactory {
034
035    FolderItem getTopLevelFolderItem(Principal principal);
036
037}