KickJava   Java API By Example, From Geeks To Geeks.

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


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