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 /** Interface for handling JWT login. */
25 public interface JWTLoginHandler {
26
27 /** String constant identifying the login mechanism. */
28 String MECH_JWT = "jwt";
29
30 /**
31 * Takes a JWT string, decodes it, validates it and returns the username encoded in the JWT.
32 *
33 * @param token The JWT string.
34 * @return The username or <code>null</code> if the validation failed.
35 */
36 String handleToken(String token);
37
38 }