1 /*
2 * $Header: /usr/local/cvsroot/dev/madcache/src/com/macvu/tiles/xmlDefinition/CacheDefinitionFactory.java,v 1.2 2004/04/11 03:43:25 macvu Exp $
3 * $Revision: 1.2 $
4 * $Date: 2004/04/11 03:43:25 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Struts", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 */
61
62 package com.macvu.tiles.xmlDefinition;
63
64 import com.macvu.tiles.CacheComponentDefinition;
65 import org.apache.struts.tiles.ComponentDefinition;
66 import org.apache.struts.tiles.DefinitionsFactoryException;
67 import org.apache.struts.tiles.NoSuchDefinitionException;
68
69 import javax.servlet.ServletContext;
70 import javax.servlet.ServletRequest;
71 import java.io.Serializable;
72 import java.util.HashMap;
73 import java.util.Iterator;
74 import java.util.Map;
75
76 public class CacheDefinitionFactory implements Serializable {
77 /***
78 * Underlying map containing all definitions.
79 */
80 protected Map definitions;
81
82 /***
83 * Get a definition by its name.
84 *
85 * @param name Name of the definition.
86 * @param request Servlet request.
87 * @param servletContext Servlet context.
88 * @throws org.apache.struts.tiles.DefinitionsFactoryException
89 * An error occur while getting
90 * definition.
91 * @throws NoSuchDefinitionException No definition found for specified name
92 * Implementation can throw more accurate exception as a subclass of this
93 * exception.
94 */
95 public ComponentDefinition getDefinition(String name, ServletRequest request, ServletContext servletContext)
96 throws NoSuchDefinitionException, DefinitionsFactoryException {
97 return (ComponentDefinition) definitions.get(name);
98 }
99
100 /***
101 * Put definition in set.
102 *
103 * @param definition Definition to put.
104 */
105 public void putDefinition(ComponentDefinition definition) {
106 definitions.put(definition.getName(), definition);
107 }
108
109 public CacheDefinitionFactory(XmlCacheDefinitionSet xmlCacheDefinitionSet) throws NoSuchDefinitionException {
110 definitions = new HashMap();
111
112 // First, resolve inheritance
113 xmlCacheDefinitionSet.resolveInheritances();
114
115 // Walk thru xml set and copy each definitions.
116 Iterator i = xmlCacheDefinitionSet.getDefinitions().values().iterator();
117 while (i.hasNext()) {
118 XmlCacheDefinition xmlCacheDefinition = (XmlCacheDefinition) i.next();
119 putDefinition(new CacheComponentDefinition(xmlCacheDefinition));
120 } // end loop
121
122 }
123
124 /***
125 * Return String representation.
126 *
127 * @return String representation.
128 */
129 public String toString() {
130 return definitions.toString();
131 }
132
133 }