88ac7e7c5ebf09f75a79425aac66515edb7700c4
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / common / provider / BaseCache.java
1 /*
2  * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package edu.internet2.middleware.shibboleth.common.provider;
18
19 import java.util.Date;
20
21 import edu.internet2.middleware.shibboleth.common.Cache;
22
23 /**
24  * Functionality common to all implementations of <code>Cache</code>.
25  * 
26  * @author Walter Hoehn
27  */
28 public abstract class BaseCache implements Cache {
29
30         private String name;
31         private CacheType cacheType;
32
33         protected BaseCache(String name, CacheType type) {
34
35                 if (name == null || type == null) { throw new IllegalArgumentException(
36                                 "Name and type are required for construction of BaseCache."); }
37
38                 this.name = name;
39                 this.cacheType = type;
40         }
41
42         public CacheType getCacheType() {
43
44                 return cacheType;
45         }
46
47         public String getName() {
48
49                 return name;
50         }
51
52         protected class CacheEntry {
53
54                 protected Date expiration;
55                 protected String value;
56
57                 protected CacheEntry(String value, long duration) {
58
59                         this.value = value;
60                         expiration = new Date(System.currentTimeMillis() + (duration * 1000));
61                 }
62
63                 protected CacheEntry(String value, Date expireAt) {
64
65                         this.value = value;
66                         this.expiration = expireAt;
67                 }
68
69                 protected boolean isExpired() {
70
71                         return (new Date().after(expiration));
72                 }
73         }
74 }