001: /*
002: License $Id: URIMapper.java,v 1.8 2004/04/16 01:30:04 hendriks73 Exp $
003:
004: Copyright (c) 2001-2005 tagtraum industries.
005:
006: LGPL
007: ====
008:
009: jo! is free software; you can redistribute it and/or
010: modify it under the terms of the GNU Lesser General Public
011: License as published by the Free Software Foundation; either
012: version 2.1 of the License, or (at your option) any later version.
013:
014: jo! is distributed in the hope that it will be useful,
015: but WITHOUT ANY WARRANTY; without even the implied warranty of
016: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017: Lesser General Public License for more details.
018:
019: You should have received a copy of the GNU Lesser General Public
020: License along with this library; if not, write to the Free Software
021: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
022:
023: For LGPL see <http://www.fsf.org/copyleft/lesser.txt>
024:
025:
026: Sun license
027: ===========
028:
029: This release contains software by Sun Microsystems. Therefore
030: the following conditions have to be met, too. They apply to the
031: files
032:
033: - lib/mail.jar
034: - lib/activation.jar
035: - lib/jsse.jar
036: - lib/jcert.jar
037: - lib/jaxp.jar
038: - lib/crimson.jar
039: - lib/servlet.jar
040: - lib/jnet.jar
041: - lib/jaas.jar
042: - lib/jaasmod.jar
043:
044: contained in this release.
045:
046: a. Licensee may not modify the Java Platform
047: Interface (JPI, identified as classes contained within the javax
048: package or any subpackages of the javax package), by creating additional
049: classes within the JPI or otherwise causing the addition to or modification
050: of the classes in the JPI. In the event that Licensee creates any
051: Java-related API and distribute such API to others for applet or
052: application development, you must promptly publish broadly, an accurate
053: specification for such API for free use by all developers of Java-based
054: software.
055:
056: b. Software is confidential copyrighted information of Sun and
057: title to all copies is retained by Sun and/or its licensors. Licensee
058: shall not modify, decompile, disassemble, decrypt, extract, or otherwise
059: reverse engineer Software. Software may not be leased, assigned, or
060: sublicensed, in whole or in part. Software is not designed or intended
061: for use in on-line control of aircraft, air traffic, aircraft navigation
062: or aircraft communications; or in the design, construction, operation or
063: maintenance of any nuclear facility. Licensee warrants that it will not
064: use or redistribute the Software for such purposes.
065:
066: c. Software is provided "AS IS," without a warranty
067: of any kind. ALL EXPRESS OR IMPLIED REPRESENTATIONS AND WARRANTIES,
068: INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
069: PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED.
070:
071: d. This License is effective until terminated. Licensee may
072: terminate this License at any time by destroying all copies of Software.
073: This License will terminate immediately without notice from Sun if Licensee
074: fails to comply with any provision of this License. Upon such termination,
075: Licensee must destroy all copies of Software.
076:
077: e. Software, including technical data, is subject to U.S.
078: export control laws, including the U.S. Export Administration Act and its
079: associated regulations, and may be subject to export or import regulations
080: in other countries. Licensee agrees to comply strictly with all such
081: regulations and acknowledges that it has the responsibility to obtain
082: licenses to export, re-export, or import Software. Software may not be
083: downloaded, or otherwise exported or re-exported (i) into, or to a national
084: or resident of, Cuba, Iraq, Iran, North Korea, Libya, Sudan, Syria or any
085: country to which the U.S. has embargoed goods; or (ii) to anyone on the
086: U.S. Treasury Department's list of Specially Designated Nations or the U.S.
087: Commerce Department's Table of Denial Orders.
088:
089:
090: Feedback
091: ========
092:
093: We encourage your feedback and suggestions and want to use your feedback to
094: improve the Software. Send all such feedback to:
095: <feedback@tagtraum.com>
096:
097: For more information on tagtraum industries and jo!
098: please see <http://www.tagtraum.com/>.
099:
100:
101: */
102: package com.tagtraum.jo.util;
103:
104: import EDU.oswego.cs.dl.util.concurrent.ConcurrentReaderHashMap;
105:
106: import java.util.Iterator;
107: import java.util.Map;
108: import java.util.TreeMap;
109: import java.util.Collections;
110:
111: /**
112: * Mapps a request or URI to a {@link com.tagtraum.jo.I_JoServletModel} according to the
113: * url pattern rules defined in the spec.
114: *
115: * @author <a href="mailto:hs@tagtraum.com">Hendrik Schreiber</a>
116: * @version 1.1beta1 $Id: URIMapper.java,v 1.8 2004/04/16 01:30:04 hendriks73 Exp $
117: * @see com.tagtraum.jo.I_JoServletContextPeer
118: * @see URIMapperMatch
119: */
120: public class URIMapper {
121:
122: /**
123: * Source-Version
124: */
125: public static String vcid = "$Id: URIMapper.java,v 1.8 2004/04/16 01:30:04 hendriks73 Exp $";
126:
127: /**
128: * Map for patterns.
129: */
130: private Map patternMap;
131:
132: /**
133: * Map for exact rules.
134: */
135: private Map exactMatchRules;
136:
137: /**
138: * Map for prefix rules.
139: */
140: private Map prefixMatchRules;
141:
142: /**
143: * Map for suffix rules.
144: */
145: private Map suffixMatchRules;
146:
147: /**
148: * Model Lock
149: */
150: private Object defaultObject;
151:
152: /**
153: * Instantiates the used maps.
154: * synch is set to false.
155: */
156: public URIMapper() {
157: exactMatchRules = new ConcurrentReaderHashMap();
158: prefixMatchRules = new ConcurrentReaderHashMap();
159: suffixMatchRules = new ConcurrentReaderHashMap();
160: // patternMap is not really important as it is not used for the matching
161: patternMap = Collections.synchronizedSortedMap(new TreeMap());
162: }
163:
164: /**
165: * Sets the default object. If an object was set before
166: * it is returned.
167: *
168: * @return old default object if it exists
169: * @param object the default object
170: */
171: public Object setDefault(Object object) {
172: Object ret = defaultObject;
173: defaultObject = object;
174: patternMap.put("/", object);
175: return ret;
176: }
177:
178: /**
179: * Returns the default object.
180: *
181: * @return the default object
182: */
183: public Object getDefault() {
184: return defaultObject;
185: }
186:
187: /**
188: * Returns an iterator over all rules.
189: */
190: public Iterator iterator() {
191: return patternMap.keySet().iterator();
192: }
193:
194: /**
195: * Deletes all mappings.
196: */
197: public void clear() {
198: patternMap.clear();
199: // Prefix
200: prefixMatchRules.clear();
201: // Suffix
202: suffixMatchRules.clear();
203: // Exact
204: exactMatchRules.clear();
205: // Default
206: defaultObject = null;
207: }
208:
209: /**
210: * Removes all mappings for a particular object.
211: *
212: * @param object the object whose mappings you want to remove
213: */
214: public void removeObject(Object object) {
215: removeAllFromMap(object, patternMap);
216: // Prefix
217: removeAllFromMap(object, prefixMatchRules);
218: // Suffix
219: removeAllFromMap(object, suffixMatchRules);
220: // Exact
221: removeAllFromMap(object, exactMatchRules);
222: // Default
223: if (defaultObject.equals(object))
224: defaultObject = null;
225: }
226:
227: /**
228: * Removes all mappings from a map for a particular object.
229: *
230: * @param object the object whose mappings you want to remove
231: * @param map the map you want to remove the rules from.
232: */
233: private void removeAllFromMap(Object object, Map map) {
234: Iterator it = map.entrySet().iterator();
235: while (it.hasNext()) {
236: Map.Entry e = (Map.Entry) it.next();
237: if (e.getValue().equals(object)) {
238: it.remove();
239: }
240: }
241: }
242:
243: /**
244: * Removes a mapping.
245: *
246: * @param pattern
247: * @return the object whose pattern has been removed.
248: */
249: public Object remove(String pattern) {
250: if (pattern == null)
251: throw new NullPointerException(
252: "Cannot remove null-pattern.");
253: Object ret;
254: patternMap.remove(pattern);
255: if (pattern.endsWith("/*")) {
256: ret = prefixMatchRules.remove(pattern.substring(0, pattern
257: .length() - 2));
258: } else if (pattern.startsWith("*.")) {
259: ret = suffixMatchRules.remove(pattern.substring(2));
260: } else {
261: ret = exactMatchRules.remove(pattern);
262: }
263: return ret;
264: }
265:
266: /**
267: * Adds a mapping to this context.
268: *
269: * @param pattern
270: */
271: public void add(String pattern, Object object) {
272: if (pattern == null) {
273: throw new NullPointerException("Pattern cannot be 'null'.");
274: }
275: if (object == null) {
276: throw new NullPointerException("Object cannot be 'null'.");
277: }
278:
279: if (pattern.equals("/")) {
280: setDefault(object);
281: } else {
282: patternMap.put(pattern, object);
283: if (pattern.endsWith("/*")) {
284: if (prefixMatchRules.put(pattern.substring(0, pattern
285: .length() - 2), object) != null) {
286: throw new IllegalArgumentException(
287: "Tried to map two objects to one pattern: "
288: + pattern + ", Object: " + object);
289: }
290: } else if (pattern.startsWith("*.")) {
291: if (suffixMatchRules.put(pattern.substring(2), object) != null) {
292: throw new IllegalArgumentException(
293: "Tried to map two objects to one suffix pattern: "
294: + pattern + ", Object: " + object);
295: }
296: } else if (exactMatchRules.put(pattern, object) != null) {
297: throw new IllegalArgumentException(
298: "Tried to map two objects to one path pattern: "
299: + pattern + ", Object: " + object);
300: }
301: }
302: }
303:
304: /**
305: * Returns an Object for a rule.
306: */
307: public Object getObjectForRule(String rule) {
308: return patternMap.get(rule);
309: }
310:
311: /**
312: * Returns the number of rules.
313: */
314: public int rules() {
315: return patternMap.size();
316: }
317:
318: /**
319: * Takes a URI path and returns the appropriate {@link URIMapperMatch}
320: * for it.
321: *
322: * @return appropriate URIMapperMatch
323: */
324: public URIMapperMatch get(String theURI) {
325: // depending on how we added theURI has to be without the context prefix
326: String matchPath;
327: Object matchObject;
328:
329: // theURI has to be URLDecoded (rik)
330: matchPath = theURI;
331: // first node: Exact match!
332: matchObject = exactMatchRules.get(theURI);
333:
334: if (matchObject == null) {
335:
336: // second node: prefix match!
337: int idx;
338: String theURIPart = theURI;
339:
340: matchObject = prefixMatchRules.get(theURIPart);
341:
342: // step through it from the back
343: while (matchObject == null
344: && (idx = theURIPart.lastIndexOf('/')) != -1) {
345: theURIPart = theURIPart.substring(0, idx);
346: matchObject = prefixMatchRules.get(theURIPart);
347: matchPath = theURIPart;
348: }
349: }
350:
351: // third node: suffix match!
352: if (matchObject == null) {
353: matchPath = theURI;
354:
355: int idx = theURI.lastIndexOf('.');
356:
357: if (idx != -1 && theURI.length() > (idx + 1)) {
358: String theSuffix = theURI.substring(idx + 1);
359: matchObject = suffixMatchRules.get(theSuffix);
360: }
361: }
362: // fourth node: default match!
363: if (matchObject == null) {
364: matchObject = defaultObject;
365: matchPath = theURI;
366: }
367: return new URIMapperMatch(matchPath, matchObject);
368: }
369:
370: }
|