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.apexprotocolplugin;
  22
  23 import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParameters;
  24
  25 /**
  26  * Event protocol parameters for JSON as an event protocol, there are no user defined parameters.
  27  *
  28  * @author Liam Fallon (liam.fallon@ericsson.com)
  29  */
  30 public class ApexEventProtocolParameters extends EventProtocolParameters {
  31     /** The label of this event protocol. */
  32     public static final String APEX_EVENT_PROTOCOL_LABEL = "APEX";
  33
  34     /**
  35      * Constructor to create a JSON event protocol parameter instance and register the instance with the parameter
  36      * service.
  37      */
  38     public ApexEventProtocolParameters() {
  39         this(APEX_EVENT_PROTOCOL_LABEL);
  40     }
  41
  42     /**
  43      * Constructor to create an event protocol parameters instance with the name of a sub class of this class.
  44      *
  45      * @param eventProtocolLabel the name of the event protocol for this plugin
  46      */
  47     public ApexEventProtocolParameters(final String eventProtocolLabel) {
  48         super();
  49
  50         // Set the event protocol properties for the JSON event protocol
  51         this.setLabel(eventProtocolLabel);
  52
  53         // Set the event protocol plugin class
  54         this.setEventProtocolPluginClass(Apex2ApexEventConverter.class.getCanonicalName());
  55     }
  56 }