aboutsummaryrefslogtreecommitdiffstats
path: root/aai-core/src/main/java/org/onap/aai/serialization/queryformats/PathedURL.java
blob: e21be9925f7f6f42f3926f528889f7b9fef0c555 (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
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017-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.aai.serialization.queryformats;

import com.google.gson.JsonObject;
import com.google.gson.JsonParser;

import java.util.List;
import java.util.Map;
import java.util.Optional;

import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.onap.aai.db.props.AAIProperties;
import org.onap.aai.exceptions.AAIException;
import org.onap.aai.introspection.Introspector;
import org.onap.aai.introspection.Loader;
import org.onap.aai.introspection.exceptions.AAIUnknownObjectException;
import org.onap.aai.serialization.db.DBSerializer;
import org.onap.aai.serialization.queryformats.exceptions.AAIFormatVertexException;
import org.onap.aai.serialization.queryformats.params.AsTree;
import org.onap.aai.serialization.queryformats.params.Depth;
import org.onap.aai.serialization.queryformats.params.NodesOnly;
import org.onap.aai.serialization.queryformats.utils.UrlBuilder;

import javax.ws.rs.core.MultivaluedMap;

public final class PathedURL extends MultiFormatMapper {

    private final UrlBuilder urlBuilder;
    private final JsonParser parser;
    private final Loader loader;
    private boolean includeUrl = false;

    public PathedURL(Loader loader, UrlBuilder urlBuilder) throws AAIException {
        this.urlBuilder = urlBuilder;
        this.parser = new JsonParser();
        this.loader = loader;
    }

    public PathedURL(Builder builder) {
        this.urlBuilder = builder.getUrlBuilder();
        this.parser = new JsonParser();
        this.loader = builder.getLoader();
        this.isTree = builder.isTree();
        this.includeUrl = builder.isIncludeUrl();
    }

    @Override
    public int parallelThreshold() {
        return 20;
    }

    @Override
    protected Optional<JsonObject> getJsonFromVertex(Vertex v) throws AAIFormatVertexException {

        try {
            final Introspector searchResult = this.loader.introspectorFromName("result-data");

            searchResult.setValue("resource-type", v.value(AAIProperties.NODE_TYPE));

            searchResult.setValue("resource-link", this.urlBuilder.pathed(v));

            if (includeUrl)
                searchResult.setValue("resource-version", v.value(AAIProperties.RESOURCE_VERSION));

            final String json = searchResult.marshal(false);
            return Optional.of(this.parser.parse(json).getAsJsonObject());

        } catch (AAIUnknownObjectException e) {
            throw new RuntimeException("Fatal error - result-data does not exist!", e);
        }

    }

    @Override
    protected Optional<JsonObject> getJsonFromVertex(Vertex input, Map<String, List<String>> properties) throws AAIFormatVertexException {
        return Optional.empty();
    }

    public static class Builder implements NodesOnly<Builder>, Depth<Builder>, AsTree<Builder> {

        private final Loader loader;
        private final DBSerializer serializer;
        private final UrlBuilder urlBuilder;
        private boolean includeUrl = false;
        private boolean nodesOnly = false;
        private int depth = 1;
        private MultivaluedMap<String, String> params;
        private boolean tree = false;

        public Builder(Loader loader, DBSerializer serializer, UrlBuilder urlBuilder) {
            this.loader = loader;
            this.serializer = serializer;
            this.urlBuilder = urlBuilder;
        }

        public Builder(Loader loader, DBSerializer serializer, UrlBuilder urlBuilder, MultivaluedMap<String, String> params) {
            this.loader = loader;
            this.serializer = serializer;
            this.urlBuilder = urlBuilder;
            this.params = params;
        }

        protected Loader getLoader() {
            return this.loader;
        }

        protected DBSerializer getSerializer() {
            return this.serializer;
        }

        protected UrlBuilder getUrlBuilder() {
            return this.urlBuilder;
        }

        protected MultivaluedMap<String, String> getParams() { return this.params; }

        public boolean isSkipRelatedTo() {
            if (params != null) {
                boolean isSkipRelatedTo = true;
                if (params.containsKey("skip-related-to")) {
                    String skipRelatedTo = params.getFirst("skip-related-to");
                    isSkipRelatedTo = !(skipRelatedTo != null && skipRelatedTo.equals("false"));
                } else {
                    // if skip-related-to param is missing, then default it to false;
                    isSkipRelatedTo = false;
                }
                return isSkipRelatedTo;
            }
            return true;
        }

        protected boolean isTree() { return this.tree; }

        public Builder isTree(Boolean tree) {
            this.tree = tree;
            return this;
        }

        public Builder includeUrl() {
            this.includeUrl = true;
            return this;
        }

        public Builder nodesOnly(Boolean nodesOnly) {
            this.nodesOnly = nodesOnly;
            return this;
        }

        public boolean isNodesOnly() {
            return this.nodesOnly;
        }

        public Builder depth(Integer depth) {
            this.depth = depth;
            return this;
        }

        public int getDepth() {
            return this.depth;
        }

        public boolean isIncludeUrl() {
            return this.includeUrl;
        }

        public PathedURL build() throws AAIException {
            return new PathedURL(this);
        }
    }

}