opencms整站開發之五--- 調用opencms源碼創建文件

在opencms中存兩種基本的文件類型，一種是 File,另一種是 folder. 通常的JSP,HTML 就屬於File類型。而文件夾只有一種，不用多說。這個兩種文件都繼承於 org.opencms.file.CmsResource 這個基類。CmsResource是opencms中最基本類型。創建它，也就是創建了File 或是 folder了。

要創建文件，我們必須瞭解opencms的核心工具類 org.opencms.file.CmsObject ,先摘錄其源碼的註釋：

 

 

/* * File : $Source: /usr/local/cvs/opencms/src/org/opencms/file/CmsObject.java,v $ * Date : $Date: 2008-04-21 08:35:04 $ * Version: $Revision: 1.163 $ * * This library is part of OpenCms - * the Open Source Content Management System * * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com) * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * For further information about Alkacon Software GmbH, please see the * company website: http://www.alkacon.com * * For further information about OpenCms, please see the * project website: http://www.opencms.org * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ package org.opencms.file; import org.opencms.db.CmsDbEntryNotFoundException; import org.opencms.db.CmsPublishList; import org.opencms.db.CmsResourceState; import org.opencms.db.CmsSecurityManager; import org.opencms.db.CmsUserSettings; import org.opencms.file.history.CmsHistoryPrincipal; import org.opencms.file.history.CmsHistoryProject; import org.opencms.file.history.I_CmsHistoryResource; import org.opencms.file.types.I_CmsResourceType; import org.opencms.lock.CmsLock; import org.opencms.lock.CmsLockFilter; import org.opencms.lock.CmsLockType; import org.opencms.main.CmsException; import org.opencms.main.CmsIllegalArgumentException; import org.opencms.main.I_CmsEventListener; import org.opencms.main.OpenCms; import org.opencms.relations.CmsRelationFilter; import org.opencms.relations.CmsRelationType; import org.opencms.report.CmsShellReport; import org.opencms.report.I_CmsReport; import org.opencms.security.CmsAccessControlEntry; import org.opencms.security.CmsAccessControlList; import org.opencms.security.CmsOrganizationalUnit; import org.opencms.security.CmsPermissionSet; import org.opencms.security.CmsPrincipal; import org.opencms.security.CmsRole; import org.opencms.security.CmsRoleViolationException; import org.opencms.security.CmsSecurityException; import org.opencms.security.I_CmsPermissionHandler; import org.opencms.security.I_CmsPrincipal; import org.opencms.util.CmsUUID; import org.opencms.workplace.CmsWorkplace; import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Set; /** * This pivotal class provides all authorized access to the OpenCms VFS resources.<p> * * It encapsulates user identification and permissions. * Think of it as an initialized "shell" to access the OpenCms VFS. * Every call to a method here will be checked for user permissions * according to the <code>{@link org.opencms.file.CmsRequestContext}</code> this CmsObject instance was created with.<p> * * From a JSP page running in OpenCms, use <code>{@link org.opencms.jsp.CmsJspBean#getCmsObject()}</code> to gain * access to the current users CmsObject. Usually this is done with a <code>{@link org.opencms.jsp.CmsJspActionElement}</code>.<p> * * To generate a new instance of this class in your application, use * <code>{@link org.opencms.main.OpenCms#initCmsObject(String)}</code>. The argument String should be * the name of the guest user, usually "Guest" and more formally obtained by <code>{@link org.opencms.db.CmsDefaultUsers#getUserGuest()}</code>. * This will give you an initialized context with guest user permissions. * Then use <code>{@link CmsObject#loginUser(String, String)}</code> to log in the user you want. * Obviously you need the password for the new user. * You should never try to create an instance of this class using the constructor, * this is reserved for internal operation only.<p> * * @author Alexander Kandzior * @author Thomas Weckert * @author Carsten Weinholz * @author Andreas Zahner * @author Michael Moossen * * @version $Revision: 1.163 $ * * @since 6.0.0 */ public final class CmsObject { /** The request context. */ protected CmsRequestContext m_context; /** The security manager to access the cms. */ protected CmsSecurityManager m_securityManager;

 

         從第一句不難看出，些類提供了對 opencms VFS(虛擬文件系統）合法，授權訪問。

         他提供了很多創建，刪除，修改VFS的方法。

 

/** * Creates a new resource of the given resource type * with the provided content and properties.<p> * * @param resourcename the name of the resource to create (full current site relative path) * @param type the type of the resource to create * @param content the contents for the new resource * @param properties the properties for the new resource * * @return the created resource * * @throws CmsException if something goes wrong * @throws CmsIllegalArgumentException if the <code>resourcename</code> argument is null or of length 0 */ public CmsResource createResource(String resourcename, int type, byte[] content, List properties) throws CmsException, CmsIllegalArgumentException { return getResourceType(type).createResource(this, m_securityManager, resourcename, content, properties); }

 

         上面的代碼片斷，就是其創建 CmsResource 方法。當然，這只是一個高度抽象的API接口，內部層層調用了很多工廠提供的方法來創建資源。最底層是利用JDBC 創建了一條記錄插入數據庫。

 

要調用CmsObject 所提供的方法來進行自己的操作.我們必須先得到CmsObject 實例.你可在opencms正常執行的某一環節進來獲取CmsObject. 或可以在自己創建. 下面是在 jsp 中的創建方法:      

 

org.opencms.jsp.CmsJspActionElement cms = new org.opencms.jsp.CmsJspActionElement( pageContext, request, response); CmsObject cobject = cms.getCmsObject();

 

得到了CmsObject實例對象,你可以進行自己的操作了.

 

 下面是我寫的一個工具類的方法:

 /** * * 創建一個CmsResource * * @param cms * CmsObject * @param fullResourceName * 文件的相對路徑 比如從根目錄開始: module1/news1/news_9999.html * @param content * 二進度形式的字節文件 可以爲空 * @param fileType * 要創建的文件類型 比如 "jsp" 最後會轉換成類型對應的ID 如我以前寫的文章裏所定義的 7800 * @param properties * 相關屬性 你可以在list加入一些CmsProperty來爲些文件設置相關屬性 null * @return 創建的CmsResource * */ public static CmsResource createFile(CmsObject cms, String fullResourceName, byte[] content, String fileType, List<CmsProperty> properties) { CmsResource cmsResource = null; try { /** * 類型 */ I_CmsResourceType resType = OpenCms.getResourceManager() .getResourceType(fileType); cmsResource = cms.createResource(fullResourceName, resType .getTypeId(), content, properties); } catch (CmsException e) { LOG.error("CmsException", e); } catch (Exception e) { LOG.error("Exception", e); } return cmsResource; }

 

CmsProperty 可以用下面的方法創建:

 

/** * 創建一個屬性對象 * * @param name * @param value */ public static CmsProperty generatePropertie(String name, String value) { CmsProperty prop = new CmsProperty(); prop.setAutoCreatePropertyDefinition(true); prop.setName(name); prop.setValue(value, CmsProperty.TYPE_SHARED); return prop; }