01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * // Copyright (c) 1998, 2007, Oracle. All rights reserved.
05: *
06: *
07: * The contents of this file are subject to the terms of either the GNU
08: * General Public License Version 2 only ("GPL") or the Common Development
09: * and Distribution License("CDDL") (collectively, the "License"). You
10: * may not use this file except in compliance with the License. You can obtain
11: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
12: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
13: * language governing permissions and limitations under the License.
14: *
15: * When distributing the software, include this License Header Notice in each
16: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
17: * Sun designates this particular file as subject to the "Classpath" exception
18: * as provided by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the License
20: * Header, with the fields enclosed by brackets [] replaced by your own
21: * identifying information: "Portions Copyrighted [year]
22: * [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * If you wish your version of this file to be governed by only the CDDL or
27: * only the GPL Version 2, indicate your decision by adding "[Contributor]
28: * elects to include this software in this distribution under the [CDDL or GPL
29: * Version 2] license." If you don't indicate a single choice of license, a
30: * recipient has the option to distribute your version of this file under
31: * either the CDDL, the GPL Version 2 or to extend the choice of license to
32: * its licensees as provided above. However, if you add GPL Version 2 code
33: * and therefore, elected the GPL Version 2 license, then the option applies
34: * only if the new code is made subject to such option by the copyright
35: * holder.
36: */
37: package oracle.toplink.essentials.descriptors.invalidation;
38:
39: import oracle.toplink.essentials.internal.identitymaps.CacheKey;
40: import oracle.toplink.essentials.descriptors.invalidation.CacheInvalidationPolicy;
41:
42: /**
43: * PUBLIC:
44: * A cache invalidation policy in which no objects will expire. The only way for objects
45: * to become invalid in the cache is for them to be explicitly set to invalid through
46: * method calls on the IdentityMapAccessor. This is the default cache invalidation policy.
47: * @see CacheInvalidationPolicy
48: * @see oracle.toplink.essentials.sessions.IdentityMapAccessor
49: */
50: public class NoExpiryCacheInvalidationPolicy extends
51: CacheInvalidationPolicy {
52:
53: /**
54: * INTERNAL:
55: * Since this policy implements no expiry, this will always return NO_EXPIRY
56: */
57: public long getExpiryTimeInMillis(CacheKey key) {
58: return NO_EXPIRY;
59: }
60:
61: /**
62: * INTERNAL:
63: * Return the remaining life of this object
64: * Override the default implementation.
65: */
66: public long getRemainingValidTime(CacheKey key) {
67: return NO_EXPIRY;
68: }
69:
70: /**
71: * INTERNAL:
72: * This will return true if the object is set to be invalid, false otherwise.
73: */
74: public boolean isInvalidated(CacheKey key, long currentTimeMillis) {
75: return key.getInvalidationState() == CacheKey.CACHE_KEY_INVALID;
76: }
77: }
|