CmsAdminProjectLockchange


1   /*
2   * File   : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/workplace/CmsAdminProjectLockchange.java,v $
3   * Date   : $Date: 2005/05/31 15:51:19 $
4   * Version: $Revision: 1.2 $
5   *
6   * This library is part of OpenCms -
7   * the Open Source Content Mananagement System
8   *
9   * Copyright (C) 2001  The OpenCms Group
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 OpenCms, please see the
22  * OpenCms Website: http://www.opencms.org 
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27  */
28  
29  package com.opencms.workplace;
30  
31  import org.opencms.file.CmsObject;
32  import org.opencms.file.CmsProject;
33  import org.opencms.main.CmsException;
34  import org.opencms.main.CmsLog;
35  
36  import java.util.Hashtable  ;
37  
38  /**
39   * Template class for displaying OpenCms workplace admin project resent.
40   * <P>
41   * 
42   * @author Andreas Schouten
43   * @version $Revision: 1.2 $ $Date: 2005/05/31 15:51:19 $
44   * @see com.opencms.workplace.CmsXmlWpTemplateFile
45   * 
46   * @deprecated Will not be supported past the OpenCms 6 release.
47   */
48  
49  public class CmsAdminProjectLockchange extends CmsWorkplaceDefault {
50      
51      /**
52       * Gets the content of a defined section in a given template file and its subtemplates
53       * with the given parameters. 
54       * 
55       * @see #getContent(CmsObject, String, String, Hashtable, String)
56       * @param cms CmsObject Object for accessing system resources.
57       * @param templateFile Filename of the template file.
58       * @param elementName Element name of this template in our parent template.
59       * @param parameters Hashtable with all template class parameters.
60       * @param templateSelector template section that should be processed.
61       */
62      
63      public byte[] getContent(CmsObject cms, String   templateFile, String   elementName, 
64              Hashtable   parameters, String   templateSelector) throws CmsException {
65          if(CmsLog.getLog(this).isDebugEnabled() && C_DEBUG) {
66              CmsLog.getLog(this).debug("Getting content of element " + ((elementName==null)?"<root>":elementName));
67              CmsLog.getLog(this).debug("Template file is: " + templateFile);
68              CmsLog.getLog(this).debug("Selected template section is: " + ((templateSelector==null)?"<default>":templateSelector));
69          }
70          CmsXmlWpTemplateFile xmlTemplateDocument = (CmsXmlWpTemplateFile)getOwnTemplateFile(cms, 
71                  templateFile, elementName, parameters, templateSelector);
72          int projectId = Integer.parseInt((String  )parameters.get("projectid"));
73          CmsProject project = cms.readProject(projectId);
74          xmlTemplateDocument.setData("projectid", projectId + "");
75          xmlTemplateDocument.setData("projectname", project.getName());
76          if(parameters.get("ok") != null) {
77              
78              // change the lock of the project
79              try {
80                  
81                  // unlock all resources in this project
82                  cms.unlockProject(projectId);
83                  
84                  // unlock project was successfull                
85                  // redirect to the project overview...
86                  templateSelector = "done";
87              }
88              catch(CmsException exc) {
89                  
90                  // error while lockchange
91                  if(CmsLog.getLog(this).isWarnEnabled() ) {
92                      CmsLog.getLog(this).warn("Error in admin project lock change", exc);
93                  }
94                  
95                  // get errorpage:
96                  xmlTemplateDocument.setData("details", CmsException.getStackTraceAsString(exc));
97                  templateSelector = "error";
98              }
99          }
100         
101         // Now load the template file and start the processing
102         return startProcessing(cms, xmlTemplateDocument, elementName, parameters, 
103                 templateSelector);
104     }
105     
106     /**
107      * Indicates if the results of this class are cacheable.
108      * 
109      * @param cms CmsObject Object for accessing system resources
110      * @param templateFile Filename of the template file 
111      * @param elementName Element name of this template in our parent template.
112      * @param parameters Hashtable with all template class parameters.
113      * @param templateSelector template section that should be processed.
114      * @return <EM>true</EM> if cacheable, <EM>false</EM> otherwise.
115      */
116     
117     public boolean isCacheable(CmsObject cms, String   templateFile, String   elementName, 
118             Hashtable   parameters, String   templateSelector) {
119         return false;
120     }
121 }
122
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags