aai-schema-ingest/src/main/java/org/onap/aai/validation/edges/EdgeFieldsValidationModule.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-18 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *   http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.aai.validation.edges;
  22
  23 import java.util.Map;
  24
  25 /**
  26  * Verifies that a given raw edge rule contains all required fields.
  27  *
  28  */
  29 public interface EdgeFieldsValidationModule {
  30
  31         /**
  32          * Verifies the given rule has all required fields.
  33          * Implement to check for what you determine to be required.
  34          * You may also throw an error on unexpected fields if you wish,
  35          * whatever makes sense for your system.
  36          *
  37          * @param rule - Map<String, String> that will look something like this:
  38          *              {
  39          *                      "from": "foo",
  40          *                      "to": "bar",
  41          *                      "label": "tosca.relationships.network.BindsTo",
  42          *                      "direction": "OUT",
  43          *                      "multiplicity": "ONE2ONE",
  44          *                      "contains-other-v": "NONE",
  45          *                      "delete-other-v": "NONE",
  46          *                      "prevent-delete": "NONE",
  47          *                      "default": "true",
  48          *                      "description":"An edge comment"
  49          *              }
  50          * @return empty String if no errors found, or String with
  51          *      the appropriate error message
  52          */
  53         public String verifyFields(Map<String, String> rule);
  54 }