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