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 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.platform.filemanager.service.extension;
023
024import org.nuxeo.ecm.core.api.CoreSession;
025import org.nuxeo.ecm.core.api.DocumentModel;
026import org.nuxeo.ecm.platform.filemanager.api.FileManager;
027import org.nuxeo.ecm.platform.filemanager.service.FileManagerService;
028import org.nuxeo.ecm.platform.types.TypeManager;
029import org.nuxeo.runtime.api.Framework;
030
031// Not used but please keep, it will be needed once the
032// FileManagerService#createDefaultFolder method is extracted to a plugin.
033public abstract class AbstractFolderImporter implements FolderImporter {
034
035    protected String name = "";
036
037    // to be used by plugin implementation to gain access to standard file
038    // creation utility methods without having to lookup the service
039    /**
040     * @deprecated since 11.1, use {@link Framework#getService(Class)} instead if needed
041     */
042    @Deprecated(since = "11.1")
043    protected FileManagerService fileManagerService;
044
045    protected AbstractFolderImporter() {
046        this.fileManagerService = (FileManagerService) Framework.getService(FileManager.class);
047    }
048
049    @Override
050    public DocumentModel create(CoreSession documentManager, String fullname, String path, boolean overwrite,
051            TypeManager typeManager) {
052        // sample implementation to override in a custom FolderImporter
053        // implementation
054        return ((FileManagerService) Framework.getService(FileManager.class)).defaultCreateFolder(documentManager,
055                fullname, path, overwrite);
056    }
057
058    @Override
059    public String getName() {
060        return name;
061    }
062
063    @Override
064    public void setName(String name) {
065        this.name = name;
066    }
067
068    @Override
069    public void setFileManagerService(FileManagerService fileManagerService) {
070        this.fileManagerService = fileManagerService;
071    }
072
073}