KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jpublish > resource > AbstractResourceManager


1 /*--
2
3  Copyright (C) 2001-2003 Aetrion LLC.
4  All rights reserved.
5  
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions
8  are met:
9  
10  1. Redistributions of source code must retain the above copyright
11     notice, this list of conditions, and the following disclaimer.
12  
13  2. Redistributions in binary form must reproduce the above copyright
14     notice, this list of conditions, and the disclaimer that follows
15     these conditions in the documentation and/or other materials
16     provided with the distribution.
17
18  3. The name "JPublish" must not be used to endorse or promote products
19     derived from this software without prior written permission. For
20     written permission, please contact info@aetrion.com.
21  
22  4. Products derived from this software may not be called "JPublish", nor
23     may "JPublish" appear in their name, without prior written permission
24     from Aetrion LLC (info@aetrion.com).
25  
26  In addition, the authors of this software request (but do not require)
27  that you include in the end-user documentation provided with the
28  redistribution and/or in the software itself an acknowledgement equivalent
29  to the following:
30      "This product includes software developed by
31       Aetrion LLC (http://www.aetrion.com/)."
32
33  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
37  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
42  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43  POSSIBILITY OF SUCH DAMAGE.
44
45  For more information on JPublish, please see <http://www.jpublish.org/>.
46  
47  */
48
49 package org.jpublish.resource;
50
51 import com.anthonyeden.lib.config.Configuration;
52 import com.anthonyeden.lib.config.ConfigurationException;
53 import org.jpublish.ManagerBase;
54
55 /**
56  * The AbstractResourceManager base class can be used as a superclass for resource manager implementations. It provides
57  * convenience methods which are standard for all resource managers.
58  *
59  * @author Anthony Eden
60  */
61 public abstract class AbstractResourceManager extends ManagerBase
62         implements ResourceManager {
63
64     protected String JavaDoc name = null;
65     protected boolean writeAllowed = false;
66
67     /**
68      * Get the name of the resource manager. This name is used to expose the ResourceManager in the view renderer.
69      *
70      * @return The ResourceManager name
71      */
72     public String JavaDoc getName() {
73         return name;
74     }
75
76     /**
77      * Set the name of the resource manager.
78      *
79      * @param name The name
80      */
81     public void setName(String JavaDoc name) {
82         this.name = name;
83     }
84
85     /**
86      * Return true if writing is allowed.
87      *
88      * @return True if write is allowed
89      */
90     public boolean isWriteAllowed() {
91         return writeAllowed;
92     }
93
94     /**
95      * Set to true to allow writing.
96      *
97      * @param writeAllowed True to enable writing
98      */
99
100     public void setWriteAllowed(boolean writeAllowed) {
101         this.writeAllowed = writeAllowed;
102     }
103
104     /**
105      * Set to "true" to allow writing.
106      *
107      * @param writeAllowed Set to the String "true" to allow writing
108      */
109
110     public void setWriteAllowed(String JavaDoc writeAllowed) {
111         if (writeAllowed != null) {
112             setWriteAllowed("true".equals(writeAllowed));
113         }
114     }
115
116     /**
117      * Load the template manager configuration.
118      *
119      * @param configuration The Configuration object
120      * @throws ConfigurationException
121      */
122
123     public void loadConfiguration(Configuration configuration)
124             throws ConfigurationException {
125         super.loadConfiguration(configuration);
126         setName(configuration.getAttribute("name"));
127         setWriteAllowed(configuration.getChildValue("write-allowed"));
128     }
129
130 }
131
Popular Tags