1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * See LICENSE.txt included in this distribution for the specific 9 * language governing permissions and limitations under the License. 10 * 11 * When distributing Covered Code, include this CDDL HEADER in each 12 * file and include the License file at LICENSE.txt. 13 * If applicable, add the following below this CDDL HEADER, with the 14 * fields enclosed by brackets "[]" replaced with your own identifying 15 * information: Portions Copyright [yyyy] [name of copyright owner] 16 * 17 * CDDL HEADER END 18 */ 19 20 /* 21 * Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved. 22 */ 23 package opengrok.auth.plugin.decoders; 24 25 import jakarta.servlet.http.HttpServletRequest; 26 import opengrok.auth.plugin.entity.User; 27 28 /** 29 * 30 * @author Krystof Tulinger 31 */ 32 public interface IUserDecoder { 33 34 /** 35 * Creates the User from the http request. 36 * 37 * Fills all parameters given in the request into the user. 38 * 39 * @param request the request 40 * @return the user object or null (if it could not be constructed) 41 */ fromRequest(HttpServletRequest request)42 User fromRequest(HttpServletRequest request); 43 } 44