summaryrefslogtreecommitdiffstats
path: root/catalog-fe/src/main/java/org/openecomp/sdc/fe/servlets/LoggingServlet.java
blob: 4bcbaa531b921b9488b49876ad36664569f852a3 (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
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2019 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.openecomp.sdc.fe.servlets;

import org.openecomp.sdc.common.servlets.BasicServlet;
import org.openecomp.sdc.fe.impl.LogHandler;

import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.core.Response;

public abstract class LoggingServlet extends BasicServlet {

    public static final String UUID = "uuid";
    public static final String TRANSACTION_START_TIME = "transactionStartTime";

    /**
     * log incoming requests
     * @param httpRequest the http request
     */
    void logFeRequest(HttpServletRequest httpRequest){
        LogHandler.logFeRequest(httpRequest);
        inHttpRequest(httpRequest);
    }

    /**
     * log response
     * @param request orig request
     * @param response returned response
     */
    void logFeResponse(HttpServletRequest request, Response response) {
        LogHandler.logFeResponse(request);
        outHttpResponse(response);
    }

    /**
     * Extracted for purpose of clear method name, for logback %M parameter
     * @param httpRequest http request
     */
    protected abstract void inHttpRequest(HttpServletRequest httpRequest) ;


    /**
     * Extracted for purpose of clear method name, for logback %M parameter
     * @param response http response
     */
    protected abstract void outHttpResponse(Response response);
}