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.common.parameters.GroupValidationResult;
  25 import org.onap.policy.common.parameters.ParameterGroup;
  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 implements ParameterGroup {
  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     private String name;
  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();
  49
  50         // Set the name for the parameters
  51         this.name = ContextParameterConstants.LOCKING_GROUP_NAME;
  52     }
  53
  54     /**
  55      * Gets the plugin class.
  56      *
  57      * @return the plugin class
  58      */
  59     public String getPluginClass() {
  60         return pluginClass;
  61     }
  62
  63     /**
  64      * Sets the plugin class.
  65      *
  66      * @param pluginClass the plugin class
  67      */
  68     public void setPluginClass(final String pluginClass) {
  69         this.pluginClass = pluginClass;
  70     }
  71
  72     @Override
  73     public String toString() {
  74         return "LockManagerParameters [name=" + name + ", pluginClass=" + pluginClass + "]";
  75     }
  76
  77     @Override
  78     public String getName() {
  79         return name;
  80     }
  81
  82     @Override
  83     public void setName(final String name) {
  84         this.name = name;
  85     }
  86
  87     @Override
  88     public GroupValidationResult validate() {
  89         return new GroupValidationResult(this);
  90     }
  91 }