View Javadoc

1   /**
2    * This file Copyright (c) 2010-2014 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.filters;
35  
36  import info.magnolia.cms.util.DispatcherType;
37  
38  import java.util.Collections;
39  import java.util.List;
40  import java.util.concurrent.CopyOnWriteArrayList;
41  
42  
43  /**
44   * Similar to the dispatch mapping in the web.xml. Defines if a filter is executed on forwards,
45   * includes, requests and errors.
46   * @version $Id$
47   *
48   */
49  public class DispatchRules {
50  
51      private final SimpleConcurrentEnumMap<DispatcherType, DispatchRule> dispatchRules = new SimpleConcurrentEnumMap<DispatcherType, DispatchRule>(
52          DispatcherType.class);
53  
54      public DispatchRules() {
55          dispatchRules.put(DispatcherType.REQUEST, new DispatchRule(true, true));
56          dispatchRules.put(DispatcherType.FORWARD, new DispatchRule(true, false));
57          dispatchRules.put(DispatcherType.INCLUDE, new DispatchRule(false, false));
58          dispatchRules.put(DispatcherType.ERROR, new DispatchRule(true, false));
59      }
60  
61      public void setRequest(DispatchRule rule) {
62          this.dispatchRules.put(DispatcherType.REQUEST, rule);
63      }
64  
65      public void setForward(DispatchRule rule) {
66          this.dispatchRules.put(DispatcherType.FORWARD, rule);
67      }
68  
69      public void setInclude(DispatchRule rule) {
70          this.dispatchRules.put(DispatcherType.INCLUDE, rule);
71      }
72  
73      public void setError(DispatchRule rule) {
74          this.dispatchRules.put(DispatcherType.ERROR, rule);
75      }
76  
77      public DispatchRule getDispatchRule(DispatcherType dispatcherType) {
78          return dispatchRules.get(dispatcherType);
79      }
80  
81      /**
82       * Simple thread-safe key-value-store for use with an enum as key. Not a complete java.util.Map
83       * implementation. Optimized for read access. Faster read access than both ConcurrentHashMap and
84       * EnumMap wrapped in a synchronizing wrapper.
85       */
86      private static class SimpleConcurrentEnumMap<K extends Enum, V> {
87  
88          private final List<V> values = new CopyOnWriteArrayList<V>();
89  
90          private SimpleConcurrentEnumMap(Class<K> keyType) {
91              this(keyType, null);
92          }
93  
94          public SimpleConcurrentEnumMap(Class<K> keyType, V defaultValue) {
95              // Initial fill of the list to prevent IndexOutOfBoundsException later on
96              values.addAll(Collections.nCopies(keyType.getEnumConstants().length, defaultValue));
97          }
98  
99          public void put(K key, V value) {
100             values.set(key.ordinal(), value);
101         }
102 
103         public V get(K key) {
104             return values.get(key.ordinal());
105         }
106     }
107 
108 }