View Javadoc

1   /**
2    * This file Copyright (c) 2010-2011 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.module.cache;
35  
36  import java.io.Serializable;
37  import java.util.Map;
38  
39  import edu.emory.mathcs.backport.java.util.Collections;
40  
41  /**
42   * Default cache key implementation. Key is based on the URI, server name, parameters and request headers. Since the server name is likely to change from server to server, copying cached items around will most likely not help to avoid generating cache entries.
43   *
44   * @author had
45   * @version $Id:$
46   */
47  public class DefaultCacheKey implements Serializable {
48  
49      // Keep the svuid fixed to prevent deserialization errors. Keep in mind that when adding new properties they will be deserialized to null!
50      private static final long serialVersionUID = 2699497852929596651L;
51  
52      private String uri;
53      private String serverName;
54      private String locale;
55      private Map<String, String> params;
56      private Boolean isSecure;
57  
58      /**
59       * @deprecated since 4.4.6 use info.magnolia.module.cache.DefaultCacheKey.DefaultCacheKey(String, String, String, Map<String, String>, Boolean)
60       */
61      @Deprecated
62      public DefaultCacheKey(String uri, String serverName, String locale, Map<String, String> params) {
63          this.uri = uri;
64          this.serverName = serverName;
65          this.locale = locale;
66          this.params = params == null ? null : Collections.unmodifiableMap(params);
67          this.isSecure = false;
68      }
69      
70      public DefaultCacheKey(String uri, String serverName, String locale, Map<String, String> params, Boolean isSecure){
71          this.uri = uri;
72          this.serverName = serverName;
73          this.locale = locale;
74          this.params = params == null ? null : Collections.unmodifiableMap(params);
75          this.isSecure = isSecure;
76      }
77  
78      @Override
79      public int hashCode() {
80          return (uri == null ? 13 : uri.hashCode())
81              + (serverName == null ? 17 : serverName.hashCode())
82              + (locale == null ? 23 : locale.hashCode())
83              + (params == null ? 29 :  params.hashCode())
84              + (isSecure == null ? 31 : isSecure.hashCode());
85      }
86  
87      @Override
88      public boolean equals(Object obj) {
89          if (this == obj) {
90              return true;
91          }
92          if (obj == null || !(obj instanceof DefaultCacheKey)) {
93              return false;
94          }
95          DefaultCacheKey that = (DefaultCacheKey) obj;
96          return (this.uri == null) ? that.uri == null : this.uri.equals(that.uri)
97              && (this.serverName == null ? that.serverName == null : this.serverName.equals(that.serverName))
98              && (this.locale == null ? that.locale == null : this.locale.equals(that.locale))
99              && (this.params == null ? that.params == null : this.params.equals(that.params))
100             && (this.isSecure == null ? that.isSecure == null : this.isSecure.equals(that.isSecure));
101     }
102 
103     public String getUri() {
104         return this.uri;
105     }
106 
107     public String getDomain() {
108         return this.serverName;
109     }
110     
111     public String getLocale() {
112         return this.locale;
113     }
114     
115     public Map<String, String> getParams() {
116         return params;
117     }
118     
119     public Boolean getIsSecured(){
120         return this.isSecure;
121     }
122 
123     // generated toString() method
124     public String toString() {
125         return "DefaultCacheKey{" +
126                 "uri='" + uri + '\'' +
127                 ", serverName='" + serverName + '\'' +
128                 ", locale='" + locale + '\'' +
129                 ", params=" + params + '\'' +
130                 ", secure='" + isSecure + "'" +
131                 '}';
132     }
133 
134 }