001/* 002 * (C) Copyright 2012 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 * Antoine Taillefer <ataillefer@nuxeo.com> 018 */ 019package org.nuxeo.drive.service; 020 021import java.security.Principal; 022 023import org.nuxeo.drive.adapter.FolderItem; 024 025/** 026 * Interface for the classes contributed to the {@code topLevelFolderItemFactory} extension point of the 027 * {@link FileSystemItemAdapterService}. 028 * <p> 029 * Allows to get a virtual {@link FolderItem} for a given user. 030 * 031 * @author Antoine Taillefer 032 * @see XXX 033 */ 034public interface VirtualFolderItemFactory extends FileSystemItemFactory { 035 036 /** 037 * Returns the (unique) virtual {@link FolderItem}. 038 */ 039 FolderItem getVirtualFolderItem(Principal principal); 040 041 String getFolderName(); 042 043 void setFolderName(String folderName); 044 045}