001: /*
002: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/importexport/CmsImportParameters.java,v $
003: * Date : $Date: 2008-02-27 12:05:48 $
004: * Version: $Revision: 1.3 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.importexport;
033:
034: /**
035: * Import parameters.<p>
036: *
037: * @author Michael Moossen
038: *
039: * @version $Revision: 1.3 $
040: *
041: * @since 7.0.4
042: */
043: public class CmsImportParameters {
044:
045: /** The path in the OpenCms VFS to import into.*/
046: private String m_destinationPath;
047:
048: /** If set, the permissions set on existing resources will not be modified.*/
049: private boolean m_keepPermissions;
050:
051: /** The file path, could be a folder or a zip file. */
052: private String m_path;
053:
054: /** If set, the manifest.xml file will be validated during the import. */
055: private boolean m_xmlValidation;
056:
057: /**
058: * Constructor.<p>
059: *
060: * @param path the file path, could be a folder or a zip file
061: * @param destination path in the OpenCms VFS to import into
062: * @param keepPermissions if set, the permissions set on existing resources will not be modified
063: */
064: public CmsImportParameters(String path, String destination,
065: boolean keepPermissions) {
066:
067: setPath(path);
068: setDestinationPath(destination);
069: setKeepPermissions(keepPermissions);
070: }
071:
072: /**
073: * Returns the path in the OpenCms VFS to import into.<p>
074: *
075: * @return the path in the OpenCms VFS to import into
076: */
077: public String getDestinationPath() {
078:
079: return m_destinationPath;
080: }
081:
082: /**
083: * Returns the file path, could be a folder or a zip file.<p>
084: *
085: * @return the file path
086: */
087: public String getPath() {
088:
089: return m_path;
090: }
091:
092: /**
093: * Returns the keep permissions flags.
094: * if set, the permissions set on existing resources will not be modified.<p>
095: *
096: * @return the keep permissions flag
097: */
098: public boolean isKeepPermissions() {
099:
100: return m_keepPermissions;
101: }
102:
103: /**
104: * Checks if the manifest.xml file will be validated during the import.<p>
105: *
106: * @return the xml validation flag
107: */
108: public boolean isXmlValidation() {
109:
110: return m_xmlValidation;
111: }
112:
113: /**
114: * Sets the path in the OpenCms VFS to import into.<p>
115: *
116: * @param importPath the import path to set
117: */
118: public void setDestinationPath(String importPath) {
119:
120: m_destinationPath = importPath;
121: }
122:
123: /**
124: * Sets the keep permissions flag.
125: * If set, the permissions set on existing resources will not be modified.<p>
126: *
127: * @param keepPermissions the keep permissions flag to set
128: */
129: public void setKeepPermissions(boolean keepPermissions) {
130:
131: m_keepPermissions = keepPermissions;
132: }
133:
134: /**
135: * Sets the file path, could be a folder or a zip file.<p>
136: *
137: * @param path the file path, could be a folder or a zip file
138: */
139: public void setPath(String path) {
140:
141: m_path = path;
142: }
143:
144: /**
145: * Sets the xml validation flag. If set, the manifest.xml file will be validated during the import.<p>
146: *
147: * @param xmlValidation the xml validation flag to set
148: */
149: public void setXmlValidation(boolean xmlValidation) {
150:
151: m_xmlValidation = xmlValidation;
152: }
153: }
|