001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006     * See the AUTHORS.txt file in the distribution for a full listing of 
007     * individual contributors. 
008     *
009     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     *
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.graph.request;
025    
026    import net.jcip.annotations.ThreadSafe;
027    import org.jboss.dna.graph.cache.CachePolicy;
028    import org.jboss.dna.graph.cache.Cacheable;
029    import org.jboss.dna.graph.property.DateTime;
030    
031    /**
032     * A request that contains results that may be cached.
033     * 
034     * @author Randall Hauch
035     */
036    @ThreadSafe
037    public abstract class CacheableRequest extends Request implements Cacheable {
038    
039        private static final long serialVersionUID = 1L;
040    
041        private CachePolicy policy;
042        private DateTime timeLoaded;
043    
044        /**
045         * {@inheritDoc}
046         * 
047         * @see org.jboss.dna.graph.cache.Cacheable#getCachePolicy()
048         */
049        public CachePolicy getCachePolicy() {
050            return policy;
051        }
052    
053        /**
054         * {@inheritDoc}
055         * 
056         * @see org.jboss.dna.graph.cache.Cacheable#getTimeLoaded()
057         */
058        public DateTime getTimeLoaded() {
059            return timeLoaded;
060        }
061    
062        /**
063         * {@inheritDoc}
064         * 
065         * @see org.jboss.dna.graph.cache.Cacheable#setCachePolicy(org.jboss.dna.graph.cache.CachePolicy)
066         */
067        public void setCachePolicy( CachePolicy cachePolicy ) {
068            policy = cachePolicy;
069        }
070    
071        /**
072         * @param timeLoaded Sets timeLoaded to the specified value.
073         */
074        public void setTimeLoaded( DateTime timeLoaded ) {
075            this.timeLoaded = timeLoaded;
076        }
077    }