aboutsummaryrefslogtreecommitdiffstats
path: root/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/event/comm/bus/TopicPropertyBuilder.java
blob: 4982d11d67898a19311442fe10fa37c50fb65cf4 (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
/*
 * ============LICENSE_START=======================================================
 * ONAP Policy Engine - Common Modules
 * ================================================================================
 * Copyright (C) 2018 AT&T Intellectual Property. 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.
 * ============LICENSE_END=========================================================
 */

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

import java.util.Properties;

/**
 * Builder of properties used when configuring topics.
 */
public class TopicPropertyBuilder {
    private final Properties properties = new Properties();
    private final String prefix;
    private String topicPrefix;

    /**
     * Constructs the object.
     *
     * @param prefix the prefix for the properties to be built
     */
    public TopicPropertyBuilder(String prefix) {
        this.prefix = prefix;
        properties.setProperty(prefix, "");
    }

    /**
     * Constructs the properties from the builder.
     *
     * @return a copy of the properties
     */
    public Properties build() {
        Properties props = new Properties();
        props.putAll(properties);

        return props;
    }

    /**
     * Adds a topic to the list of topics. Also sets the current topic so that subsequent
     * invocations of property methods will manipulate the topic's properties.
     *
     * @param topic the topic to be added
     * @return this builder
     */
    public TopicPropertyBuilder addTopic(String topic) {
        // add topic to the list of topics
        String topicList = properties.getProperty(prefix);
        if (!topicList.isEmpty()) {
            topicList += ",";
        }
        topicList += topic;
        properties.setProperty(prefix, topicList);

        setTopic(topic);

        return this;
    }

    /**
     * Sets the topic for which subsequent properties will be managed.
     *
     * @param topic the topic
     * @return this builder
     */
    public TopicPropertyBuilder setTopic(String topic) {
        this.topicPrefix = prefix + "." + topic;
        return this;
    }

    /**
     * Sets a topic's property.
     *
     * @param name name of the property
     * @param value value to which the property should be set
     * @return this builder
     */
    public TopicPropertyBuilder setTopicProperty(String name, Object value) {
        properties.setProperty(topicPrefix + name, value.toString());
        return this;
    }

    /**
     * Removes a topic's property.
     *
     * @param name name of the property
     * @return this builder
     */
    public TopicPropertyBuilder removeTopicProperty(String name) {
        properties.remove(topicPrefix + name);
        return this;
    }
}