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 org.onap.policy.apex.model.basicmodel.service.AbstractParameters;
  24 import org.onap.policy.apex.model.basicmodel.service.ParameterService;
  25
  26 /**
  27  * An empty distributor parameter class that may be specialized by context distributor plugins that require plugin
  28  * specific parameters. The class defines the default distributor plugin as the JVM local distributor.
  29  *
  30  * @author Liam Fallon (liam.fallon@ericsson.com)
  31  */
  32 public class DistributorParameters extends AbstractParameters {
  33     /** The default distributor makes context albums available to all threads in a single JVM. */
  34     public static final String DEFAULT_DISTRIBUTOR_PLUGIN_CLASS =
  35             "org.onap.policy.apex.context.impl.distribution.jvmlocal.JVMLocalDistributor";
  36
  37     // Plugin class names
  38     private String pluginClass = DEFAULT_DISTRIBUTOR_PLUGIN_CLASS;
  39
  40     /**
  41      * Constructor to create a distributor parameters instance and register the instance with the parameter service.
  42      */
  43     public DistributorParameters() {
  44         super(DistributorParameters.class.getCanonicalName());
  45         ParameterService.registerParameters(DistributorParameters.class, this);
  46     }
  47
  48     /**
  49      * Constructor to create a distributor parameters instance with the name of a sub class of this class and register
  50      * the instance with the parameter service.
  51      *
  52      * @param parameterClassName the class name of a sub class of this class
  53      */
  54     public DistributorParameters(final String parameterClassName) {
  55         super(parameterClassName);
  56     }
  57
  58     /**
  59      * Gets the plugin class.
  60      *
  61      * @return the plugin class
  62      */
  63     public String getPluginClass() {
  64         return pluginClass;
  65     }
  66
  67     /**
  68      * Sets the plugin class.
  69      *
  70      * @param pluginClass the plugin class
  71      */
  72     public void setPluginClass(final String pluginClass) {
  73         this.pluginClass = pluginClass;
  74     }
  75
  76     /*
  77      * (non-Javadoc)
  78      *
  79      * @see org.onap.policy.apex.model.basicmodel.service.AbstractParameters#toString()
  80      */
  81     @Override
  82     public String toString() {
  83         return "DistributorParameters [pluginClass=" + pluginClass + "]";
  84     }
  85 }