gerrit.onap Code Review - policy/apex-pdp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.context.parameters;
  22
  23 import java.util.Map;
  24 import java.util.TreeMap;
  25
  26 import org.onap.policy.apex.context.impl.schema.java.JavaSchemaHelperParameters;
  27 import org.onap.policy.apex.model.basicmodel.service.AbstractParameters;
  28 import org.onap.policy.apex.model.basicmodel.service.ParameterService;
  29
  30 /**
  31  * Bean class holding schema parameters for schemas and their helpers. As more than one schema can
  32  * be used in Apex simultaneously, this class is used to hold the schemas that are defined in a
  33  * given Apex system and to get the schema helper plugin parameters {@link SchemaHelperParameters}
  34  * for each schema.
  35  *
  36  * <p>The default {@code Java} schema is always defined and its parameters are held in a
  37  * {@link JavaSchemaHelperParameters} instance.
  38  *
  39  * @author Liam Fallon (liam.fallon@ericsson.com)
  40  */
  41 public class SchemaParameters extends AbstractParameters {
  42     /** The Java schema flavour is always available for use. */
  43     public static final String DEFAULT_SCHEMA_FLAVOUR = "Java";
  44
  45     // A map of parameters for executors of various logic types
  46     private Map<String, SchemaHelperParameters> schemaHelperParameterMap;
  47
  48     /**
  49      * Constructor to create a distributor parameters instance and register the instance with the
  50      * parameter service.
  51      */
  52     public SchemaParameters() {
  53         super(SchemaParameters.class.getCanonicalName());
  54         ParameterService.registerParameters(SchemaParameters.class, this);
  55
  56         schemaHelperParameterMap = new TreeMap<>();
  57
  58         // The default schema helper
  59         schemaHelperParameterMap.put(DEFAULT_SCHEMA_FLAVOUR, new JavaSchemaHelperParameters());
  60     }
  61
  62     /**
  63      * Gets a map of the schemas and schema helper parameters that are defined.
  64      *
  65      * @return the schema helper parameter map
  66      */
  67     public Map<String, SchemaHelperParameters> getSchemaHelperParameterMap() {
  68         return schemaHelperParameterMap;
  69     }
  70
  71     /**
  72      * Sets the map of the schemas and schema helper parameters.
  73      *
  74      * @param schemaHelperParameterMap the schema helper parameter map
  75      */
  76     public void setSchemaHelperParameterMap(final Map<String, SchemaHelperParameters> schemaHelperParameterMap) {
  77         this.schemaHelperParameterMap = schemaHelperParameterMap;
  78     }
  79
  80     /**
  81      * Gets the schema helper parameters for a given context schema flavour.
  82      *
  83      * @param schemaFlavour the schema flavour for which to get the schema helper parameters
  84      * @return the schema helper parameters for the given schema flavour
  85      */
  86     public SchemaHelperParameters getSchemaHelperParameters(final String schemaFlavour) {
  87         return schemaHelperParameterMap.get(schemaFlavour);
  88     }
  89 }