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.nimbusds.jwt.SignedJWT;
25  
26  import java.text.ParseException;
27  import java.util.Date;
28  
29  /**
30   * Class used for caching JWTs.
31   */
32  public class CachedJWT {
33  
34    /** JWT's signature. */
35    private final String signature;
36  
37    /** JWT's 'exp' claim. */
38    private final Date expiresAt;
39  
40    /** Username extracted from the JWT. */
41    private final String username;
42  
43    /**
44     * Creates a cached JWT form a decoded JWT and a username.
45     *
46     * @param jwt The decoded JWT.
47     * @param username The username extracted from the JWT.
48     */
49    public CachedJWT(SignedJWT jwt, String username) throws ParseException {
50      this.signature = jwt.getSignature().toString();
51      this.expiresAt = jwt.getJWTClaimsSet().getExpirationTime();
52      this.username = username;
53    }
54  
55    /**
56     * Returns <code>true</code> if the cached JWT expired, false otherwise.
57     *
58     * @return Boolean indicating whether the cached JWT has expired.
59     */
60    public boolean hasExpired() {
61      return this.expiresAt != null && !this.expiresAt.after(new Date());
62    }
63  
64    /**
65     * Getter for the signature.
66     *
67     * @return The signature.
68     */
69    public String getSignature() {
70      return signature;
71    }
72  
73    /**
74     * Getter for the expiry date.
75     *
76     * @return The expiry date.
77     */
78    public Date getExpiresAt() {
79      return expiresAt;
80    }
81  
82    /**
83     * Getter for the username.
84     *
85     * @return The username.
86     */
87    public String getUsername() {
88      return username;
89    }
90  
91  }