aboutsummaryrefslogtreecommitdiffstats
path: root/dcae-analytics-cdap-plugins/src/main/java/org/openecomp/dcae/apod/analytics/cdap/plugins/domain/config/dmaap/BaseDMaaPMRPluginConfig.java
blob: b85dc7d1c73a18860e34f3366672e5076f93fe13 (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
/*
 * ===============================LICENSE_START======================================
 *  dcae-analytics
 * ================================================================================
 *    Copyright © 2017 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.openecomp.dcae.apod.analytics.cdap.plugins.domain.config.dmaap;

import co.cask.cdap.api.annotation.Description;
import co.cask.cdap.api.annotation.Macro;
import com.google.common.base.Objects;
import org.openecomp.dcae.apod.analytics.cdap.common.settings.CDAPBasePluginConfig;

import javax.annotation.Nullable;

/**
 * Base class for all DMaaP MR Configs
 * <p>
 * @author Rajiv Singla . Creation Date: 1/17/2017.
 */
public abstract class BaseDMaaPMRPluginConfig extends CDAPBasePluginConfig {

    @Description("DMaaP Message Router HostName")
    @Macro
    protected String hostName;

    @Description("DMaaP Message Router Host Port number. Defaults to Port 80")
    @Nullable
    @Macro
    protected Integer portNumber;

    @Description("DMaaP Message Router Topic Name")
    @Macro
    protected String topicName;

    @Description("DMaaP Message Router HTTP Protocol e.g. HTTP or HTTPS. Defaults to HTTPS")
    @Nullable
    @Macro
    protected String protocol;

    @Description("DMaaP Message Router User Name used for AAF Authentication. Defaults to no authentication")
    @Nullable
    @Macro
    protected String userName;

    @Description("DMaaP Message Router User Password used for AAF Authentication. Defaults to no authentication")
    @Nullable
    @Macro
    protected String userPassword;

    @Description("DMaaP Message Router Content Type. Defaults to 'application/json'")
    @Nullable
    @Macro
    protected String contentType;


    public BaseDMaaPMRPluginConfig(final String referenceName, final String hostName, final String topicName) {
        this.referenceName = referenceName;
        this.hostName = hostName;
        this.topicName = topicName;
    }

    /**
     * Host Name for DMaaP MR Publisher or Subscriber
     *
     * @return host name
     */
    public String getHostName() {
        return hostName;
    }

    /**
     * Port Number for DMaaP MR Publisher or Subscriber
     *
     * @return port number
     */
    @Nullable
    public Integer getPortNumber() {
        return portNumber;
    }

    /**
     * DMaaP MR Topic Name for Subscriber or Publisher
     *
     * @return topic name
     */
    public String getTopicName() {
        return topicName;
    }


    /**
     * DMaaP MR HTTP or HTTPS protocol
     *
     * @return http or https protocol
     */
    @Nullable
    public String getProtocol() {
        return protocol;
    }

    /**
     * User name used for DMaaP MR AAF Authentication
     *
     * @return User name for DMaaP MR AAF Authentication
     */
    @Nullable
    public String getUserName() {
        return userName;
    }

    /**
     * User password used for DMaaP MR AAF Authentication
     *
     * @return User password used for DMaaP MR AAF Authentication
     */
    @Nullable
    public String getUserPassword() {
        return userPassword;
    }

    /**
     * Content type used for DMaaP MR Topic e.g. 'application/json'
     *
     * @return content type for DMaaP MR Topic
     */
    @Nullable
    public String getContentType() {
        return contentType;
    }

    @Override
    public String toString() {
        return Objects.toStringHelper(this)
                .add("referenceName", referenceName)
                .add("hostName", hostName)
                .add("portNumber", portNumber)
                .add("topicName", topicName)
                .add("protocol", protocol)
                .add("userName", userName)
                .add("userPassword", "xxxx")
                .add("contentType", contentType)
                .toString();
    }
}