TTLCacheEntryValidity.java

/*
 * =============================================================================
 * 
 *   Copyright (c) 2011-2016, The THYMELEAF team (http://www.thymeleaf.org)
 * 
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 * 
 * =============================================================================
 */
package org.thymeleaf.cache;

/**
 * <p>
 *   Simple implementation of {@link ICacheEntryValidity}
 *   that uses a TTL (time-to-live) expressed in milliseconds to
 *   compute the validity of template cache entries.
 * </p>
 * 
 * @author Daniel Fernández
 * 
 * @since 1.0
 *
 */
public class TTLCacheEntryValidity
        implements ICacheEntryValidity {
    
    private final long cacheTTLMs;
    private final long creationTimeInMillis;

    
    /**
     * <p>
     *   Creates a new instance of this validity implementation. 
     * </p>
     * 
     * @param cacheTTLMs the TTL to be applied to the template resolution.
     */
    public TTLCacheEntryValidity(final long cacheTTLMs) {
        super();
        this.cacheTTLMs = cacheTTLMs;
        this.creationTimeInMillis = System.currentTimeMillis();
    }
    
    
    /**
     * <p>
     *   Returns the TTL in milliseconds to be applied to template
     *   validity.
     * </p>
     * 
     * @return the TTL in milliseconds
     */
    public long getCacheTTLMs() {
        return this.cacheTTLMs;
    }
    

    /**
     * <p>
     *   Returns true. Templates are always considered cacheable using this
     *   validity implementation.
     * </p>
     * 
     * @return true
     */
    public boolean isCacheable() {
        return true;
    }
    

    /**
     * <p>
     *   Returns whether the template resolution can still be considered valid. This
     *   is done by computing the difference in milliseconds between the moment when
     *   this object was created and the moment this method is called, and checking
     *   it is less than the established TTL (time-to-live).
     * </p>
     * 
     * @return whether the (cached) template resolution can still be considered valid.  
     */
    public boolean isCacheStillValid() {
        final long currentTimeInMillis = System.currentTimeMillis();
        return (currentTimeInMillis < this.creationTimeInMillis + this.cacheTTLMs);
    }
    
}