View Javadoc

1   /*
2    * Copyright 2008 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 java.io.Serializable;
20  
21  import org.joda.time.DateTime;
22  import org.joda.time.chrono.ISOChronology;
23  
24  /** Base implementation for {@link ExpiringObject}. */
25  public abstract class AbstractExpiringObject implements ExpiringObject, Serializable {
26  
27      /** Moment of expiration in UTC. */
28      private long expiration;
29  
30      /**
31       * Constructor.
32       * 
33       * @param expirationTime time this object should expire
34       */
35      public AbstractExpiringObject(DateTime expirationTime) {
36          expiration = expirationTime.toDateTime(ISOChronology.getInstanceUTC()).getMillis();
37      }
38  
39      /** {@inheritDoc} */
40      public DateTime getExpirationTime() {
41          return new DateTime(expiration, ISOChronology.getInstanceUTC());
42      }
43  
44      /** {@inheritDoc} */
45      public boolean isExpired() {
46          return getExpirationTime().isBeforeNow();
47      }
48  
49      /** {@inheritDoc} */
50      public void onExpire() {
51          // no-op, implementations should override if they need to do something
52      }
53  }