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.plugins.event.protocol.xml;
  22
  23 import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolTextTokenDelimitedParameters;
  24
  25 /**
  26  * Event protocol parameters for XML as an event protocol.
  27  *
  28  * @author Liam Fallon (liam.fallon@ericsson.com)
  29  */
  30 public class XmlEventProtocolParameters extends EventProtocolTextTokenDelimitedParameters {
  31     /** The label of this carrier technology. */
  32     public static final String XML_EVENT_PROTOCOL_LABEL = "XML";
  33
  34     // Constants for the text delimiter token
  35     private static final String XML_TEXT_DELIMITER_TOKEN = "<?xml";
  36
  37     /**
  38      * Constructor to create a JSON event protocol parameter instance and register the instance with the parameter
  39      * service.
  40      */
  41     public XmlEventProtocolParameters() {
  42         super();
  43
  44         // Set the event protocol properties for the XML event protocol
  45         this.setLabel(XML_EVENT_PROTOCOL_LABEL);
  46
  47         // Set the starting and ending delimiters for text blocks of XML events
  48         this.setStartDelimiterToken(XML_TEXT_DELIMITER_TOKEN);
  49
  50         // Set the event protocol plugin class
  51         this.setEventProtocolPluginClass(Apex2XmlEventConverter.class.getCanonicalName());
  52     }
  53 }