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.service.parameters.eventprotocol;
  22
  23 import org.onap.policy.common.parameters.GroupValidationResult;
  24 import org.onap.policy.common.parameters.ParameterGroup;
  25 import org.onap.policy.common.parameters.ParameterRuntimeException;
  26 import org.onap.policy.common.parameters.ValidationStatus;
  27
  28 /**
  29  * A default event protocol parameter class that may be specialized by event protocol plugins that require plugin
  30  * specific parameters.
  31  *
  32  * <p>
  33  * The following parameters are defined:
  34  * <ol>
  35  * <li>label: The label of the event protocol technology.
  36  * <li>eventProducerPluginClass: The name of the plugin class that will be used by Apex to produce and emit output
  37  * events for this carrier technology
  38  * </ol>
  39  *
  40  * @author Liam Fallon (liam.fallon@ericsson.com)
  41  */
  42 public abstract class EventProtocolParameters implements ParameterGroup {
  43     // The event protocol label
  44     private String label = null;
  45
  46     // Event protocol converter plugin class for this event protocol
  47     private String eventProtocolPluginClass;
  48
  49     /**
  50      * Constructor to create an event protocol parameters instance with the name of a sub class of this class and
  51      * register the instance with the parameter service.
  52      *
  53      * @param parameterClassName the class name of a sub class of this class
  54      */
  55     public EventProtocolParameters(final String parameterClassName) {
  56         super();
  57     }
  58
  59     /**
  60      * Gets the label of the event protocol.
  61      *
  62      * @return the label of the event protocol
  63      */
  64     public String getLabel() {
  65         return label;
  66     }
  67
  68     /**
  69      * Sets the label of the event protocol.
  70      *
  71      * @param label the label of the event protocol
  72      */
  73     public void setLabel(final String label) {
  74         this.label = label.replaceAll("\\s+", "");
  75     }
  76
  77     /**
  78      * Gets the event event protocol plugin class.
  79      *
  80      * @return the event event protocol plugin class
  81      */
  82     public String getEventProtocolPluginClass() {
  83         return eventProtocolPluginClass;
  84     }
  85
  86     /**
  87      * Sets the event event protocol plugin class.
  88      *
  89      * @param eventProtocolPluginClass the event event protocol plugin class
  90      */
  91     public void setEventProtocolPluginClass(final String eventProtocolPluginClass) {
  92         this.eventProtocolPluginClass = eventProtocolPluginClass.replaceAll("\\s+", "");
  93     }
  94
  95     /*
  96      * (non-Javadoc)
  97      *
  98      * @see org.onap.policy.apex.model.basicmodel.service.AbstractParameters#toString()
  99      */
 100     @Override
 101     public String toString() {
 102         return "CarrierTechnologyParameters [label=" + label + ", EventProtocolPluginClass=" + eventProtocolPluginClass
 103                         + "]";
 104     }
 105
 106     /*
 107      * (non-Javadoc)
 108      *
 109      * @see org.onap.policy.apex.service.parameters.ApexParameterValidator#validate()
 110      */
 111     @Override
 112     public GroupValidationResult validate() {
 113         final GroupValidationResult result = new GroupValidationResult(this);
 114
 115         if (label == null || label.length() == 0) {
 116             result.setResult("label", ValidationStatus.INVALID, "event protocol label not specified or is blank");
 117         }
 118
 119         if (eventProtocolPluginClass == null || eventProtocolPluginClass.length() == 0) {
 120             result.setResult("eventProtocolPluginClass", ValidationStatus.INVALID,
 121                             "event protocol eventProtocolPluginClass not specified or is blank");
 122         }
 123
 124         return result;
 125     }
 126
 127     @Override
 128     public String getName() {
 129         return this.getLabel();
 130     }
 131
 132     @Override
 133     public void setName(final String name) {
 134         throw new ParameterRuntimeException("the name/label of this event protocol is always \"" + getLabel() + "\"");
 135     }
 136 }