summaryrefslogtreecommitdiffstats
path: root/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/filecarrierplugin/consumer/CharacterDelimitedTextBlockReader.java
blob: bd7310d0a539273e944b9f0bdb352b98849b1e78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.service.engine.event.impl.filecarrierplugin.consumer;

import java.io.IOException;
import java.io.InputStream;

import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolTextCharDelimitedParameters;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

/**
 * The class CharacterDelimitedTextBlockReader reads the next block of text between two character
 * tags from an input stream.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class CharacterDelimitedTextBlockReader implements TextBlockReader {
    // The logger for this class
    private static final XLogger LOGGER = XLoggerFactory.getXLogger(CharacterDelimitedTextBlockReader.class);

    // The character tags
    private final char startTagChar;
    private final char endTagChar;

    // The input stream for text
    private InputStream inputStream;

    // Flag indicating we have seen EOF on the stream
    private boolean eofOnInputStream = false;

    /**
     * Constructor, set the delimiters.
     *
     * @param startTagChar The start tag for text blocks
     * @param endTagChar The end tag for text blocks
     */
    public CharacterDelimitedTextBlockReader(final char startTagChar, final char endTagChar) {
        this.startTagChar = startTagChar;
        this.endTagChar = endTagChar;
    }

    /**
     * Constructor, set the delimiters from a character delimited event protocol parameter class.
     *
     * @param charDelimitedParameters the character delimited event protocol parameter class
     */
    public CharacterDelimitedTextBlockReader(final EventProtocolTextCharDelimitedParameters charDelimitedParameters) {
        this.startTagChar = charDelimitedParameters.getStartChar();
        this.endTagChar = charDelimitedParameters.getEndChar();
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.onap.policy.apex.service.engine.event.impl.filecarrierplugin.consumer.TextBlockReader#init(
     * java.io.InputStream)
     */
    @Override
    public void init(final InputStream incomingInputStream) {
        this.inputStream = incomingInputStream;
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.onap.policy.apex.service.engine.event.impl.filecarrierplugin.consumer.TextBlockReader#
     * readTextBlock()
     */
    @Override
    public TextBlock readTextBlock() throws IOException {
        // Check if there was a previous end of a text block with a non-empty text block returned
        if (eofOnInputStream) {
            return new TextBlock(eofOnInputStream, null);
        }

        // Read the block of text
        final StringBuilder textBlockBuilder = readTextBlockText();

        // Condition the text block and return it
        final String textBlock = textBlockBuilder.toString().trim();
        if (textBlock.length() > 0) {
            return new TextBlock(eofOnInputStream, textBlock);
        } else {
            return new TextBlock(eofOnInputStream, null);
        }
    }

    /**
     * Read a block of text.
     * @return A string builder containing the text
     * @throws IOException on read errors
     */
    private StringBuilder readTextBlockText() throws IOException {
        // Holder for the text block
        final StringBuilder textBlockBuilder = new StringBuilder();

        int nestingLevel = 0;
        
        // Read the next text block
        while (true) {
            final char nextChar = (char) inputStream.read();

            // Check for EOF
            if (nextChar == (char) -1) {
                eofOnInputStream = true;
                return textBlockBuilder;
            }

            if (nextChar == startTagChar) {
                nestingLevel++;
            } else if (nestingLevel == 0 && !Character.isWhitespace(nextChar)) {
                LOGGER.warn("invalid input on consumer: {}", nextChar);
                continue;
            }

            textBlockBuilder.append(nextChar);

            // Check for end of the text block, we have come back to level 0
            if (nextChar == endTagChar) {
                if (nestingLevel > 0) {
                    nestingLevel--;
                }

                if (nestingLevel == 0) {
                    return textBlockBuilder;
                }
            }
        }
    }
}