1 /*
2 * ModeShape (http://www.modeshape.org)
3 * See the COPYRIGHT.txt file distributed with this work for information
4 * regarding copyright ownership. Some portions may be licensed
5 * to Red Hat, Inc. under one or more contributor license agreements.
6 * See the AUTHORS.txt file in the distribution for a full listing of
7 * individual contributors.
8 *
9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10 * is licensed to you under the terms of the GNU Lesser General Public License as
11 * published by the Free Software Foundation; either version 2.1 of
12 * the License, or (at your option) any later version.
13 *
14 * ModeShape is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this software; if not, write to the Free
21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23 */
24 package org.modeshape.graph.request;
25
26 import net.jcip.annotations.ThreadSafe;
27 import org.modeshape.graph.cache.CachePolicy;
28 import org.modeshape.graph.cache.Cacheable;
29 import org.modeshape.graph.property.DateTime;
30
31 /**
32 * A request that contains results that may be cached.
33 */
34 @ThreadSafe
35 public abstract class CacheableRequest extends Request implements Cacheable {
36
37 private static final long serialVersionUID = 1L;
38
39 private CachePolicy policy;
40 private DateTime timeLoaded;
41
42 /**
43 * {@inheritDoc}
44 *
45 * @see org.modeshape.graph.cache.Cacheable#getCachePolicy()
46 */
47 public CachePolicy getCachePolicy() {
48 return policy;
49 }
50
51 /**
52 * {@inheritDoc}
53 *
54 * @see org.modeshape.graph.cache.Cacheable#getTimeLoaded()
55 */
56 public DateTime getTimeLoaded() {
57 return timeLoaded;
58 }
59
60 /**
61 * {@inheritDoc}
62 *
63 * @throws IllegalStateException if the request is frozen
64 * @see org.modeshape.graph.cache.Cacheable#setCachePolicy(org.modeshape.graph.cache.CachePolicy)
65 */
66 public void setCachePolicy( CachePolicy cachePolicy ) {
67 checkNotFrozen();
68 policy = cachePolicy;
69 }
70
71 /**
72 * @param timeLoaded Sets timeLoaded to the specified value.
73 * @throws IllegalStateException if the request is frozen
74 */
75 public void setTimeLoaded( DateTime timeLoaded ) {
76 checkNotFrozen();
77 this.timeLoaded = timeLoaded;
78 }
79 }