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.engine.event.impl.eventrequestor;
  22
  23 import org.onap.policy.apex.service.parameters.carriertechnology.CarrierTechnologyParameters;
  24 import org.onap.policy.common.parameters.GroupValidationResult;
  25
  26 /**
  27  * This class holds the parameters that allows an output event to to be sent back into APEX as one
  28  * or multiple input events, there are no user defined parameters.
  29  *
  30  * @author Liam Fallon (liam.fallon@ericsson.com)
  31  */
  32 public class EventRequestorCarrierTechnologyParameters extends CarrierTechnologyParameters {
  33     // @formatter:off
  34     /** The label of this carrier technology. */
  35     public static final String EVENT_REQUESTOR_CARRIER_TECHNOLOGY_LABEL = "EVENT_REQUESTOR";
  36
  37     /** The producer plugin class for the EVENT_REQUESTOR carrier technology. */
  38     public static final String EVENT_REQUESTOR_EVENT_PRODUCER_PLUGIN_CLASS =
  39             EventRequestorProducer.class.getCanonicalName();
  40
  41     /** The consumer plugin class for the EVENT_REQUESTOR carrier technology. */
  42     public static final String EVENT_REQUESTOR_EVENT_CONSUMER_PLUGIN_CLASS =
  43             EventRequestorConsumer.class.getCanonicalName();
  44     // @formatter:on
  45
  46     /**
  47      * Constructor to create an event requestor carrier technology parameters instance and register
  48      * the instance with the parameter service.
  49      */
  50     public EventRequestorCarrierTechnologyParameters() {
  51         super();
  52
  53         // Set the carrier technology properties for the EVENT_REQUESTOR carrier technology
  54         this.setLabel(EVENT_REQUESTOR_CARRIER_TECHNOLOGY_LABEL);
  55         this.setEventProducerPluginClass(EVENT_REQUESTOR_EVENT_PRODUCER_PLUGIN_CLASS);
  56         this.setEventConsumerPluginClass(EVENT_REQUESTOR_EVENT_CONSUMER_PLUGIN_CLASS);
  57     }
  58
  59     /*
  60      * (non-Javadoc)
  61      *
  62      * @see org.onap.policy.apex.apps.uservice.parameters.ApexParameterValidator#validate()
  63      */
  64     @Override
  65     public GroupValidationResult validate() {
  66         return new GroupValidationResult(this);
  67     }
  68
  69     /* (non-Javadoc)
  70      * @see org.onap.policy.common.parameters.ParameterGroup#getName()
  71      */
  72     @Override
  73     public String getName() {
  74         return this.getLabel();
  75     }
  76 }