ParametriAutenticazioneApiKey.java

  1. /*
  2.  * GovWay - A customizable API Gateway 
  3.  * https://govway.org
  4.  * 
  5.  * Copyright (c) 2005-2025 Link.it srl (https://link.it). 
  6.  * 
  7.  * This program is free software: you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License version 3, as published by
  9.  * the Free Software Foundation.
  10.  *
  11.  * This program is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.  * GNU General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public License
  17.  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18.  *
  19.  */



  23. package org.openspcoop2.pdd.core.autenticazione;

  25. import org.openspcoop2.utils.BooleanNullable;

  27. /**
  28.  * ParametriAutenticazioneApiKey
  29.  *
  30.  * @author Andrea Poli (apoli@link.it)
  31.  * @author $Author$
  32.  * @version $Rev$, $Date$
  33.  */
  34. public class ParametriAutenticazioneApiKey extends ParametriAutenticazione implements java.io.Serializable {

  36.     
  37.     /**
  38.      * 
  39.      */
  40.     private static final long serialVersionUID = 1L;

  42.     public static final String DEFAULT_HEADER_API_KEY = "X-API-KEY";
  43.     public static final String DEFAULT_COOKIE_API_KEY = "X-API-KEY";
  44.     public static final String DEFAULT_QUERY_PARAMETER_API_KEY = "api_key";
  45.     
  46.     public static final String DEFAULT_HEADER_APP_ID = "X-APP-ID";
  47.     public static final String DEFAULT_COOKIE_APP_ID = "X-APP-ID";
  48.     public static final String DEFAULT_QUERY_PARAMETER_APP_ID = "app_id";
  49.     
  50.     public static final String TRUE = "true";
  51.     public static final String FALSE = "false";
  52.     
  53.     public static final String HEADER = "header";
  54.     public static final String HEADER_TRUE = TRUE;
  55.     public static final String HEADER_FALSE = FALSE;
  56.     
  57.     public static final String COOKIE = "cookie";
  58.     public static final String COOKIE_TRUE = TRUE;
  59.     public static final String COOKIE_FALSE = FALSE;
  60.     
  61.     public static final String QUERY_PARAMETER = "queryParameter";
  62.     public static final String QUERY_PARAMETER_TRUE = TRUE;
  63.     public static final String QUERY_PARAMETER_FALSE = FALSE;
  64.     
  65.     public static final String USE_OAS3_NAMES = "useOAS3Names";
  66.     public static final String USE_OAS3_NAMES_TRUE = TRUE;
  67.     public static final String USE_OAS3_NAMES_FALSE = FALSE;
  68.     
  69.     public static final String NOME_HEADER_API_KEY = "headerApiKey";
  70.     public static final String NOME_COOKIE_API_KEY = "cookieApiKey";
  71.     public static final String NOME_QUERY_PARAMETER_API_KEY = "queryParameterApiKey";
  72.     
  73.     public static final String APP_ID = "appId";
  74.     public static final String APP_ID_TRUE = TRUE;
  75.     public static final String APP_ID_FALSE = FALSE;

  77.     public static final String NOME_HEADER_APP_ID = "headerAppId";
  78.     public static final String NOME_COOKIE_APP_ID = "cookieAppId";
  79.     public static final String NOME_QUERY_PARAMETER_APP_ID = "queryParameterAppId";
  80.     
  81.     public static final String CLEAN_API_KEY = "cleanApiKey";
  82.     public static final String CLEAN_API_KEY_TRUE = TRUE;
  83.     public static final String CLEAN_API_KEY_FALSE = FALSE;
  84.     
  85.     public static final String CLEAN_APP_ID = "cleanAppId";
  86.     public static final String CLEAN_APP_ID_TRUE = TRUE;
  87.     public static final String CLEAN_APP_ID_FALSE = FALSE;
  88.     
  89.     
  90.     public ParametriAutenticazioneApiKey(ParametriAutenticazione parametri) {
  91.         super(parametri);
  92.     }
  93.     
  94.     public BooleanNullable getHeader() {
  95.         return _get(HEADER);
  96.     }
  97.     public BooleanNullable getCookie() {
  98.         return _get(COOKIE);
  99.     }
  100.     public BooleanNullable getQueryParameter() {
  101.         return _get(QUERY_PARAMETER);
  102.     }
  103.     
  104.     public String getNomeHeaderApiKey() {
  105.         return _getNome(DEFAULT_HEADER_API_KEY, NOME_HEADER_API_KEY);
  106.     }
  107.     public String getNomeCookieApiKey() {
  108.         return _getNome(DEFAULT_COOKIE_API_KEY, NOME_COOKIE_API_KEY);
  109.     }
  110.     public String getNomeQueryParameterApiKey() {
  111.         return _getNome(DEFAULT_QUERY_PARAMETER_API_KEY, NOME_QUERY_PARAMETER_API_KEY);
  112.     }
  113.     
  114.     public BooleanNullable getAppId() {
  115.         return _get(APP_ID);
  116.     }
  117.     
  118.     public String getNomeHeaderAppId() {
  119.         return _getNome(DEFAULT_HEADER_APP_ID, NOME_HEADER_APP_ID);
  120.     }
  121.     public String getNomeCookieAppId() {
  122.         return _getNome(DEFAULT_COOKIE_APP_ID, NOME_COOKIE_APP_ID);
  123.     }
  124.     public String getNomeQueryParameterAppId() {
  125.         return _getNome(DEFAULT_QUERY_PARAMETER_APP_ID, NOME_QUERY_PARAMETER_APP_ID);
  126.     }
  127.     
  128.     public BooleanNullable getCleanApiKey() {
  129.         return _get(CLEAN_API_KEY);
  130.     }
  131.     public BooleanNullable getCleanAppId() {
  132.         return _get(CLEAN_APP_ID);
  133.     }
  134.     
  135.     private BooleanNullable _get(String name) {
  136.         String valore = this.get(name);
  137.         if(valore==null || "".equals(valore)) {
  138.             return BooleanNullable.NULL();
  139.         }
  140.         if(FALSE.equalsIgnoreCase(valore)) {
  141.             return BooleanNullable.FALSE();
  142.         }
  143.         else if(TRUE.equalsIgnoreCase(valore)) {
  144.             return BooleanNullable.TRUE();
  145.         }
  146.         return BooleanNullable.NULL();
  147.     }
  148.     
  149.     private String _getNome(String defaultName, String nome) {
  150.         
  151.         BooleanNullable useOAS3NamesNullable = _get(USE_OAS3_NAMES);
  152.         if(useOAS3NamesNullable!=null && useOAS3NamesNullable.getValue()!=null && useOAS3NamesNullable.getValue()) {
  153.             return defaultName;
  154.         }
  155.         
  156.         String nomeCustom = this.get(nome);
  157.         if(nomeCustom==null || "".equals(nomeCustom)) {
  158.             return defaultName;
  159.         }
  160.         
  161.         return nomeCustom;
  162.     }
  163. }
Created with JaCoCo 0.8.8.202204050719