1 /*
2 * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.opensaml.saml2.common;
18
19 import javax.xml.namespace.QName;
20
21 import org.opensaml.common.SAMLObject;
22 import org.opensaml.common.xml.SAMLConstants;
23
24 /**
25 * A functional interface for SAMLElements that provide cache duration information.
26 *
27 */
28 public interface CacheableSAMLObject extends SAMLObject{
29
30 /** "cacheDuration" attribute name */
31 public final static String CACHE_DURATION_ATTRIB_NAME = "cacheDuration";
32
33 /** "cacheDuration" attribute's QName */
34 public final static QName CACHE_DURATION_ATTRIB_QNAME = new QName(SAMLConstants.SAML20MD_NS, CACHE_DURATION_ATTRIB_NAME, SAMLConstants.SAML20MD_PREFIX);
35
36 /**
37 * Gets the maximum time, in milliseconds, that this descriptor should be cached.
38 *
39 * @return the maximum time that this descriptor should be cached
40 */
41 public Long getCacheDuration();
42
43 /**
44 * Sets the maximum time, in milliseconds, that this descriptor should be cached.
45 *
46 * @param duration the maximum time that this descriptor should be cached
47 */
48 public void setCacheDuration(Long duration);
49
50 }