aboutsummaryrefslogtreecommitdiffstats
path: root/services/services-engine/src/main/java/org/onap/policy/apex/service/engine/event/impl/filecarrierplugin/consumer/HeaderDelimitedTextBlockReader.java
blob: 67b7cb8713056b7a744fec450f1add1f9058022f (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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2020-2021 Nordix Foundation.
 * ================================================================================
 * 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.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Queue;
import java.util.concurrent.LinkedBlockingQueue;
import org.onap.policy.apex.core.infrastructure.threading.ApplicationThreadFactory;
import org.onap.policy.apex.core.infrastructure.threading.ThreadUtilities;
import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolTextTokenDelimitedParameters;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

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

    // The amount of time to wait for input on the text block reader
    private static final long TEXT_BLOCK_DELAY = 250;

    // Tag for the start and end of text blocks
    private final String blockStartToken;
    private final String blockEndToken;

    // Indicates that text block processing starts at the first block of text
    private final boolean delimiterAtStart;
    private boolean blockEndTokenUsed;

    // The thread used to read the text from the stream
    private Thread textConsumputionThread;

    // The input stream for text
    private InputStream inputStream;

    // The lines of input read from the input stream
    private final Queue<String> textLineQueue = new LinkedBlockingQueue<>();

    // True while EOF has not been seen on input
    private boolean eofOnInputStream = false;

    /**
     * Constructor, initialize the text block reader using token delimited event protocol parameters.
     *
     * @param tokenDelimitedParameters
     *        the token delimited event protocol parameters
     */
    public HeaderDelimitedTextBlockReader(final EventProtocolTextTokenDelimitedParameters tokenDelimitedParameters) {
        this(tokenDelimitedParameters.getStartDelimiterToken(), tokenDelimitedParameters.getEndDelimiterToken(),
                        tokenDelimitedParameters.isDelimiterAtStart());
    }

    /**
     * Constructor, initialize the text block reader.
     *
     * @param blockStartToken
     *        the block start token for the start of a text block
     * @param blockEndToken
     *        the block end token for the end of a text block
     * @param delimiterAtStart
     *        indicates that text block processing starts at the first block of text
     */
    public HeaderDelimitedTextBlockReader(final String blockStartToken, final String blockEndToken,
                    final boolean delimiterAtStart) {
        this.blockStartToken = blockStartToken;
        this.delimiterAtStart = delimiterAtStart;

        if (blockEndToken == null) {
            this.blockEndToken = blockStartToken;
            this.blockEndTokenUsed = false;
        } else {
            this.blockEndToken = blockEndToken;
            this.blockEndTokenUsed = true;
        }
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public void init(final InputStream incomingInputStream) {
        this.inputStream = incomingInputStream;

        // Configure and start the text reading thread
        textConsumputionThread = new ApplicationThreadFactory(this.getClass().getName()).newThread(this);
        textConsumputionThread.setDaemon(true);
        textConsumputionThread.start();
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public TextBlock readTextBlock() throws IOException {
        // Holder for the current text block
        final StringBuilder textBlockBuilder = new StringBuilder();

        // Wait for the timeout period if there is no input
        if (!eofOnInputStream && textLineQueue.isEmpty()) {
            ThreadUtilities.sleep(TEXT_BLOCK_DELAY);
        }

        // Scan the lines in the queue
        while (!textLineQueue.isEmpty()) {
            // Scroll down in the available lines looking for the start of the text block
            if (!delimiterAtStart || textLineQueue.peek().startsWith(blockStartToken)) {
                // Process the input line header
                textBlockBuilder.append(textLineQueue.remove());
                textBlockBuilder.append('\n');
                break;
            } else {
                String consumer = textLineQueue.remove();
                LOGGER.warn("invalid input on consumer: {}", consumer);
            }
        }

        // Get the rest of the text document
        while (!textLineQueue.isEmpty() && !textLineQueue.peek().startsWith(blockEndToken)
                        && !textLineQueue.peek().startsWith(blockStartToken)) {
            // We just strip out block end tokens because we use block start tokens to delimit the blocks of text
            textBlockBuilder.append(textLineQueue.remove());
            textBlockBuilder.append('\n');
        }

        // Check if we should add the block end token to the end of the text block
        if (!textLineQueue.isEmpty() && blockEndTokenUsed && textLineQueue.peek().startsWith(blockEndToken)) {
            // Process the input line header
            textBlockBuilder.append(textLineQueue.remove());
            textBlockBuilder.append('\n');
        }

        // Condition the text block and return it
        final String textBlock = textBlockBuilder.toString().trim();
        final boolean endOfText = eofOnInputStream && textLineQueue.isEmpty();

        if (textBlock.length() > 0) {
            return new TextBlock(endOfText, textBlock);
        } else {
            return new TextBlock(endOfText, null);
        }
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public void run() {
        try (BufferedReader textReader = new BufferedReader(new InputStreamReader(inputStream))) {
            // Read the input line by line until we see end of file on the stream
            String line;
            while ((line = textReader.readLine()) != null) {
                textLineQueue.add(line);
            }
        } catch (final IOException e) {
            LOGGER.warn("I/O exception on text input on consumer: ", e);
        } finally {
            eofOnInputStream = true;
        }
    }
}