View Javadoc
1   /*
2    * Licensed to The Apereo Foundation under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional
4    * information regarding copyright ownership.
5    *
6    *
7    * The Apereo Foundation licenses this file to you under the Educational
8    * Community License, Version 2.0 (the "License"); you may not use this file
9    * except in compliance with the License. You may obtain a copy of the License
10   * at:
11   *
12   *   http://opensource.org/licenses/ecl2.txt
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
17   * License for the specific language governing permissions and limitations under
18   * the License.
19   *
20   */
21  
22  package org.opencastproject.security.jwt;
23  
24  import com.auth0.jwt.interfaces.DecodedJWT;
25  
26  import java.util.Date;
27  
28  /**
29   * Class used for caching JWTs.
30   */
31  public class CachedJWT {
32  
33    /** JWT's signature. */
34    private final String signature;
35  
36    /** JWT's 'exp' claim. */
37    private final Date expiresAt;
38  
39    /** Username extracted from the JWT. */
40    private final String username;
41  
42    /**
43     * Creates a cached JWT form a decoded JWT and a username.
44     *
45     * @param jwt The decoded JWT.
46     * @param username The username extracted from the JWT.
47     */
48    public CachedJWT(DecodedJWT jwt, String username) {
49      this.signature = jwt.getSignature();
50      this.expiresAt = jwt.getExpiresAt();
51      this.username = username;
52    }
53  
54    /**
55     * Returns <code>true</code> if the cached JWT expired, false otherwise.
56     *
57     * @return Boolean indicating whether the cached JWT has expired.
58     */
59    public boolean hasExpired() {
60      return this.expiresAt != null && !this.expiresAt.after(new Date());
61    }
62  
63    /**
64     * Getter for the signature.
65     *
66     * @return The signature.
67     */
68    public String getSignature() {
69      return signature;
70    }
71  
72    /**
73     * Getter for the expiry date.
74     *
75     * @return The expiry date.
76     */
77    public Date getExpiresAt() {
78      return expiresAt;
79    }
80  
81    /**
82     * Getter for the username.
83     *
84     * @return The username.
85     */
86    public String getUsername() {
87      return username;
88    }
89  
90  }