summaryrefslogtreecommitdiffstats
path: root/aai-traversal/src/main/java/org/onap/aai/interceptors/post/ResponseTransactionLogging.java
blob: 854eeed9bd534efb42df4f360b4981bf2dee95e5 (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
/**
 * ============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.interceptors.post;

import com.google.gson.JsonObject;

import java.io.IOException;
import java.util.*;

import javax.annotation.Priority;
import javax.servlet.http.HttpServletResponse;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerResponseContext;
import javax.ws.rs.container.ContainerResponseFilter;
import javax.ws.rs.core.PathSegment;

import org.onap.aai.exceptions.AAIException;
import org.onap.aai.interceptors.AAIContainerFilter;
import org.onap.aai.interceptors.AAIHeaderProperties;
import org.onap.aai.logging.ErrorLogHelper;
import org.onap.aai.util.AAIConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;

@Priority(AAIResponseFilterPriority.RESPONSE_TRANS_LOGGING)
public class ResponseTransactionLogging extends AAIContainerFilter
    implements ContainerResponseFilter {

    private static final Logger TRANSACTION_LOGGER =
        LoggerFactory.getLogger(ResponseTransactionLogging.class);

    private final static String QUERY_API_PATH_SEGMENT = "query";
    private final static String NODES_QUERY_API_PATH_SEGMENT = "nodes-query";
    private final static String GENERIC_QUERY_API_PATH_SEGMENT = "generic-query";
    private final static String DSL_API_PATH_SEGMENT = "dsl";
    private final static String RECENTS_API_PATH_SEGMENT = "recents";
    private final static Set<String> READ_ONLY_QUERIES = getReadOnlyQueries();

    @Autowired
    private HttpServletResponse httpServletResponse;

    @Override
    public void filter(ContainerRequestContext requestContext,
        ContainerResponseContext responseContext) throws IOException {

        this.transLogging(requestContext, responseContext);

    }

    private void transLogging(ContainerRequestContext requestContext,
        ContainerResponseContext responseContext) {

        String logValue;
        String isGetTransactionResponseLoggingEnabled;
        String postValue;

        try {

            logValue = AAIConfig.get("aai.transaction.logging");
            isGetTransactionResponseLoggingEnabled = AAIConfig.get("aai.transaction.logging.get");
            postValue = AAIConfig.get("aai.transaction.logging.post");
        } catch (AAIException e) {
            return;
        }

        String transId = requestContext.getHeaderString(AAIHeaderProperties.TRANSACTION_ID);
        String fromAppId = requestContext.getHeaderString(AAIHeaderProperties.FROM_APP_ID);
        String fullUri = requestContext.getUriInfo().getRequestUri().toString();
        String requestTs = (String) requestContext.getProperty(AAIHeaderProperties.AAI_REQUEST_TS);

        String httpMethod = requestContext.getMethod();

        String status = Integer.toString(responseContext.getStatus());

        String request = (String) requestContext.getProperty(AAIHeaderProperties.AAI_REQUEST);
        String response = this.getResponseString(responseContext);

        if (!Boolean.parseBoolean(logValue)) {
        } else if (!Boolean.parseBoolean(postValue) && "POST".equals(httpMethod)) {
        } else {

            JsonObject logEntry = new JsonObject();
            logEntry.addProperty("transactionId", transId);
            logEntry.addProperty("status", status);
            logEntry.addProperty("rqstDate", requestTs);
            logEntry.addProperty("respDate", this.genDate());
            logEntry.addProperty("sourceId", fromAppId + ":" + transId);
            logEntry.addProperty("resourceId", fullUri);
            logEntry.addProperty("resourceType", httpMethod);
            logEntry.addProperty("rqstBuf", Objects.toString(request, ""));

            boolean recordResponse = true;
            if (!Boolean.parseBoolean(isGetTransactionResponseLoggingEnabled)
                && "GET".equals(httpMethod)) {
                recordResponse = false;
            } else {
                /**
                 * Parse the uri path and see if it is a read-only query
                 * If it is, do not record the response in the logs
                 */

                List<PathSegment> pathSegmentList = requestContext.getUriInfo().getPathSegments();
                for (PathSegment queryType : pathSegmentList) {
                    if (READ_ONLY_QUERIES.contains(queryType.toString())) {
                        recordResponse = false;
                    }
                }

                if (recordResponse) {
                    logEntry.addProperty("respBuf", Objects.toString(response, ""));
                }

                try {
                    TRANSACTION_LOGGER.debug(logEntry.toString());
                } catch (Exception e) {
                    ErrorLogHelper.logError("AAI_4000", "Exception writing transaction log.");
                }
            }
        }

    }

    private String getResponseString(ContainerResponseContext responseContext) {
        JsonObject response = new JsonObject();
        response.addProperty("ID", responseContext.getHeaderString(AAIHeaderProperties.AAI_TX_ID));
        response.addProperty("Content-Type", this.httpServletResponse.getContentType());
        response.addProperty("Response-Code", responseContext.getStatus());
        response.addProperty("Headers", responseContext.getHeaders().toString());
        Optional<Object> entityOptional = Optional.ofNullable(responseContext.getEntity());
        if (entityOptional.isPresent()) {
            response.addProperty("Entity", entityOptional.get().toString());
        } else {
            response.addProperty("Entity", "");
        }
        return response.toString();
    }

    private static Set<String> getReadOnlyQueries() {
        Set<String> readOnlyQueries = new HashSet<String>();
        readOnlyQueries.add(NODES_QUERY_API_PATH_SEGMENT);
        readOnlyQueries.add(GENERIC_QUERY_API_PATH_SEGMENT);
        readOnlyQueries.add(RECENTS_API_PATH_SEGMENT);
        readOnlyQueries.add(QUERY_API_PATH_SEGMENT);
        readOnlyQueries.add(DSL_API_PATH_SEGMENT);
        return readOnlyQueries;
    }

}