KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > file > types > CmsResourceTypePlain


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/file/types/CmsResourceTypePlain.java,v $
3  * Date : $Date: 2006/03/27 14:52:48 $
4  * Version: $Revision: 1.13 $
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.file.types;
33
34 import org.opencms.configuration.CmsConfigurationException;
35 import org.opencms.loader.CmsDumpLoader;
36 import org.opencms.main.OpenCms;
37
38 /**
39  * Resource type descriptor for the type "plain".<p>
40  *
41  * @author Alexander Kandzior
42  *
43  * @version $Revision: 1.13 $
44  *
45  * @since 6.0.0
46  */
47 public class CmsResourceTypePlain extends A_CmsResourceType {
48
49     /** The type id of this resource type. */
50     private static final int RESOURCE_TYPE_ID = 1;
51
52     /** The name of this resource type. */
53     private static final String JavaDoc RESOURCE_TYPE_NAME = "plain";
54
55     /** Indicates that the static configuration of the resource type has been frozen. */
56     private static boolean m_staticFrozen;
57
58     /** The static type id of this resource type. */
59     private static int m_staticTypeId;
60
61     /**
62      * Default constructor, used to initialize member variables.<p>
63      */
64     public CmsResourceTypePlain() {
65
66         super();
67         m_typeId = RESOURCE_TYPE_ID;
68         m_typeName = RESOURCE_TYPE_NAME;
69     }
70
71     /**
72      * Returns the static type id of this (default) resource type.<p>
73      *
74      * @return the static type id of this (default) resource type
75      */
76     public static int getStaticTypeId() {
77
78         return m_staticTypeId;
79     }
80
81     /**
82      * Returns the static type name of this (default) resource type.<p>
83      *
84      * @return the static type name of this (default) resource type
85      */
86     public static String JavaDoc getStaticTypeName() {
87
88         return RESOURCE_TYPE_NAME;
89     }
90
91     /**
92      * A plain resource might appear as a sub-element in a JSP,
93      * therefore it needs cache properties.<p>
94      *
95      * @see org.opencms.file.types.I_CmsResourceType#getCachePropertyDefault()
96      */
97     public String JavaDoc getCachePropertyDefault() {
98
99         return "always;";
100     }
101
102     /**
103      * @see org.opencms.file.types.I_CmsResourceType#getLoaderId()
104      */
105     public int getLoaderId() {
106
107         return CmsDumpLoader.RESOURCE_LOADER_ID;
108     }
109
110     /**
111      * @see org.opencms.file.types.A_CmsResourceType#initConfiguration(java.lang.String, java.lang.String, String)
112      */
113     public void initConfiguration(String JavaDoc name, String JavaDoc id, String JavaDoc className) throws CmsConfigurationException {
114
115         if ((OpenCms.getRunLevel() > OpenCms.RUNLEVEL_2_INITIALIZING) && m_staticFrozen) {
116             // configuration already frozen
117 throw new CmsConfigurationException(Messages.get().container(
118                 Messages.ERR_CONFIG_FROZEN_3,
119                 this.getClass().getName(),
120                 getStaticTypeName(),
121                 new Integer JavaDoc(getStaticTypeId())));
122         }
123
124         if (!RESOURCE_TYPE_NAME.equals(name)) {
125             // default resource type MUST have default name
126 throw new CmsConfigurationException(Messages.get().container(
127                 Messages.ERR_INVALID_RESTYPE_CONFIG_NAME_3,
128                 this.getClass().getName(),
129                 RESOURCE_TYPE_NAME,
130                 name));
131         }
132
133         // freeze the configuration
134 m_staticFrozen = true;
135
136         super.initConfiguration(RESOURCE_TYPE_NAME, id, className);
137         // set static members with values from the configuration
138 m_staticTypeId = m_typeId;
139     }
140 }
Popular Tags