KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > synchronize > I_CmsSynchronizeModification


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/synchronize/I_CmsSynchronizeModification.java,v $
3  * Date : $Date: 2005/06/26 12:23:30 $
4  * Version: $Revision: 1.6 $
5  *
6  * This library is part of OpenCms -
7  * the Open Source Content Mananagement System
8  *
9  * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about Alkacon Software GmbH, please see the
22  * company website: http://www.alkacon.com
23  *
24  * For further information about OpenCms, please see the
25  * project website: http://www.opencms.org
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  */
31
32 package org.opencms.synchronize;
33
34 import org.opencms.file.CmsObject;
35 import org.opencms.file.CmsResource;
36
37 import java.io.File JavaDoc;
38
39 /**
40  * Defines methods which can be pluged into the syncronisation process between VFS and "real" FS.<p>
41  *
42  * @author Michael Emmerich
43  *
44  * @version $Revision: 1.6 $
45  *
46  * @since 6.0.0
47  */
48 public interface I_CmsSynchronizeModification {
49
50     /**
51      * Possibility to modify a resource after it has benn exported or updated
52      * to the FS.<p>
53      *
54      * @param cms the current CmsObject
55      * @param vfsRes the resource in the VFS
56      * @param fsFile the resource in the FS
57      * @throws CmsSynchronizeException if something goes wrong
58      */
59     void modifyFs(CmsObject cms, CmsResource vfsRes, File JavaDoc fsFile) throws CmsSynchronizeException;
60
61     /**
62      * Possibility to modify a resource after it has been imported or updated
63      * into the VFS.<p>
64      *
65      * @param cms the current CmsObject
66      * @param vfsRes the resource in the VFS
67      * @param fsFile the resource in the FS
68      * @throws CmsSynchronizeException if something goes wrong
69      */
70     void modifyVfs(CmsObject cms, CmsResource vfsRes, File JavaDoc fsFile) throws CmsSynchronizeException;
71
72     /**
73      * Translates the resource name.<p>
74      *
75      * This is nescessary since the server FS does allow different naming
76      * conventions than the VFS.
77      * If no special translation is required and the default OpenCms FS-VFS
78      * translation should be used,
79      * null must be returned.
80      *
81      * @param cms the current CmsObject
82      * @param resName the resource name to be translated
83      * @return the translated resource name or null
84      * @throws CmsSynchronizeException if something goes wrong
85      */
86     String JavaDoc translate(CmsObject cms, String JavaDoc resName) throws CmsSynchronizeException;
87 }
88
Popular Tags