View Javadoc

1   /* 
2    * Copyright 2002-2004 The Apache Software Foundation
3    * Licensed  under the  Apache License,  Version 2.0  (the "License");
4    * you may not use  this file  except in  compliance with the License.
5    * You may obtain a copy of the License at 
6    * 
7    *   http://www.apache.org/licenses/LICENSE-2.0
8    * 
9    * Unless required by applicable law or agreed to in writing, software
10   * distributed  under the  License is distributed on an "AS IS" BASIS,
11   * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
12   * implied.
13   * 
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.struts.flow.core.source.impl.validity;
18  
19  import org.apache.struts.flow.core.source.SourceValidity;
20  
21  /***
22   * A validation object that holds an expiration date.
23   * When the defined time/date has arrived, this validity object is 
24   * not valid any more.
25   *
26   * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
27   * @version CVS $Revision: 1.4 $ $Date: 2004/02/28 11:47:17 $
28   */
29  public final class ExpiresValidity
30      implements SourceValidity
31  {
32      private long expires;
33  
34      /***
35       * Constructor
36       * @param expires The delta from now when this validity object gets invalid.
37       */
38      public ExpiresValidity( long expires ) 
39      {
40          this.expires = System.currentTimeMillis() + expires;
41      }
42  
43      /***
44       * Checks if the expires date is already reached.
45       * 
46       * @see org.apache.struts.flow.core.source.SourceValidity#isValid()
47       */
48      public int isValid() 
49      {
50          final long currentTime = System.currentTimeMillis();
51          return (currentTime <= this.expires ? SourceValidity.VALID : SourceValidity.INVALID);
52      }
53  
54      /***
55       * This method is never invoked as {@link #isValid()} can always perform
56       * the complete check.
57       * 
58       * @see org.apache.struts.flow.core.source.SourceValidity#isValid(SourceValidity)
59       */
60      public int isValid( SourceValidity newValidity ) 
61      {
62          return SourceValidity.INVALID;
63      }
64  
65      /***
66       * 
67       * @see java.lang.Object#toString()
68       */
69      public String toString() 
70      {
71          return "ExpiresValidity: " + expires;
72      }
73  }