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
|
/*
* ============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.rest.util;
import java.util.ArrayList;
import java.util.HashMap;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import org.apache.commons.lang3.BooleanUtils;
import org.onap.aai.exceptions.AAIException;
import org.onap.aai.logging.ErrorLogHelper;
import org.onap.aai.restcore.RESTAPI;
import org.onap.aai.tasks.AaiGraphChecker;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
/**
* The Class EchoResponse.
*/
@Component
@Path("/util")
public class EchoResponse extends RESTAPI {
private static final Logger LOGGER = LoggerFactory.getLogger(EchoResponse.class);
private static final String CHECK_DB_STATUS_ACTION = "checkDB";
private static final String CHECK_DB_STATUS_NOW_ACTION = "checkDBNow";
private final AaiGraphChecker aaiGraphChecker;
public EchoResponse(AaiGraphChecker aaiGraphChecker) {
this.aaiGraphChecker = aaiGraphChecker;
}
/**
* Simple health-check API that echos back the X-FromAppId and X-TransactionId to clients.
* If there is a query string, a transaction gets logged into hbase, proving the application is connected to the
* data store.
* If there is no query string, no transacction logging is done to hbase.
*
* @param headers the headers
* @param req the req
* @param myAction if exists will cause transaction to be logged to hbase
* @return the response
*/
@GET
@Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
@Path("/echo")
public Response echoResult(
@Context HttpHeaders headers, @Context HttpServletRequest req, @QueryParam("action") String myAction) {
String fromAppId;
String transId;
try {
fromAppId = getFromAppId(headers);
transId = getTransId(headers);
} catch (AAIException aaiException) {
ArrayList<String> templateVars = new ArrayList<>();
templateVars.add("PUT uebProvider");
templateVars.add("addTopic");
LOGGER.error("Error while getting ids", aaiException);
return generateFailureResponse(headers, templateVars, aaiException);
}
ArrayList<String> templateVars = new ArrayList<>();
templateVars.add(fromAppId);
templateVars.add(transId);
try {
if (CHECK_DB_STATUS_ACTION.equalsIgnoreCase(myAction) ||
CHECK_DB_STATUS_NOW_ACTION.equalsIgnoreCase(myAction)) {
validateDBStatus(myAction);
}
return generateSuccessResponse(headers, templateVars);
} catch (AAIException aaiException) {
LOGGER.error("Error while processing echo request ", aaiException);
return generateFailureResponse(headers, templateVars, aaiException);
} catch (Exception exception) {
AAIException aaiException = new AAIException("AAI_4000", exception);
LOGGER.error("Error while generating echo response", exception);
return generateFailureResponse(headers, templateVars, aaiException);
}
}
/**
* Validates if Janus Graph can process request using AAIGraphChecker.
*
* @param action expected input values 'checkDB' 'checkDBNow'
* @throws AAIException exception thrown if DB is not available
*/
private void validateDBStatus(String action) throws AAIException {
Boolean dbAvailable = null;
if (CHECK_DB_STATUS_ACTION.equalsIgnoreCase(action)) {
dbAvailable = aaiGraphChecker.isAaiGraphDbAvailable(AaiGraphChecker.CheckerType.CACHED);
} else if (CHECK_DB_STATUS_NOW_ACTION.equalsIgnoreCase(action)) {
dbAvailable = aaiGraphChecker.isAaiGraphDbAvailable(AaiGraphChecker.CheckerType.ACTUAL);
} else {
LOGGER.error("Invalid check db action specified to generate echo response: '{}'", action);
}
if (BooleanUtils.isFalse(dbAvailable)) {
throw new AAIException("AAI_5105", "Error establishing a database connection");
}
}
private Response generateSuccessResponse(HttpHeaders headers, ArrayList<String> templateVariables) {
HashMap<AAIException, ArrayList<String>> exceptionList = new HashMap<>();
exceptionList.put(new AAIException("AAI_0002", "OK"), templateVariables);
return Response.status(Status.OK)
.entity(
ErrorLogHelper.getRESTAPIInfoResponse(headers.getAcceptableMediaTypes(), exceptionList)).build();
}
private Response generateFailureResponse(HttpHeaders headers, ArrayList<String> templateVariables,
AAIException aaiException) {
return Response.status(aaiException.getErrorObject().getHTTPResponseCode())
.entity(
ErrorLogHelper.getRESTAPIErrorResponseWithLogging(
headers.getAcceptableMediaTypes(), aaiException, templateVariables))
.build();
}
}
|
