001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.synchronize;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032
033import java.io.File;
034
035/**
036 * Defines methods which can be pluged into the syncronisation process between VFS and "real" FS.<p>
037 *
038 * @since 6.0.0
039 */
040public interface I_CmsSynchronizeModification {
041
042    /**
043     * Possibility to modify a resource after it has benn exported or updated
044     * to the FS.<p>
045     *
046     * @param cms the current CmsObject
047     * @param vfsRes the resource in the VFS
048     * @param fsFile the resource in the FS
049     * @throws CmsSynchronizeException if something goes wrong
050     */
051    void modifyFs(CmsObject cms, CmsResource vfsRes, File fsFile) throws CmsSynchronizeException;
052
053    /**
054     * Possibility to modify a resource after it has been imported or updated
055     * into the VFS.<p>
056     *
057     * @param cms the current CmsObject
058     * @param vfsRes the resource in the VFS
059     * @param fsFile the resource in the FS
060     * @throws CmsSynchronizeException if something goes wrong
061     */
062    void modifyVfs(CmsObject cms, CmsResource vfsRes, File fsFile) throws CmsSynchronizeException;
063
064    /**
065     * Translates the resource name.<p>
066     *
067     * This is nescessary since the server FS does allow different naming
068     * conventions than the VFS.
069     * If no special translation is required and the default OpenCms FS-VFS
070     * translation should be used,
071     * null must be returned.
072     *
073     * @param cms the current CmsObject
074     * @param resName the resource name to be translated
075     * @return the translated resource name or null
076     * @throws CmsSynchronizeException if something goes wrong
077     */
078    String translate(CmsObject cms, String resName) throws CmsSynchronizeException;
079}