TipoAutorizzazione.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.  */
  20. package org.openspcoop2.core.config.constants;

  22. import java.io.Serializable;
  23. import java.util.ArrayList;
  24. import java.util.List;

  26. import org.openspcoop2.generic_project.beans.IEnumeration;
  27. import org.openspcoop2.generic_project.exception.NotFoundException;
  28. import org.openspcoop2.utils.UtilsRuntimeException;

  30. /**     
  31.  * Enumeration TipoAutorizzazione
  32.  *
  33.  * @author Poli Andrea (poli@link.it)
  34.  * @author $Author$
  35.  * @version $Rev$, $Date$
  36.  */
  37. public enum TipoAutorizzazione implements IEnumeration , Serializable , Cloneable {

  39.     DISABILITATO (CostantiConfigurazione.AUTORIZZAZIONE_NONE,"disabilitato"),
  40.     AUTHENTICATED (CostantiConfigurazione.AUTORIZZAZIONE_AUTHENTICATED,"authenticated"),
  41.     ROLES (CostantiConfigurazione.AUTORIZZAZIONE_ROLES,"roles"),
  42.     INTERNAL_ROLES (CostantiConfigurazione.AUTORIZZAZIONE_INTERNAL_ROLES,"internalRoles"),
  43.     EXTERNAL_ROLES (CostantiConfigurazione.AUTORIZZAZIONE_EXTERNAL_ROLES,"externalRoles"),
  44.     AUTHENTICATED_ROLES (CostantiConfigurazione.AUTORIZZAZIONE_AUTHENTICATED_OR_ROLES,"authenticatedOrRoles"),
  45.     AUTHENTICATED_INTERNAL_ROLES (CostantiConfigurazione.AUTORIZZAZIONE_AUTHENTICATED_OR_INTERNAL_ROLES,"authenticatedOrInternalRoles"),
  46.     AUTHENTICATED_EXTERNAL_ROLES (CostantiConfigurazione.AUTORIZZAZIONE_AUTHENTICATED_OR_EXTERNAL_ROLES,"authenticatedOrExternalRoles"),
  47.     XACML_POLICY (CostantiConfigurazione.AUTORIZZAZIONE_XACML_POLICY,"xacmlPolicy"),
  48.     INTERNAL_XACML_POLICY (CostantiConfigurazione.AUTORIZZAZIONE_INTERNAL_XACML_POLICY,"internalXacmlPolicy"),
  49.     EXTERNAL_XACML_POLICY (CostantiConfigurazione.AUTORIZZAZIONE_EXTERNAL_XACML_POLICY,"externalXacmlPolicy"),
  50.     TOKEN (CostantiConfigurazione.AUTORIZZAZIONE_TOKEN,"token"),
  51.     SIGNAL_HUB_PUSH (CostantiConfigurazione.SIGNAL_HUB_PUSH,"signalHubPush");

  53.     
  54.     /** Value */
  55.     private String value;
  56.     private String label;
  57.     public String getLabel() {
  58.         return this.label;
  59.     }
  60.     @Override
  61.     public String getValue()
  62.     {
  63.         return this.value;
  64.     }


  67.     /** Official Constructor */
  68.     TipoAutorizzazione(String value,String label)
  69.     {
  70.         this.value = value;
  71.         this.label = label;
  72.     }


  75.     
  76.     @Override
  77.     public String toString(){
  78.         return this.value;
  79.     }
  80.     public boolean equals(String object){
  81.         if(object==null)
  82.             return false;
  83.         return object.equals(this.getValue());  
  84.     }
  85.     
  86.         
  87.     
  88.     /** compatibility with the generated bean (reflection) */
  89.     public boolean equals(Object object,List<String> fieldsNotCheck){
  90.         if(fieldsNotCheck!=null) {
  91.             // nop
  92.         }
  93.         if( !(object instanceof TipoAutorizzazione) ){
  94.             throw new UtilsRuntimeException("Wrong type: "+object.getClass().getName());
  95.         }
  96.         return this.equals((object));
  97.     }
  98.     public String toString(boolean reportHTML){
  99.         if(reportHTML) {
  100.             // nop
  101.         }
  102.         return toString();
  103.     }
  104.     public String toString(boolean reportHTML,List<String> fieldsNotIncluded){
  105.         if(reportHTML && fieldsNotIncluded!=null) {
  106.             // nop
  107.         }
  108.         return toString();
  109.     }
  110.     public String diff(Object object,StringBuilder bf,boolean reportHTML){
  111.         if(object!=null && reportHTML) {
  112.             // nop
  113.         }
  114.         return bf.toString();
  115.     }
  116.     public String diff(Object object,StringBuilder bf,boolean reportHTML,List<String> fieldsNotIncluded){
  117.         if(object!=null && reportHTML && fieldsNotIncluded!=null) {
  118.             // nop
  119.         }
  120.         return bf.toString();
  121.     }
  122.     
  123.     
  124.     /** Utilities */
  125.     
  126.     public static boolean isInternalRolesRequired(String autorizzazione){
  127.         return isInternalRolesRequired(TipoAutorizzazione.toEnumConstant(autorizzazione));
  128.     }
  129.     public static boolean isInternalRolesRequired(TipoAutorizzazione autorizzazione){
  130.         return TipoAutorizzazione.INTERNAL_ROLES.equals(autorizzazione) ||
  131.                 TipoAutorizzazione.AUTHENTICATED_INTERNAL_ROLES.equals(autorizzazione);
  132.     }
  133.     
  134.     public static boolean isExternalRolesRequired(String autorizzazione){
  135.         return isExternalRolesRequired(TipoAutorizzazione.toEnumConstant(autorizzazione));
  136.     }
  137.     public static boolean isExternalRolesRequired(TipoAutorizzazione autorizzazione){
  138.         return TipoAutorizzazione.EXTERNAL_ROLES.equals(autorizzazione) ||
  139.                 TipoAutorizzazione.AUTHENTICATED_EXTERNAL_ROLES.equals(autorizzazione);
  140.     }
  141.     
  142.     public static boolean isRolesRequired(String autorizzazione){
  143.         return isRolesRequired(TipoAutorizzazione.toEnumConstant(autorizzazione));
  144.     }
  145.     public static boolean isRolesRequired(TipoAutorizzazione autorizzazione){
  146.         return TipoAutorizzazione.ROLES.equals(autorizzazione) ||
  147.                 TipoAutorizzazione.AUTHENTICATED_ROLES.equals(autorizzazione) ||
  148.                 TipoAutorizzazione.INTERNAL_ROLES.equals(autorizzazione) ||
  149.                 TipoAutorizzazione.AUTHENTICATED_INTERNAL_ROLES.equals(autorizzazione) ||
  150.                 TipoAutorizzazione.EXTERNAL_ROLES.equals(autorizzazione) ||
  151.                 TipoAutorizzazione.AUTHENTICATED_EXTERNAL_ROLES.equals(autorizzazione) ;
  152.     }
  153.     
  154.     public static boolean isAuthenticationRequired(String autorizzazione){
  155.         return isAuthenticationRequired(TipoAutorizzazione.toEnumConstant(autorizzazione));
  156.     }
  157.     
  158.     public static boolean isAuthenticationRequired(TipoAutorizzazione autorizzazione){
  159.         return TipoAutorizzazione.AUTHENTICATED.equals(autorizzazione) ||
  160.                 isSignalHubPush(autorizzazione) ||
  161.                 TipoAutorizzazione.AUTHENTICATED_EXTERNAL_ROLES.equals(autorizzazione)  ||
  162.                 TipoAutorizzazione.AUTHENTICATED_INTERNAL_ROLES.equals(autorizzazione)  ||
  163.                 TipoAutorizzazione.AUTHENTICATED_ROLES.equals(autorizzazione);  
  164.     }
  165.     
  166.     public static boolean isXacmlPolicyRequired(String autorizzazione){
  167.         return isXacmlPolicyRequired(TipoAutorizzazione.toEnumConstant(autorizzazione));
  168.     }
  169.     public static boolean isXacmlPolicyRequired(TipoAutorizzazione autorizzazione){
  170.         return TipoAutorizzazione.XACML_POLICY.equals(autorizzazione) ||
  171.                 TipoAutorizzazione.EXTERNAL_XACML_POLICY.equals(autorizzazione)  ||
  172.                 TipoAutorizzazione.INTERNAL_XACML_POLICY.equals(autorizzazione);
  173.     }
  174.     
  175.     public static boolean isSignalHubPush(String autorizzazione){
  176.         return isSignalHubPush(TipoAutorizzazione.toEnumConstant(autorizzazione));
  177.     }
  178.     public static boolean isSignalHubPush(TipoAutorizzazione autorizzazione){
  179.         return TipoAutorizzazione.SIGNAL_HUB_PUSH.equals(autorizzazione);
  180.     }
  181.     
  182.     public static List<String> getAllValues(){
  183.         List<String> l = new ArrayList<>();
  184.         for (TipoAutorizzazione tmp : values()) {
  185.             l.add(tmp.getValue());
  186.         }
  187.         return l;
  188.     }
  189.     public static List<String> getValues(boolean authenticated,boolean optionalAuthenticated){
  190.         List<String> l = new ArrayList<>();
  191.         for (TipoAutorizzazione tmp : values()) {
  192.             
  193.             if(isAuthenticationRequired(tmp) &&
  194.                 // se l'autenticazione non è attivata, le autorizzazioni basate sull'autenticazione non hanno senso
  195.                 !authenticated){
  196.                 continue;
  197.             }
  198.             
  199.             if(isAuthenticationRequired(tmp) && isRolesRequired(tmp)){
  200.                 // i metodi con sia autenticazione che roles sono permessi solo se l'autenticazione è opzionale, altrimenti i ruoli non verranno mai presi in considerazione
  201.                 if(!optionalAuthenticated){
  202.                     continue;
  203.                 }
  204.             }
  205.             else if(isInternalRolesRequired(tmp) || INTERNAL_XACML_POLICY.equals(tmp)){
  206.                 // sia per i ruoli interni che per la xacml policy interna è richiesta l'autenticazione obbligatoria. Altrimenti la xacml policy request non sarebbe valorizzabile.
  207.                 if(optionalAuthenticated){
  208.                     continue;
  209.                 }
  210.             }
  211.             
  212.             l.add(tmp.getValue());
  213.         }
  214.         return l;
  215.     }
  216.     public static List<String> getLabels(){
  217.         List<String> l = new ArrayList<>();
  218.         for (TipoAutorizzazione tmp : values()) {
  219.             l.add(tmp.getLabel());
  220.         }
  221.         return l;
  222.     }
  223.     
  224.     public static String[] toArray(){
  225.         String[] res = new String[values().length];
  226.         int i=0;
  227.         for (TipoAutorizzazione tmp : values()) {
  228.             res[i]=tmp.getValue();
  229.             i++;
  230.         }
  231.         return res;
  232.     }   
  233.     public static String[] toStringArray(){
  234.         String[] res = new String[values().length];
  235.         int i=0;
  236.         for (TipoAutorizzazione tmp : values()) {
  237.             res[i]=tmp.toString();
  238.             i++;
  239.         }
  240.         return res;
  241.     }
  242.     public static String[] toEnumNameArray(){
  243.         String[] res = new String[values().length];
  244.         int i=0;
  245.         for (TipoAutorizzazione tmp : values()) {
  246.             res[i]=tmp.name();
  247.             i++;
  248.         }
  249.         return res;
  250.     }
  251.     
  252.     public static boolean contains(String value){
  253.         return toEnumConstant(value)!=null;
  254.     }
  255.     
  256.     public static TipoAutorizzazione toEnumConstant(String value){
  257.         try{
  258.             return toEnumConstant(value,false);
  259.         }catch(NotFoundException notFound){
  260.             return null;
  261.         }
  262.     }
  263.     public static TipoAutorizzazione toEnumConstant(String value, boolean throwNotFoundException) throws NotFoundException{
  264.         TipoAutorizzazione res = null;
  265.         for (TipoAutorizzazione tmp : values()) {
  266.             if(tmp.getValue().equals(value)){
  267.                 res = tmp;
  268.                 break;
  269.             }
  270.         }
  271.         if(res==null && throwNotFoundException){
  272.             throw new NotFoundException("Enum with value ["+value+"] not found");
  273.         }
  274.         return res;
  275.     }
  276.     
  277.     public static IEnumeration toEnumConstantFromString(String value){
  278.         try{
  279.             return toEnumConstantFromString(value,false);
  280.         }catch(NotFoundException notFound){
  281.             return null;
  282.         }
  283.     }
  284.     public static IEnumeration toEnumConstantFromString(String value, boolean throwNotFoundException) throws NotFoundException{
  285.         TipoAutorizzazione res = null;
  286.         for (TipoAutorizzazione tmp : values()) {
  287.             if(tmp.toString().equals(value)){
  288.                 res = tmp;
  289.                 break;
  290.             }
  291.         }
  292.         if(res==null && throwNotFoundException){
  293.             throw new NotFoundException("Enum with value ["+value+"] not found");
  294.         }
  295.         return res;
  296.     }
  297. }
Created with JaCoCo 0.8.8.202204050719