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
|
/*
* ============LICENSE_START===================================================
* Copyright (c) 2018 Amdocs
* ============================================================================
* 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.pomba.contextbuilder.networkdiscovery.service.rs;
import com.google.gson.ExclusionStrategy;
import com.google.gson.FieldAttributes;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import java.util.UUID;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import org.onap.pomba.common.datatypes.ModelContext;
import org.onap.pomba.common.datatypes.VFModule;
import org.onap.pomba.contextbuilder.networkdiscovery.exception.DiscoveryException;
import org.onap.pomba.contextbuilder.networkdiscovery.exception.ErrorMessage;
import org.onap.pomba.contextbuilder.networkdiscovery.service.SpringService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
public class RestServiceImpl implements RestService {
private static Logger log = LoggerFactory.getLogger(RestService.class);
private static final String EMPTY_JSON_OBJECT = "{}";
private static final String HEADER_REQUEST_ID = "X-ONAP-RequestID";
@Autowired
private SpringService service;
/**
* Certain attributes in the common model do not apply (are not available) from network discovery.
* This exclusion strategy will make sure that any defaulted attributes that are not available/not valid are
* excluded from the json response.
*
* For now, there a two known attributes that need to be excluded from the VFModule:
* - minInstances (because it's an integer that defaults to zero)
* - maxInstances (because it's an integer that defaults to zero)
*/
public class ContextBuilderExclusionStrategy implements ExclusionStrategy {
public boolean shouldSkipClass(Class<?> arg0) {
return false;
}
public boolean shouldSkipField(FieldAttributes f) {
return (f.getDeclaringClass() == VFModule.class && f.getName().equals("minInstances"))
|| (f.getDeclaringClass() == VFModule.class && f.getName().equals("maxInstances"));
}
}
@Override
public Response getContext(HttpServletRequest req, String authorization, String partnerName, String requestId,
String fromAppId, String transactionId, String serviceInstanceId, String modelVersionId,
String modelInvariantId) throws DiscoveryException {
// Do some validation on Http headers and URL parameters
// The request ID in the header is not yet standardized to X-ONAP-RequestID. We
// would still support X-TransactionId until further notice.
if (requestId == null || requestId.isEmpty()) {
if (transactionId != null) {
requestId = transactionId;
} else {
requestId = UUID.randomUUID().toString();
log.debug("{} is missing; using newly generated value: {}", HEADER_REQUEST_ID, requestId);
}
}
// The partner name in the header is not yet standardized to X-PartnerName. We
// would still support X-FromAppId until further notice.
if (partnerName == null || partnerName.isEmpty()) {
if (fromAppId != null) {
partnerName = fromAppId;
}
}
try {
ModelContext sdContext = service.getContext(req, partnerName, authorization, requestId, serviceInstanceId,
modelVersionId, modelInvariantId);
if (sdContext == null) {
// Return empty JSON
return Response.ok().entity(EMPTY_JSON_OBJECT).build();
} else {
GsonBuilder gsonBuilder = new GsonBuilder();
gsonBuilder.setExclusionStrategies(new ContextBuilderExclusionStrategy());
Gson gson = gsonBuilder.create();
return Response.ok().entity(gson.toJson(sdContext)).build();
}
} catch (DiscoveryException x) {
log.warn(ErrorMessage.CONTEXT_BUILDER_FAILED, x);
return Response.status(x.getHttpStatus()).entity(x.getMessage()).build();
} catch (Exception x) {
log.error(ErrorMessage.CONTEXT_BUILDER_FAILED, x);
return Response.status(Status.INTERNAL_SERVER_ERROR).entity(x.getMessage()).build();
} finally {
MDC.clear();
}
}
}
|
