aboutsummaryrefslogtreecommitdiffstats
path: root/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineBusTopicSink.java
blob: dfdc7b3cc65dcfff0f6b5cccee8324f98643f81f (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
/*
 * ============LICENSE_START=======================================================
 * policy-endpoints
 * ================================================================================
 * Copyright (C) 2017-2021 AT&T Intellectual Property. All rights reserved.
 * Modifications Copyright (C) 2018-2019 Samsung Electronics Co., Ltd.
 * Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
 * Modifications Copyright (C) 2023-2024 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.common.endpoints.event.comm.bus.internal;

import java.util.UUID;
import lombok.Getter;
import lombok.Setter;
import org.onap.policy.common.endpoints.event.comm.bus.BusTopicSink;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Transport Agnostic Bus Topic Sink to carry out the core functionality to interact with a sink
 * regardless if it is UEB or Kafka.
 *
 */
public abstract class InlineBusTopicSink extends BusTopicBase implements BusTopicSink {

    /**
     * Loggers.
     */
    private static Logger logger = LoggerFactory.getLogger(InlineBusTopicSink.class);

    /**
     * The partition key to publish to.
     */
    @Getter
    @Setter
    protected String partitionKey;

    /**
     * Message bus publisher.
     */
    protected BusPublisher publisher;

    /**
     * Constructor for abstract sink.
     * @param busTopicParams contains below listed attributes
     *     servers servers
     *     topic topic
     *     apiKey api secret
     *     apiSecret api secret
     *     partitionId partition id
     *     useHttps does connection use HTTPS?
     *     allowTracing is tracing allowed?
     *     allowSelfSignedCerts are self-signed certificates allow     *
     * @throws IllegalArgumentException if invalid parameters are passed in
     */
    protected InlineBusTopicSink(BusTopicParams busTopicParams) {

        super(busTopicParams);

        if (busTopicParams.isPartitionIdInvalid()) {
            this.partitionKey = UUID.randomUUID().toString();
        } else {
            this.partitionKey = busTopicParams.getPartitionId();
        }
    }

    /**
     * Initialize the Bus publisher.
     */
    public abstract void init();

    @Override
    public boolean start() {
        logger.info("{}: starting", this);

        synchronized (this) {
            if (!this.alive) {
                if (locked) {
                    throw new IllegalStateException(this + " is locked.");
                }

                this.init();
                this.alive = true;
            }
        }

        return true;
    }

    @Override
    public boolean stop() {

        BusPublisher publisherCopy;
        synchronized (this) {
            this.alive = false;
            publisherCopy = this.publisher;
            this.publisher = null;
        }

        if (publisherCopy != null) {
            try {
                publisherCopy.close();
            } catch (Exception e) {
                logger.warn("{}: cannot stop publisher because of {}", this, e.getMessage(), e);
            }
        } else {
            logger.warn("{}: there is no publisher", this);
            return false;
        }

        return true;
    }

    @Override
    public boolean send(String message) {

        if (message == null || message.isEmpty()) {
            throw new IllegalArgumentException("Message to send is empty");
        }

        if (!this.alive) {
            throw new IllegalStateException(this + " is stopped");
        }

        try {
            synchronized (this) {
                this.recentEvents.add(message);
            }

            NetLoggerUtil.log(EventType.OUT, this.getTopicCommInfrastructure(), this.topic, message);

            publisher.send(this.partitionKey, message);
            broadcast(message);
        } catch (Exception e) {
            logger.warn("{}: cannot send because of {}", this, e.getMessage(), e);
            return false;
        }

        return true;
    }

    @Override
    public void shutdown() {
        this.stop();
    }

    @Override
    public String toString() {
        return "InlineBusTopicSink [partitionId=" + partitionKey + ", alive=" + alive + ", publisher=" + publisher
                        + "]";
    }
}