aboutsummaryrefslogtreecommitdiffstats
path: root/datarouter-node/src/main/java/org/onap/dmaap/datarouter/node/ProvData.java
blob: 2c2058047e581b8f292642b151dc5a2606f6e19b (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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
/*******************************************************************************
 * ============LICENSE_START==================================================
 * * org.onap.dmaap
 * * ===========================================================================
 * * 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====================================================
 * *
 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 * *
 ******************************************************************************/


package org.onap.dmaap.datarouter.node;

import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;
import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import org.jetbrains.annotations.Nullable;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.json.JSONTokener;
import org.onap.dmaap.datarouter.node.NodeConfig.ProvFeed;
import org.onap.dmaap.datarouter.node.NodeConfig.ProvFeedSubnet;
import org.onap.dmaap.datarouter.node.NodeConfig.ProvFeedUser;
import org.onap.dmaap.datarouter.node.NodeConfig.ProvForceEgress;
import org.onap.dmaap.datarouter.node.NodeConfig.ProvForceIngress;
import org.onap.dmaap.datarouter.node.NodeConfig.ProvHop;
import org.onap.dmaap.datarouter.node.NodeConfig.ProvNode;
import org.onap.dmaap.datarouter.node.NodeConfig.ProvParam;
import org.onap.dmaap.datarouter.node.NodeConfig.ProvSubscription;
import org.onap.dmaap.datarouter.node.eelf.EelfMsgs;

/**
 * Parser for provisioning data from the provisioning server.
 *
 * <p>The ProvData class uses a Reader for the text configuration from the provisioning server to construct arrays of
 * raw configuration entries.
 */
public class ProvData {

    private static final String FEED_ID = "feedid";

    private static EELFLogger eelfLogger = EELFManager.getInstance().getLogger(ProvData.class);
    private NodeConfig.ProvNode[] pn;
    private NodeConfig.ProvParam[] pp;
    private NodeConfig.ProvFeed[] pf;
    private NodeConfig.ProvFeedUser[] pfu;
    private NodeConfig.ProvFeedSubnet[] pfsn;
    private NodeConfig.ProvSubscription[] ps;
    private NodeConfig.ProvForceIngress[] pfi;
    private NodeConfig.ProvForceEgress[] pfe;
    private NodeConfig.ProvHop[] ph;

    /**
     * Construct raw provisioing data entries from the text (JSON) provisioning document received from the provisioning
     * server.
     *
     * @param reader The reader for the JSON text.
     */
    public ProvData(Reader reader) throws IOException {
        ArrayList<ProvNode> pnv = new ArrayList<>();
        ArrayList<NodeConfig.ProvParam> ppv = new ArrayList<>();
        ArrayList<NodeConfig.ProvFeed> pfv = new ArrayList<>();
        ArrayList<NodeConfig.ProvFeedUser> pfuv = new ArrayList<>();
        ArrayList<NodeConfig.ProvFeedSubnet> pfsnv = new ArrayList<>();
        ArrayList<NodeConfig.ProvSubscription> psv = new ArrayList<>();
        ArrayList<NodeConfig.ProvForceIngress> pfiv = new ArrayList<>();
        ArrayList<NodeConfig.ProvForceEgress> pfev = new ArrayList<>();
        ArrayList<NodeConfig.ProvHop> phv = new ArrayList<>();
        try {
            JSONTokener jtx = new JSONTokener(reader);
            JSONObject jcfg = new JSONObject(jtx);
            char cch = jtx.nextClean();
            if (cch != '\0') {
                throw new JSONException("Spurious characters following configuration");
            }
            reader.close();
            addJSONFeeds(pfv, pfuv, pfsnv, jcfg);
            addJSONSubs(psv, jcfg);
            addJSONParams(pnv, ppv, jcfg);
            addJSONRoutingInformation(pfiv, pfev, phv, jcfg);
        } catch (JSONException jse) {
            NodeUtils.setIpAndFqdnForEelf("ProvData");
            eelfLogger.error(EelfMsgs.MESSAGE_PARSING_ERROR, jse.toString());
            eelfLogger
                    .error("NODE0201 Error parsing configuration data from provisioning server " + jse.toString(), jse);
            throw new IOException(jse.toString(), jse);
        }
        pn = pnv.toArray(new NodeConfig.ProvNode[pnv.size()]);
        pp = ppv.toArray(new NodeConfig.ProvParam[ppv.size()]);
        pf = pfv.toArray(new NodeConfig.ProvFeed[pfv.size()]);
        pfu = pfuv.toArray(new NodeConfig.ProvFeedUser[pfuv.size()]);
        pfsn = pfsnv.toArray(new NodeConfig.ProvFeedSubnet[pfsnv.size()]);
        ps = psv.toArray(new NodeConfig.ProvSubscription[psv.size()]);
        pfi = pfiv.toArray(new NodeConfig.ProvForceIngress[pfiv.size()]);
        pfe = pfev.toArray(new NodeConfig.ProvForceEgress[pfev.size()]);
        ph = phv.toArray(new NodeConfig.ProvHop[phv.size()]);
    }

    private static String[] gvasa(JSONObject object, String key) {
        return (gvasa(object.opt(key)));
    }

    private static String[] gvasa(Object object) {
        if (object instanceof JSONArray) {
            JSONArray jsonArray = (JSONArray) object;
            ArrayList<String> array = new ArrayList<>();
            for (int i = 0; i < jsonArray.length(); i++) {
                String string = gvas(jsonArray, i);
                if (string != null) {
                    array.add(string);
                }
            }
            return (array.toArray(new String[array.size()]));
        } else {
            String string = gvas(object);
            if (string == null) {
                return (new String[0]);
            } else {
                return (new String[]{string});
            }
        }
    }

    private static String gvas(JSONArray array, int index) {
        return (gvas(array.get(index)));
    }

    private static String gvas(JSONObject object, String key) {
        return (gvas(object.opt(key)));
    }

    private static String gvas(Object object) {
        if (object instanceof Boolean || object instanceof Number || object instanceof String) {
            return (object.toString());
        }
        return (null);
    }

    /**
     * Get the raw node configuration entries.
     */
    public NodeConfig.ProvNode[] getNodes() {
        return (pn);
    }

    /**
     * Get the raw parameter configuration entries.
     */
    public NodeConfig.ProvParam[] getParams() {
        return (pp);
    }

    /**
     * Ge the raw feed configuration entries.
     */
    public NodeConfig.ProvFeed[] getFeeds() {
        return (pf);
    }

    /**
     * Get the raw feed user configuration entries.
     */
    public NodeConfig.ProvFeedUser[] getFeedUsers() {
        return (pfu);
    }

    /**
     * Get the raw feed subnet configuration entries.
     */
    public NodeConfig.ProvFeedSubnet[] getFeedSubnets() {
        return (pfsn);
    }

    /**
     * Get the raw subscription entries.
     */
    public NodeConfig.ProvSubscription[] getSubscriptions() {
        return (ps);
    }

    /**
     * Get the raw forced ingress entries.
     */
    public NodeConfig.ProvForceIngress[] getForceIngress() {
        return (pfi);
    }

    /**
     * Get the raw forced egress entries.
     */
    public NodeConfig.ProvForceEgress[] getForceEgress() {
        return (pfe);
    }

    /**
     * Get the raw next hop entries.
     */
    public NodeConfig.ProvHop[] getHops() {
        return (ph);
    }

    @Nullable
    private String getFeedStatus(JSONObject jfeed) {
        String stat = null;
        if (jfeed.optBoolean("suspend", false)) {
            stat = "Feed is suspended";
        }
        if (jfeed.optBoolean("deleted", false)) {
            stat = "Feed is deleted";
        }
        return stat;
    }

    private void addJSONFeeds(ArrayList<ProvFeed> pfv, ArrayList<ProvFeedUser> pfuv, ArrayList<ProvFeedSubnet> pfsnv,
            JSONObject jcfg) {
        JSONArray jfeeds = jcfg.optJSONArray("feeds");
        if (jfeeds != null) {
            for (int fx = 0; fx < jfeeds.length(); fx++) {
                addJSONFeed(pfv, pfuv, pfsnv, jfeeds, fx);
            }
        }
    }

    private void addJSONFeed(ArrayList<ProvFeed> pfv, ArrayList<ProvFeedUser> pfuv, ArrayList<ProvFeedSubnet> pfsnv,
            JSONArray jfeeds, int fx) {
        JSONObject jfeed = jfeeds.getJSONObject(fx);
        String stat = getFeedStatus(jfeed);
        String fid = gvas(jfeed, FEED_ID);
        String fname = gvas(jfeed, "name");
        String fver = gvas(jfeed, "version");
        String createdDate = gvas(jfeed, "created_date");
        /*
         * START - AAF changes
         * TDP EPIC US# 307413
         * Passing aafInstance to ProvFeed from feeds json passed by prov to identify legacy/AAF feeds
         */
        String aafInstance = gvas(jfeed, "aaf_instance");
        pfv.add(new ProvFeed(fid, fname + "//" + fver, stat, createdDate, aafInstance));
        /*
         * END - AAF changes
         */
        addJSONFeedAuthArrays(pfuv, pfsnv, jfeed, fid);
    }

    private void addJSONFeedAuthArrays(ArrayList<ProvFeedUser> pfuv, ArrayList<ProvFeedSubnet> pfsnv, JSONObject jfeed,
            String fid) {
        JSONObject jauth = jfeed.optJSONObject("authorization");
        if (jauth == null) {
            return;
        }
        JSONArray jeids = jauth.optJSONArray("endpoint_ids");
        if (jeids != null) {
            for (int ux = 0; ux < jeids.length(); ux++) {
                JSONObject ju = jeids.getJSONObject(ux);
                String login = gvas(ju, "id");
                String password = gvas(ju, "password");
                pfuv.add(new ProvFeedUser(fid, login, NodeUtils.getAuthHdr(login, password)));
            }
        }
        JSONArray jeips = jauth.optJSONArray("endpoint_addrs");
        if (jeips != null) {
            for (int ix = 0; ix < jeips.length(); ix++) {
                String sn = gvas(jeips, ix);
                pfsnv.add(new ProvFeedSubnet(fid, sn));
            }
        }
    }

    private void addJSONSubs(ArrayList<ProvSubscription> psv, JSONObject jcfg) {
        JSONArray jsubs = jcfg.optJSONArray("subscriptions");
        if (jsubs != null) {
            for (int sx = 0; sx < jsubs.length(); sx++) {
                addJSONSub(psv, jsubs, sx);
            }
        }
    }

    private void addJSONSub(ArrayList<ProvSubscription> psv, JSONArray jsubs, int sx) {
        JSONObject jsub = jsubs.getJSONObject(sx);
        if (jsub.optBoolean("suspend", false)) {
            return;
        }
        String sid = gvas(jsub, "subid");
        String fid = gvas(jsub, FEED_ID);
        JSONObject jdel = jsub.getJSONObject("delivery");
        String delurl = gvas(jdel, "url");
        String id = gvas(jdel, "user");
        String password = gvas(jdel, "password");
        boolean monly = jsub.getBoolean("metadataOnly");
        boolean use100 = jdel.getBoolean("use100");
        boolean privilegedSubscriber = jsub.getBoolean("privilegedSubscriber");
        boolean decompress = jsub.getBoolean("decompress");
        boolean followRedirect = jsub.getBoolean("follow_redirect");
        psv.add(new ProvSubscription(sid, fid, delurl, id, NodeUtils.getAuthHdr(id, password), monly, use100,
                privilegedSubscriber, followRedirect, decompress));
    }

    private void addJSONParams(ArrayList<ProvNode> pnv, ArrayList<ProvParam> ppv, JSONObject jcfg) {
        JSONObject jparams = jcfg.optJSONObject("parameters");
        if (jparams != null) {
            for (String pname : JSONObject.getNames(jparams)) {
                addJSONParam(ppv, jparams, pname);
            }
            addJSONNodesToParams(pnv, jparams);
        }
    }

    private void addJSONParam(ArrayList<ProvParam> ppv, JSONObject jparams, String pname) {
        String pvalue = gvas(jparams, pname);
        if (pvalue != null) {
            ppv.add(new ProvParam(pname, pvalue));
        }
    }

    private void addJSONNodesToParams(ArrayList<ProvNode> pnv, JSONObject jparams) {
        String sfx = gvas(jparams, "PROV_DOMAIN");
        JSONArray jnodes = jparams.optJSONArray("NODES");
        if (jnodes != null) {
            for (int nx = 0; nx < jnodes.length(); nx++) {
                String nn = gvas(jnodes, nx);
                if (nn == null) {
                    continue;
                }
                if (nn.indexOf('.') == -1) {
                    nn = nn + "." + sfx;
                }
                pnv.add(new ProvNode(nn));
            }
        }
    }

    private void addJSONRoutingInformation(ArrayList<ProvForceIngress> pfiv, ArrayList<ProvForceEgress> pfev,
            ArrayList<ProvHop> phv, JSONObject jcfg) {
        JSONArray jingresses = jcfg.optJSONArray("ingress");
        if (jingresses != null) {
            for (int fx = 0; fx < jingresses.length(); fx++) {
                addJSONIngressRoute(pfiv, jingresses, fx);
            }
        }
        JSONObject jegresses = jcfg.optJSONObject("egress");
        if (jegresses != null && JSONObject.getNames(jegresses) != null) {
            for (String esid : JSONObject.getNames(jegresses)) {
                addJSONEgressRoute(pfev, jegresses, esid);
            }
        }
        JSONArray jhops = jcfg.optJSONArray("routing");
        if (jhops != null) {
            for (int fx = 0; fx < jhops.length(); fx++) {
                addJSONRoutes(phv, jhops, fx);
            }
        }
    }

    private void addJSONIngressRoute(ArrayList<ProvForceIngress> pfiv, JSONArray jingresses, int fx) {
        JSONObject jingress = jingresses.getJSONObject(fx);
        String fid = gvas(jingress, FEED_ID);
        String subnet = gvas(jingress, "subnet");
        String user = gvas(jingress, "user");
        if (fid == null || "".equals(fid)) {
            return;
        }
        if ("".equals(subnet)) {
            subnet = null;
        }
        if ("".equals(user)) {
            user = null;
        }
        String[] nodes = gvasa(jingress, "node");
        pfiv.add(new ProvForceIngress(fid, subnet, user, nodes));
    }

    private void addJSONEgressRoute(ArrayList<ProvForceEgress> pfev, JSONObject jegresses, String esid) {
        String enode = gvas(jegresses, esid);
        if (esid != null && enode != null && !"".equals(esid) && !"".equals(enode)) {
            pfev.add(new ProvForceEgress(esid, enode));
        }
    }

    private void addJSONRoutes(ArrayList<ProvHop> phv, JSONArray jhops, int fx) {
        JSONObject jhop = jhops.getJSONObject(fx);
        String from = gvas(jhop, "from");
        String to = gvas(jhop, "to");
        String via = gvas(jhop, "via");
        if (from == null || to == null || via == null || "".equals(from) || "".equals(to) || "".equals(via)) {
            return;
        }
        phv.add(new ProvHop(from, to, via));
    }
}