View Javadoc

1   /*
2    * Copyright 2007 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.util.storage;
18  
19  import org.joda.time.DateTime;
20  
21  /**
22   * A simple interface for objects that may expire at a given time.
23   */
24  public interface ExpiringObject {
25  
26      /**
27       * Gets the time the object expires.
28       * 
29       * @return time the object expires
30       */
31      public DateTime getExpirationTime();
32  
33      /**
34       * Gets whether this object has expired.
35       * 
36       * @return true if the expiration time has passed, false if not
37       */
38      public boolean isExpired();
39  
40      /**
41       * A callback method invoked when this object is expiring. Note, this method may not be invoked at the exact instant
42       * of expiration but may, instead, be invoked the next time the object is read and noticed to have expired.
43       */
44      public void onExpire();
45  }