summaryrefslogtreecommitdiffstats
path: root/openstack-client-connectors/jersey-connector/src/main/java/com/woorea/openstack/connector/JerseyLoggingFilter.java
blob: 6d98005db765e6b2352947918df1286fd7f0bd55 (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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
/*-
 * ============LICENSE_START=======================================================
 * ONAP - SO
 * ================================================================================
 * Copyright (C) 2017 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 com.woorea.openstack.connector;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicLong;
import java.util.logging.Logger;

import com.sun.jersey.api.client.AbstractClientRequestAdapter;
import com.sun.jersey.api.client.ClientHandlerException;
import com.sun.jersey.api.client.ClientRequest;
import com.sun.jersey.api.client.ClientRequestAdapter;
import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.filter.ClientFilter;
import com.sun.jersey.core.util.ReaderWriter;

/**
 * A Jersey client filter that writes the request and response to a specified logger.
 */
public class JerseyLoggingFilter extends ClientFilter {

	private final AtomicLong counter = new AtomicLong(0);
	private final Logger logger;

	/**
	 * Constructor
	 * @param logger the logger to which the request and response are written.
	 */
	public JerseyLoggingFilter(Logger logger) {
		this.logger = logger;
	}

	@Override
	public ClientResponse handle(ClientRequest request) throws ClientHandlerException {
		long id = counter.incrementAndGet();
		logRequest(id, request);
		ClientResponse response = getNext().handle(request);
		logResponse(id, response);
		return response;
	}

	/**
	 * Logs a request.
	 * @param id the request id (counter)
	 * @param request the request
	 */
	private void logRequest(long id, ClientRequest request) {
		StringBuilder builder = new StringBuilder();

		builder.append(String.valueOf(id));
		builder.append(" * Client out-bound request\n");

		builder.append(String.valueOf(id));
		builder.append(" > ");
		builder.append(request.getMethod());
		builder.append(" ");
		builder.append(request.getURI().toASCIIString());
		builder.append("\n");

		// Request headers

		for (Map.Entry<String, List<Object>> entry : request.getHeaders().entrySet()) {
			String header = entry.getKey();
			List<Object> values = entry.getValue();

			if (values.size() == 1) {
				builder.append(String.valueOf(id));
				builder.append(" > ");
				builder.append(header);
				builder.append(": ");
				builder.append(ClientRequest.getHeaderValue(values.get(0)));
				builder.append("\n");
			} else {
				StringBuilder buf = new StringBuilder();
				boolean first = true;

				for(Object value : values) {
					if (first) {
						first = false;
					} else {
						buf.append(",");
					}

					buf.append(ClientRequest.getHeaderValue(value));
				}

				builder.append(String.valueOf(id));
				builder.append(" > ");
				builder.append(header);
				builder.append(": ");
				builder.append(buf.toString());
				builder.append("\n");
			}
		}

		// Request body

		if (request.getEntity() != null) {
			request.setAdapter(new JerseyLoggingAdapter(request.getAdapter(), builder));
		} else {
			logger.info(builder.toString());
		}
	}

	/**
	 * Logs a response.
	 * @param id the request id (counter)
	 * @param response the response
	 */
	private void logResponse(long id, ClientResponse response) {
		StringBuilder builder = new StringBuilder();

		builder.append(String.valueOf(id));
		builder.append(" * Client in-bound response\n");

		builder.append(String.valueOf(id));
		builder.append(" < ");
		builder.append(String.valueOf(response.getStatus()));
		builder.append("\n");

		// Response headers

		for (Map.Entry<String, List<String>> entry : response.getHeaders().entrySet()) {
			String header = entry.getKey();
			for (String value : entry.getValue()) {
				builder.append(String.valueOf(id));
				builder.append(" < ");
				builder.append(header);
				builder.append(": ");
				builder.append(value).append("\n");
			}
		}

		// Response body

		ByteArrayOutputStream out = new ByteArrayOutputStream();
		InputStream in = response.getEntityInputStream();
		try {
			ReaderWriter.writeTo(in, out);

			byte[] requestEntity = out.toByteArray();
			appendToBuffer(builder, requestEntity);
			response.setEntityInputStream(new ByteArrayInputStream(requestEntity));
		} catch (IOException ex) {
			throw new ClientHandlerException(ex);
		}

		logger.info(builder.toString());
	}

	/**
	 * Appends bytes to the builder. If the bytes contain the password pattern,
	 * the password is obliterated.
	 * @param builder the builder
	 * @param bytes the bytes to append
	 */
	private void appendToBuffer(StringBuilder builder, byte[] bytes) {
		if (bytes.length != 0) {
			String s = new String(bytes);
			builder.append(s.replaceAll("\"password\".*:.*\"(.*)\"", "\"password\" : \"******\""));
			builder.append("\n");
		}
	}

	private class JerseyLoggingAdapter extends AbstractClientRequestAdapter {
		private final StringBuilder builder;

		JerseyLoggingAdapter(ClientRequestAdapter adapter, StringBuilder builder) {
			super(adapter);
			this.builder = builder;
		}

		@Override
		public OutputStream adapt(ClientRequest request, OutputStream out) throws IOException {
			return new JerseyLoggingOutputStream(getAdapter().adapt(request, out), builder);
		}
	}

	private class JerseyLoggingOutputStream extends OutputStream {
		private final OutputStream stream;
		private final StringBuilder builder;
		private final ByteArrayOutputStream logStream = new ByteArrayOutputStream();

		JerseyLoggingOutputStream(OutputStream stream, StringBuilder builder) {
			this.stream = stream;
			this.builder = builder;
		}

		@Override
		public void write(int value) throws IOException {
			logStream.write(value);
			stream.write(value);
		}

		@Override
		public void close() throws IOException {
			appendToBuffer(builder, logStream.toByteArray());
			logger.info(builder.toString());
			stream.close();
		}
	}
}