NetworkNTJsonschemaValidator.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.  */

  21. package org.openspcoop2.utils.json.validation;

  23. import java.io.ByteArrayOutputStream;
  24. import java.util.Set;

  26. import org.openspcoop2.utils.LoggerWrapperFactory;
  27. import org.openspcoop2.utils.json.IJsonSchemaValidator;
  28. import org.openspcoop2.utils.json.JSONUtils;
  29. import org.openspcoop2.utils.json.JsonSchemaValidatorConfig;
  30. import org.openspcoop2.utils.json.ValidationException;
  31. import org.openspcoop2.utils.json.ValidationResponse;
  32. import org.openspcoop2.utils.json.ValidationResponse.ESITO;
  33. import org.slf4j.Logger;

  35. import com.fasterxml.jackson.databind.JsonNode;
  36. import com.fasterxml.jackson.databind.ObjectMapper;
  37. import com.networknt.schema.JsonSchema;
  38. import com.networknt.schema.JsonSchemaFactory;
  39. import com.networknt.schema.SchemaValidatorsConfig;
  40. import com.networknt.schema.SpecVersion;
  41. import com.networknt.schema.SpecVersionDetector;
  42. import com.networknt.schema.ValidationMessage;

  44. /**
  45.  * NetworkNTJsonschemaValidator
  46.  *
  47.  * @author Giovanni Bussu (bussu@link.it)
  48.  * @author $Author$
  49.  * @version $Rev$, $Date$
  50.  */
  51. public class NetworkNTJsonschemaValidator implements IJsonSchemaValidator {

  53.     /*
  54.      * NOTA: in caso di errore 'should be valid to one and only one of the schemas'
  55.      * 
  56.      * Significa che più elementi possono matchare in un oneOf. Questo succede se ad esempio non è stato definito "additionalProperties: false" in ogni oggetto riferito dal oneOf
  57.      * 
  58.      * NOTA2: Aggiungendo le additionalProperties a false, se si aggiungono male e non si ha un match con nessun oggetto, viene ritornato l'errore relativo ad uno dei tre a caso.
  59.      * */
  60.     
  61.     private JsonSchema schema;
  62.     private byte[] schemaBytes;
  63.     private JsonNode jsonSchema;
  64.     
  65.     private ObjectMapper mapper;
  66.     private Logger log;
  67.     private boolean logError;

  69.     // Tramite un cast e' possibile cosi personalizzare lo schema validator con le opzioni di NT
  70.     private SchemaValidatorsConfig schemaValidatorConfig = null;
  71.     public SchemaValidatorsConfig getSchemaValidatorConfig() {
  72.         return this.schemaValidatorConfig;
  73.     }
  74.     public void setSchemaValidatorConfig(SchemaValidatorsConfig schemaValidatorConfig) {
  75.         this.schemaValidatorConfig = schemaValidatorConfig;
  76.     }
  77.     
  78.     /**
  79.      * 
  80.      */
  81.     public NetworkNTJsonschemaValidator() { 
  82.         this.mapper = new ObjectMapper();
  83.     }
  84.     @Override
  85.     public void setSchema(byte[] schema, JsonSchemaValidatorConfig config, Logger log) throws ValidationException {
  86.         
  87.         this.log = log;
  88.         if(this.log==null) {
  89.             this.log = LoggerWrapperFactory.getLogger(NetworkNTJsonschemaValidator.class);
  90.         }
  91.         this.logError = config!=null ? config.isEmitLogError() : true;
  92.         this.schemaBytes = schema;
  93.         
  94.         try {
  95.             JsonNode jsonSchema =  this.mapper.readTree(schema);
  96.             
  97.             SpecVersion.VersionFlag version = null;
  98.             if(config!=null && config.getJsonSchemaVersion()!=null) {
  99.                 version = config.getJsonSchemaVersion();
  100.             }
  101.             else {
  102.                 version = SpecVersionDetector.detect(jsonSchema);
  103.             }
  104.             
  105.             JsonSchemaFactory factory = JsonSchemaFactory.getInstance(version);
  106.             
  107.             if(config!=null) {
  108.                 switch(config.getAdditionalProperties()) {
  109.                 case DEFAULT:
  110.                     break;
  111.                 case FORCE_DISABLE: ValidationUtils.disableAdditionalProperties(this.mapper, jsonSchema, true, true);
  112.                     break;
  113.                 case FORCE_STRING: ValidationUtils.disableAdditionalProperties(this.mapper, jsonSchema, false, true);
  114.                     break;
  115.                 case IF_NULL_DISABLE: ValidationUtils.disableAdditionalProperties(this.mapper, jsonSchema, true, false);
  116.                     break;
  117.                 case IF_NULL_STRING: ValidationUtils.disableAdditionalProperties(this.mapper, jsonSchema, false, false);
  118.                     break;
  119.                 default:
  120.                     break;
  121.                 }
  122.             }
  123.             
  124.             if(config!=null) {
  125.                 switch(config.getPoliticaInclusioneTipi()) {
  126.                 case DEFAULT:
  127.                     break;
  128.                 case ALL: ValidationUtils.addTypes(this.mapper, jsonSchema, config.getTipi(), true);
  129.                     break;
  130.                 case ANY: ValidationUtils.addTypes(this.mapper, jsonSchema, config.getTipi(), false);
  131.                     break;
  132.                 default:
  133.                     break;
  134.                 }
  135.             }

  137.             if(config!=null && config.isVerbose()) {
  138.                 try {
  139.                     ByteArrayOutputStream bout = new ByteArrayOutputStream();
  140.                     JSONUtils.getInstance(true).writeTo(jsonSchema, bout);
  141.                     bout.flush();
  142.                     bout.close();
  143.                     this.log.debug("JSON Schema: "+bout.toString());
  144.                 }catch(Exception e) {
  145.                     this.log.debug("JSON Schema build error: "+e.getMessage(),e);
  146.                 }
  147.             }
  148.             
  149.             this.jsonSchema = jsonSchema;
  150.             /*
  151.              * https://github.com/networknt/json-schema-validator/blob/master/doc/config.md
  152.              * 
  153.              * SchemaValidatorsConfig configS = new SchemaValidatorsConfig();
  154.              * configS.setHandleNullableField(false);
  155.              * configS.setTypeLoose(true);
  156.              **/
  157.             if(this.schemaValidatorConfig!=null) {
  158.                 this.schema = factory.getSchema(jsonSchema, this.schemaValidatorConfig);
  159.             }
  160.             else {
  161.                 this.schema = factory.getSchema(jsonSchema);
  162.             }
  163.             
  164.         } catch(Throwable e) {
  165.             throw new ValidationException(e);
  166.         }
  167.     }
  168.     



  172.     @Override
  173.     public ValidationResponse validate(byte[] rawObject) throws ValidationException {
  174.         
  175.         ValidationResponse response = new ValidationResponse();
  176.         try {
  177.             boolean expectedString = false;
  178.             if(this.jsonSchema.has("type")) {
  179.                 try {
  180.                     JsonNode type = this.jsonSchema.get("type");
  181.                     String vType = type.asText();
  182.                     expectedString = "string".equals(vType);
  183.                 }catch(Exception e) {}
  184.             }
  185.             
  186.             JsonNode node = null;
  187.             try {
  188.                 if(expectedString) {
  189.                     node = this.mapper.getNodeFactory().textNode(new String(rawObject));
  190.                 }
  191.                 else {
  192.                     node = this.mapper.readTree(rawObject);
  193.                 }
  194.             }
  195.             catch(Exception e) {
  196.                 this.log.error(e.getMessage(),e);
  197.                 String messageString = "Read rawObject as jsonNode failed: "+e.getMessage();
  198.                 response.setEsito(ESITO.KO);
  199.                 if(this.logError) {
  200.                     ValidationUtils.logError(this.log, messageString.toString(), rawObject, this.schemaBytes, this.jsonSchema);
  201.                 }
  202.                 response.setException(new Exception(messageString.toString()));
  203.             }

  205.             if(node!=null) {
  206.                 Set<ValidationMessage> validate = this.schema.validate(node);
  207.                 if(validate.isEmpty()) {
  208.                     response.setEsito(ESITO.OK);    
  209.                 } else {
  210.                     response.setEsito(ESITO.KO);
  211.                     StringBuilder messageString = new StringBuilder();
  212.                     for(ValidationMessage msg: validate) {
  213.                         String errorMsg = msg.getCode() + " " + msg.getMessage();
  214.                         response.getErrors().add(errorMsg);
  215.                         messageString.append(errorMsg).append("\n");
  216.                     }
  217.                     if(this.logError) {
  218.                         ValidationUtils.logError(this.log, messageString.toString(), rawObject, this.schemaBytes, this.jsonSchema);
  219.                     }
  220.                     response.setException(new Exception(messageString.toString()));
  221.     
  222.                 }
  223.             }
  224.             
  225.         } catch(Exception e) {
  226.             throw new ValidationException(e);
  227.         }
  228.         return response;
  229.     }
  230.     
  231. }
Created with JaCoCo 0.8.8.202204050719