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