diff options
Diffstat (limited to 'src/main/java/org/onap/dcae/common/validator')
4 files changed, 269 insertions, 0 deletions
diff --git a/src/main/java/org/onap/dcae/common/validator/GeneralEventValidator.java b/src/main/java/org/onap/dcae/common/validator/GeneralEventValidator.java new file mode 100644 index 00000000..5cd5dc25 --- /dev/null +++ b/src/main/java/org/onap/dcae/common/validator/GeneralEventValidator.java @@ -0,0 +1,75 @@ +/* + * ============LICENSE_START======================================================= + * PROJECT + * ================================================================================ + * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ +package org.onap.dcae.common.validator; + +import com.networknt.schema.JsonSchema; +import org.onap.dcae.ApplicationSettings; +import org.onap.dcae.common.model.VesEvent; +import org.onap.dcae.restapi.ApiException; +import org.onap.dcae.restapi.EventValidatorException; + +/** + * This class is using ApplicationSetting and SchemaValidator to validate VES event. + * + * @author Zebek + */ +public class GeneralEventValidator { + + private final SchemaValidator schemaValidator; + private final ApplicationSettings applicationSettings; + + public GeneralEventValidator(ApplicationSettings applicationSettings) { + this(applicationSettings, new SchemaValidator()); + } + + GeneralEventValidator(ApplicationSettings applicationSettings, SchemaValidator schemaValidator) { + this.applicationSettings = applicationSettings; + this.schemaValidator = schemaValidator; + } + + /** + * This method is validating given event using schema adn throws exception if event is not valid + * + * @param vesEvent event that will be validate + * @param type expected type of event + * @param version json schema version that will be used + * @throws EventValidatorException when event is not valid or have wrong type + */ + public void validate(VesEvent vesEvent, String type, String version) throws EventValidatorException { + if (applicationSettings.eventSchemaValidationEnabled()) { + doValidation(vesEvent, type, version); + } + } + + private void doValidation(VesEvent vesEvent, String type, String version) throws EventValidatorException { + if (vesEvent.hasType(type)) { + if (!isEventMatchToSchema(vesEvent, applicationSettings.jsonSchema(version))) { + throw new EventValidatorException(ApiException.SCHEMA_VALIDATION_FAILED); + } + } else { + throw new EventValidatorException(ApiException.INVALID_JSON_INPUT); + } + } + + private boolean isEventMatchToSchema(VesEvent vesEvent, JsonSchema schema) { + return schemaValidator.conformsToSchema(vesEvent.asJsonObject(), schema); + } +} diff --git a/src/main/java/org/onap/dcae/common/validator/SchemaValidator.java b/src/main/java/org/onap/dcae/common/validator/SchemaValidator.java new file mode 100644 index 00000000..80c8f6e7 --- /dev/null +++ b/src/main/java/org/onap/dcae/common/validator/SchemaValidator.java @@ -0,0 +1,58 @@ +/*
+ * ============LICENSE_START=======================================================
+ * PROJECT
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019 Nokia. All rights reserved.s
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+package org.onap.dcae.common.validator;
+
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.networknt.schema.JsonSchema;
+import com.networknt.schema.ValidationMessage;
+import org.json.JSONObject;
+import org.onap.dcae.ApplicationException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Set;
+
+class SchemaValidator {
+ public static final Logger log = LoggerFactory.getLogger(SchemaValidator.class);
+
+ public boolean conformsToSchema(JSONObject payload, JsonSchema schema) {
+ try {
+ ObjectMapper mapper = new ObjectMapper();
+
+ String content = payload.toString();
+ JsonNode node = mapper.readTree(content);
+ Set<ValidationMessage> messageSet = schema.validate(node);
+
+ if (messageSet.isEmpty()) {
+ return true;
+ }
+
+ log.warn("Schema validation failed for event: {}", payload);
+ messageSet.forEach(it->log.warn(it.getMessage()) );
+
+ return false;
+ } catch (Exception e) {
+ throw new ApplicationException("Unable to validate against schema", e);
+ }
+ }
+}
diff --git a/src/main/java/org/onap/dcae/common/validator/StndDefinedDataValidator.java b/src/main/java/org/onap/dcae/common/validator/StndDefinedDataValidator.java new file mode 100644 index 00000000..d936f272 --- /dev/null +++ b/src/main/java/org/onap/dcae/common/validator/StndDefinedDataValidator.java @@ -0,0 +1,83 @@ +/* + * ============LICENSE_START======================================================= + * VES + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ + +package org.onap.dcae.common.validator; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.JsonNode; +import org.json.JSONException; +import org.onap.dcae.common.model.VesEvent; +import org.onap.dcae.restapi.ApiException; +import org.onap.dcae.restapi.EventValidatorException; +import org.onap.dcaegen2.services.sdk.services.external.schema.manager.exception.IncorrectInternalFileReferenceException; +import org.onap.dcaegen2.services.sdk.services.external.schema.manager.exception.NoLocalReferenceException; +import org.onap.dcaegen2.services.sdk.services.external.schema.manager.service.StndDefinedValidator; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +@Service +public class StndDefinedDataValidator { + + private static final String STND_DEFINED_DOMAIN = "stndDefined"; + + private final StndDefinedValidator stndDefinedValidator; + + @Autowired + public StndDefinedDataValidator(StndDefinedValidator validator) { + this.stndDefinedValidator = validator; + } + + /** + * Validates incoming event + * + * @param event as JsonNode + * @throws EventValidatorException exceptions related to failing StndDefined validation + */ + public void validate(VesEvent event) throws EventValidatorException { + try { + if (shouldBeValidated(event) && !doValidation(event.asJsonNode())) { + throw new EventValidatorException(ApiException.STND_DEFINED_VALIDATION_FAILED); + } + } catch (JsonProcessingException ex) { + throw new EventValidatorException(ApiException.INVALID_JSON_INPUT); + } + } + + private boolean doValidation(JsonNode event) throws EventValidatorException { + try { + return stndDefinedValidator.validate(event); + } catch (NoLocalReferenceException e) { + throw new EventValidatorException(ApiException.NO_LOCAL_SCHEMA_REFERENCE); + } catch (IncorrectInternalFileReferenceException e) { + throw new EventValidatorException(ApiException.INCORRECT_INTERNAL_FILE_REFERENCE); + } + } + + private boolean shouldBeValidated(VesEvent event) { + boolean shouldBeValidated; + try { + shouldBeValidated = STND_DEFINED_DOMAIN.equals(event.getDomain()) + && !event.getSchemaReference().isEmpty(); + } catch (JSONException e) { + shouldBeValidated = false; + } + return shouldBeValidated; + } +} diff --git a/src/main/java/org/onap/dcae/common/validator/StndDefinedValidatorResolver.java b/src/main/java/org/onap/dcae/common/validator/StndDefinedValidatorResolver.java new file mode 100644 index 00000000..3f06d0ae --- /dev/null +++ b/src/main/java/org/onap/dcae/common/validator/StndDefinedValidatorResolver.java @@ -0,0 +1,53 @@ +/* + * ============LICENSE_START======================================================= + * VES + * ================================================================================ + * Copyright (C) 2020 Nokia. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ + +package org.onap.dcae.common.validator; + +import org.onap.dcae.ApplicationSettings; +import org.onap.dcaegen2.services.sdk.services.external.schema.manager.service.StndDefinedValidator; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +@Service +public class StndDefinedValidatorResolver { + + private final ApplicationSettings settings; + + @Autowired + public StndDefinedValidatorResolver(ApplicationSettings settings) { + this.settings = settings; + } + + /** + * Creates StndDefinedValidator using settings defined in collector.properties + * + * @return StndDefinedValidator object for validation of configured fields of event + */ + public StndDefinedValidator resolve() { + return new StndDefinedValidator.ValidatorBuilder() + .mappingFilePath(settings.getExternalSchemaMappingFileLocation()) + .schemaRefPath(settings.getExternalSchemaSchemaRefPath()) + .schemasPath(settings.getExternalSchemaSchemasLocation()) + .stndDefinedDataPath(settings.getExternalSchemaStndDefinedDataPath()) + .build(); + } +} + + |