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