services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/filecarrierplugin/consumer/CharacterDelimitedTextBlockReader.java

   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.filecarrierplugin.consumer;
  22
  23 import java.io.IOException;
  24 import java.io.InputStream;
  25 import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolTextCharDelimitedParameters;
  26 import org.slf4j.ext.XLogger;
  27 import org.slf4j.ext.XLoggerFactory;
  28
  29 /**
  30  * The class CharacterDelimitedTextBlockReader reads the next block of text between two character
  31  * tags from an input stream.
  32  *
  33  * @author Liam Fallon (liam.fallon@ericsson.com)
  34  */
  35 public class CharacterDelimitedTextBlockReader implements TextBlockReader {
  36     // The logger for this class
  37     private static final XLogger LOGGER = XLoggerFactory.getXLogger(CharacterDelimitedTextBlockReader.class);
  38
  39     // The character tags
  40     private final char startTagChar;
  41     private final char endTagChar;
  42
  43     // The input stream for text
  44     private InputStream inputStream;
  45
  46     // Flag indicating we have seen EOF on the stream
  47     private boolean eofOnInputStream = false;
  48
  49     /**
  50      * Constructor, set the delimiters.
  51      *
  52      * @param startTagChar The start tag for text blocks
  53      * @param endTagChar The end tag for text blocks
  54      */
  55     public CharacterDelimitedTextBlockReader(final char startTagChar, final char endTagChar) {
  56         this.startTagChar = startTagChar;
  57         this.endTagChar = endTagChar;
  58     }
  59
  60     /**
  61      * Constructor, set the delimiters from a character delimited event protocol parameter class.
  62      *
  63      * @param charDelimitedParameters the character delimited event protocol parameter class
  64      */
  65     public CharacterDelimitedTextBlockReader(final EventProtocolTextCharDelimitedParameters charDelimitedParameters) {
  66         this.startTagChar = charDelimitedParameters.getStartChar();
  67         this.endTagChar = charDelimitedParameters.getEndChar();
  68     }
  69
  70     /**
  71      * {@inheritDoc}.
  72      */
  73     @Override
  74     public void init(final InputStream incomingInputStream) {
  75         this.inputStream = incomingInputStream;
  76     }
  77
  78     /**
  79      * {@inheritDoc}.
  80      */
  81     @Override
  82     public TextBlock readTextBlock() throws IOException {
  83         // Check if there was a previous end of a text block with a non-empty text block returned
  84         if (eofOnInputStream) {
  85             return new TextBlock(eofOnInputStream, null);
  86         }
  87
  88         // Read the block of text
  89         final StringBuilder textBlockBuilder = readTextBlockText();
  90
  91         // Condition the text block and return it
  92         final String textBlock = textBlockBuilder.toString().trim();
  93         if (textBlock.length() > 0) {
  94             return new TextBlock(eofOnInputStream, textBlock);
  95         } else {
  96             return new TextBlock(eofOnInputStream, null);
  97         }
  98     }
  99
 100     /**
 101      * Read a block of text.
 102      * @return A string builder containing the text
 103      * @throws IOException on read errors
 104      */
 105     private StringBuilder readTextBlockText() throws IOException {
 106         // Holder for the text block
 107         final StringBuilder textBlockBuilder = new StringBuilder();
 108
 109         int nestingLevel = 0;
 110
 111         // Read the next text block
 112         while (true) {
 113             final char nextChar = (char) inputStream.read();
 114
 115             // Check for EOF
 116             if (nextChar == (char) -1) {
 117                 eofOnInputStream = true;
 118                 return textBlockBuilder;
 119             }
 120
 121             if (nextChar == startTagChar) {
 122                 nestingLevel++;
 123             } else if (nestingLevel == 0 && !Character.isWhitespace(nextChar)) {
 124                 LOGGER.warn("invalid input on consumer: {}", nextChar);
 125                 continue;
 126             }
 127
 128             textBlockBuilder.append(nextChar);
 129
 130             // Check for end of the text block, we have come back to level 0
 131             if (nextChar == endTagChar) {
 132                 if (nestingLevel > 0) {
 133                     nestingLevel--;
 134                 }
 135
 136                 if (nestingLevel == 0) {
 137                     return textBlockBuilder;
 138                 }
 139             }
 140         }
 141     }
 142 }